This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRAzureArchiveRepository
Short Description
Modifies settings for Azure archive repository added to the backup infrastructure.
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRAzureArchiveRepository -Repository <VBRAzureArchiveRepository> [-Name <string>] [-Description <string>] [-AzureProxySpec <VBRAzureComputeProxyAppliance>] [-UseGatewayServer] [-GatewayServer <CHost>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies the settings for an Azure archive repository added to the backup infrastructure.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Repository | Specifies an Azure archive repository that you want to modify. | Accepts the VBRAzureArchiveRepository object. To create this object, run the Add-VBRAzureArchiveRepository cmdlet. | True | Named | True (ByValue, ByPropertyName) |
Name | Specifies a new name for the Azure archive repository. | String | False | Named | False |
Description | Specifies a new description of the Azure archive repository. | String | False | Named | False |
AzureProxySpec | Specifies a proxy appliance for transferring the data. | Accepts the VBRAzureComputeProxyAppliance object. To create this object, run the New-VBRAzureComputeProxyAppliance cmdlet. | False | Named | False |
UseGatewayServer | Defines that the cmdlet will use a gateway server to access Azure archive repository added as a backup repository. Default: True | SwitchParameter | False | Named | False |
GatewayServer | Specifies a gateway server that you want to use to access Azure archive repository. | CHost | 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 VBRAzureArchiveRepository object that defines the Azure archive repository settings.
Examples
Modifying Gateway Server of Azure Archive Repository
This example shows how to modify Azure archive repository added to the backup infrastructure. The cmdlet will use a custom gateway server to connect to Azure archive repository.
$azure = Get-VBRArchiveObjectStorageRepository -Name "Azure" $gateserv = Get-VBRServer -Name "Server01" Set-VBRAmazonS3GlacierRepository -Repository $azure -GatewayServer $gateserv -UseGatewayServer |
Perform the following steps:
- Run the Get-VBRArchiveObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $azure variable.
- Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gateserv variable.
- Run the Set-VBRAmazonS3GlacierRepository cmdlet. Specify the following settings:
- Set the $azure variable as the Repository parameter value.
- Set the $gateserv variable as the GatewayServer parameter value.
- Provide the UseGatewayServer parameter.
Related Commands
