Set-VBRAzureBlobRepository

Short Description

Modifies Azure Blob storage added as a backup repository to the backup infrastructure.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRAzureBlobRepository [-AzureProxySpec <VBRAzureComputeProxyAppliance>] [-ConnectionType {Direct | Gateway}] [-Description <String>] [-EnableConcurrentTasksLimit] [-EnableCoolAccessTier] [-EnableSizeLimit] [-Force] [-GatewayServer <CHost[]>] [-ImmutabilityPeriod <Int32>] [-MaxConcurrentTasks <Int32>] [-MountServerOptions <VBRRepositoryMountServerOptions>] [-Name <String>] -Repository <VBRAzureBlobRepository> [-SizeLimit <Int32>] [-UseGatewayServer] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings for an Azure Blob storage added as a backup repository 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 Blob storage that you want to modify.	Accepts the VBRAzureBlobRepository object. To create this object, run the Get-VBRObjectStorageRepository cmdlet.	True	Named	True (ByValue)
Name	Specifies a name of object storage. The cmdlet will add Azure Blob storage to the backup infrastructure with this name.	String	False	Named	False
Description	Specifies a description of Azure Blob storage. The cmdlet will add Azure Blob storage to the backup infrastructure with this description.	String	False	Named	False
UseGatewayServer	Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories Default: True. Note: If you do not specify the UseGatewayServer parameter, the cmdlet will use a proxy server to transfer data.	SwitchParameter	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
GatewayServer	Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.	Accepts the CHost[] object. To get this object, run the Get-VBRServer cmdlet.	False	Named	False
EnableSizeLimit	Defines that the cmdlet will enable size limits for an Azure Blob storage that you want to add as a backup repository. Use the SizeLimit parameter to specify the size limits.	SwitchParameter	False	Named	False
SizeLimit	For the EnableSizeLimit parameter. Specifies size limits in GB for data blocks that you want to store in Azure Blob storage added as an object storage repository. Permitted value: 1024 - 1073741824. Default: 10240.	Int32	False	Named	False
EnableConcurrentTasksLimit	Enables limits for concurrent tasks that can be processed by the object storage repository. Use the MaxConcurrentTasks paramter to specify the number of tasks.	SwitchParameter	False	Named	False
MaxConcurrentTasks	Specifies a maximum number of concurrent tasks that can be processed at once by the object storage repository.	Int	False	Named	False
EnableCoolAccessTier	Defines that Veeam Backup & Replication will keep blocks of data in the Cool access tier. Default: False.	SwitchParameter	False	Named	False
ImmutabilityPeriod	Defines the immutability period in days. Default: 30 days. Maximum: 999 days.	Int32	False	Named	False
MountServerOptions	Specifies settings of a mount server for object storage repositories. Note: This parameter is required for object storage repositories that you want to add as performance extents to a scale-out backup repository.	Accepts the VBRRepositoryMountServerOptions object. To create this object, run the New-VBRRepositoryMountServerOptions cmdlet.	False	Named	False

AzureProxySpec	Specifies proxy appliance settings for adding Azure Archive repository.	Accepts the VBRAzureComputeProxyAppliance object. To create this object, run the New-VBRAzureComputeProxyAppliance cmdlet.	False	Named	False
LimitConcurrentJobs	Defines that the number of concurrent jobs using this repository must be limited. Use the MaxConcurrentJobs parameter to set the maximum value.	SwitchParameter	False	Named	False
MaxConcurrentJobs	To set maximum value for the LimitConcurrentJobs parameter. Specifies the maximum allowed number of concurrent tasks for a repository. Permitted values: 1 to 99.	Int32	False	Named	False
ForceOwnershipChange	Defines that the cmdlet will force ownership change of the object storage folder. If you do not provide this parameter and the object storage folder is owned by another host, you will not be able to add object storage to the backup infrastructure.	SwitchParameter	False	Named	False
Force	Defines that the cmdlet will modify an storage repository without showing warnings in the PowerShell console.	SwitchParameter	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Return Type

VBRAzureBlobRepository

Examples

Modifying Gateway Server Settings for Azure Blob Storage

This example shows how to modify settings for a existing Azure Blob storage added as a backup repository. The cmdlet will use custom gateway servers to transfer data to Azure Blob storage.

$azure = Get-VBRObjectStorageRepository -Name "Azure Blob"

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

Set-VBRAzureBlobRepository -Repository $azure -UseGatewayServer -GatewayServer $gateserv

Perform the following steps:

Run the Get-VBRObjectStorageRepository 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-VBRAzureBlobRepository 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