Skip to content

Latest commit

 

History

History
158 lines (118 loc) · 4.18 KB

Set-AzRecoveryServicesBackupProperty.md

File metadata and controls

158 lines (118 loc) · 4.18 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml
Az.RecoveryServices
C635D723-0F03-4EF8-9435-24DBE0859899
2.0.0

Set-AzRecoveryServicesBackupProperty

SYNOPSIS

Sets the properties for backup management.

SYNTAX

Set-AzRecoveryServicesBackupProperty -Vault <ARSVault>
 [-BackupStorageRedundancy <AzureRmRecoveryServicesBackupStorageRedundancyType>] [-EnableCrossRegionRestore]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Set-AzRecoveryServicesBackupProperty cmdlet sets backup storage properties for a Recovery Services vault.

EXAMPLES

Example 1: Set GeoRedundant storage for a vault

$Vault = Get-AzRecoveryServicesVault -Name "TestVault"
Set-AzRecoveryServicesBackupProperty -Vault $Vault01 -BackupStorageRedundancy GeoRedundant

The first command gets the vault named TestVault, and then stores it in the $Vault variable. The second command sets the backup storage redundancy for $Vault to GeoRedundant.

Example 2: Enable cross region restore for a vault

$Vault = Get-AzRecoveryServicesVault -Name "TestVault"
Set-AzRecoveryServicesBackupProperty -Vault $Vault01 -EnableCrossRegionRestore

The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. The second command enables cross region restore for recovery services vault $Vault

PARAMETERS

-BackupStorageRedundancy

Specifies the backup storage redundancy type.

Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.AzureRmRecoveryServicesBackupStorageRedundancyType]
Parameter Sets: (All)
Aliases:
Accepted values: GeoRedundant, ZoneRedundant, LocallyRedundant

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableCrossRegionRestore

Enable CRR on a vault. Please make sure to set BackupStorageRedundancy to GeoRedundant before enabling CRR.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vault

Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object.

Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.RecoveryServices.ARSVault

OUTPUTS

System.Void

NOTES

RELATED LINKS

Get-AzRecoveryServicesBackupProperty

Get-AzRecoveryServicesVault