Set-VBRAzureArchiveRepository

Short Description

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

Applies to

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[]>] [-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 parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Repository

Specifies an Azure Archive repository that you want to modify.

Accepts the VBRAzureArchiveRepository object. To get this object, run the Get-VBRArchiveObjectStorageRepository 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.

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

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

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

Force

Defines that the cmdlet will modify an object storage repository without showing warnings in the PowerShell console.

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 -GatewayServer $gateserv -UseGatewayServer

Perform the following steps:

  1. Run the Get-VBRArchiveObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $azure variable.
  2. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gateserv variable.
  3. Run the Set-VBRAzureArchiveRepository cmdlet. Set the $azure variable as the Repository parameter value. Provide the UseGatewayServer parameter. Set the $gateserv variable as the GatewayServer parameter value.

Related Commands