Set-AzRecoveryServicesBackupProperty
Sets the properties for backup management.
Syntax
Default (Default)
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.
Parameter properties
| Type: | Nullable<T>[AzureRmRecoveryServicesBackupStorageRedundancyType] |
| Default value: | None |
| Accepted values: | GeoRedundant, ZoneRedundant, LocallyRedundant |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableCrossRegionRestore
Enable CRR on a vault. Please make sure to set BackupStorageRedundancy to GeoRedundant before enabling CRR.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Vault
Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object.
Parameter properties
| Type: | ARSVault |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
