Set-VBRAzureExternalRepository
Short Description
Modifies external Microsoft Azure Blob storage repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRAzureExternalRepository -ExternalRepository <VBRAzureExternalRepository> [-Name <string>] [-Description <string>] [-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-GatewayServer <CHost>] [-AzureSubscription <VBRAzureSubscription>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies external Microsoft Azure Blob storage repository added to the backup infrastructure.
Note |
To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
ExternalRepository | Specifies Microsoft Azure Blob storage repository 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 repository that you want to add as an external repository. | String | False | Named | False |
Description | Specifies the description of Microsoft Azure Blob storage repository that you want to add as an external repository. | String | False | Named | False |
DecryptBackups | Defines that Veeam Backup & Replication will decrypt encrypted backups. Default: False. | SwitchParameter | False | Named | False |
DecryptionKey | Specifies the password that Veeam Backup & Replication will use to decrypt the backup files. | Accepts the VBREncryptionKey object. To create this object, run the Add-VBREncryptionKey cmdlet. | False | Named | False |
GatewayServer | Specifies a gateway server. Veeam Backup & Replication will use this server to access Microsoft Azure Blob storage repository. | Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet. | False | Named | False |
AzureSubscription | Specifies subscriptions associated with a Microsoft Azure account. | Accepts the VBRAzureSubscription object. To get this object, run the Get- VBRAzureSubscription cmdlet. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
This cmdlet returns the VBRAzureExternalRepository object that contains settings of Microsoft Azure Blob storage repository added as an external repository.
Examples
Modifying Decryption Password of External Azure Blob Storage Repository
This example shows how to modify the decryption password of Microsoft Azure Blob storage repository named Microsoft Azure 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:
- Run the Get-VBRExternalRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
- Specify the password to decrypt backup files:
- Run the Read-Host cmdlet. Specify the Prompt parameter value. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
- Run the Add-VBREncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value. Save the result to the $key variable.
- 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