Set-VBRAzureExternalRepository

In this article

    Short Description

    Modifies settings of Microsoft Azure Blob storage added as an external repository.

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRAzureExternalRepository -ExternalRepository <VBRAzureExternalRepository> [-Name <string>] [-Description <string>] [-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-GatewayServer <CHost>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of Microsoft Azure Blob storage added as an external repository. This cmdlet modifies an existing VMware replication job. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    ExternalRepository

    Specifies Microsoft Azure Blob storage added as an external repository. The cmdlet will modify this repository.

    Accepts the VBRAzureExternalRepository object. To get this object, run the Get-VBRExternalRepository cmdlet.

    True

    Named

    True (ByValue)

    Name

    Specifies a name of Microsoft Azure Blob storage that you want to add as an external repository.

    String

    False

    Named

    False

    Description

    Specifies the description of Microsoft Azure Blob storage that you want to add as an external repository.

    String

    False

    Named

    False

    DecryptBackups

    Indicates that Veeam Backup & Replication will decrypt encrypted backup files created by Cloud Protection Manager.

    SwitchParameter

    False

    Named

    False

    DecryptionKey

    Specifies the password that Veeam Backup & Replication will use to decrypt the backup files.

    Accepts the VBREncryptionKey object. To get this object, run the Add-VBREncryptionKey cmdlet.

    False

    Named

    False

    GatewayServer

    Specifies the gateway server. Veeam Backup & Replication will use this server to access Microsoft Azure Blob storage that is added as an external repository.

    Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    This cmdlet returns the VBRAzureExternalRepository object that contains settings on Microsoft Azure Blob storage added as an external repository.

    Examples

    Modifying Decryption Password

    This example shows how to modify the decryption password of Microsoft Azure Blob storage that is added as an external repository.

    $repository = Get-VBRExternalRepository -Name "Microsoft Azure Repository"

    $securepassword = Read-Host -Prompt "Enter password" -AsSecureString

    $key = Add-VBREncryptionKey -Password $securepassword

    Set-VBRAzureExternalRepository -ExternalRepository $repository -DecryptBackups -DecryptionKey $key

    Perform the following steps:

    1. Run the Get-VBRExternalRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
    2. Specify the password to decrypt backup files:
    1. Run the Read-Host cmdlet. Specify the Prompt and the AsSecureString parameters value. Save the result to the $securepassword variable.
    2. Run the Add-VBREncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value. Save the result to the $key variable.
    1. Run the Set-VBRAzureExternalRepository cmdlet. Specify the following settings:
    • Set the $repository variable as the ExternalRepository parameter value.
    • Provide the DecryptBackups parameter.
    • Set the $key variable as the DecryptionKey parameter value.

    Related Commands