Set-VBRAzureArchiveRepository

Short Description

Modifies settings for Azure Archive repository added to the backup infrastructure.

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRAzureArchiveRepository -Repository <VBRAzureArchiveRepository> [-Name <String>] [-Description <String>]

[-AzureProxySpec <VBRAzureComputeProxyAppliance>] [-UseInstantRetrieval] [-UseGatewayServer]

[-GatewayServer <CHost[]>] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]

[-ConnectionType <VBRRepositoryConnectionType>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet modifies the settings for an Azure Archive 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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AzureProxySpec	Specifies a proxy appliance for transferring the data. Accepts the `VBRAzureComputeProxyAppliance` object. To create this object, run the `New-VBRAzureComputeProxyAppliance` cmdlet.	`VBRAzureComputeProxyAppliance`	False	Named	False
ConnectionType	Specifies how Veeam Backup & Replication will access the object storage repository: `Direct`: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories. `Gateway`: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories. Note: Provide the `GatewayServer` parameter to specify the server. Default: `Direct`.	`VBRRepositoryConnectionType`	False	Named	False
Description	Specifies a new description of the Azure Archive repository.	`String`	False	Named	False
Force	Defines that the cmdlet will modify an object storage repository without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
GatewayServer	Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.	`CHost[]`	False	Named	False
ImmutabilityMode	Specifies the immutability retention period: `BackupRetention`: Use this option if you want the immutability period to depend on the backup job retention. `RepositoryRetention`: Use this option if you want to ignore the job retention and specify the immutability period explicitly.	`VBRRepositoryImmutabilityMode`	False	Named	False
ImmutabilityPeriod	Defines the immutability period in days. Default: `30` days. Maximum: `999` days.	`Int32`	False	Named	False
Name	Specifies a new name for the Azure Archive repository.	`String`	False	Named	False
Repository	Specifies an Azure Archive repository that you want to modify. Accepts the `VBRAzureArchiveRepository` object. To get this object, run the `Get-VBRArchiveObjectStorageRepository` cmdlet.	`VBRAzureArchiveRepository`	True	Named	True (ByPropertyName, ByValue)
UseGatewayServer	Note: This parameter is deprecated and will be ignored. Use the `GatewayServer` parameter instead. Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories. Default: `False`.	`SwitchParameter`	False	Named	False
UseInstantRetrieval	Defines that the cmdlet will create a repository where data blocks are marked with the cool access tier. Note: If you do not provide the `UseInstantRetrieval` parameter, the cmdlet will create a repository where blocks are marked as the archive access tier. Default: `False.`	`SwitchParameter`	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 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 custom gateway servers server to connect to Azure Archive repository.

$azure = Get-VBRArchiveObjectStorageRepository -Name "Azure"

$gateserv = Get-VBRServer -Name "north.tech.local", "north2.tech.local"

Set-VBRAzureArchiveRepository -Repository $azure -ConnectionType Gateway -GatewayServer $gateserv

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-VBRAzureArchiveRepository cmdlet. Set the $azure variable as the Repository parameter value. Set the Gateway value for the ConnectionType parameter. Set the $gateserv variable as the GatewayServer parameter value.