Set-AzureRmRecoveryServicesBackupProperties
Sets the properties for backup management.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmRecoveryServicesBackupProperties
-Vault <ARSVault>
[-BackupStorageRedundancy <AzureRmRecoveryServicesBackupStorageRedundancyType>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzureRmRecoveryServicesBackupProperties cmdlet sets backup storage properties for a Recovery Services vault.
Examples
Example 1: Set GeoRedundant storage for a vault
PS C:\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault"
PS C:\> Set-AzureRmRecoveryServicesBackupProperties -Vault $Vault01 -BackupStorageRedundancy GeoRedundantThe first command gets the vault named TestVault, and then stores it in the $Vault01 variable. The second command sets the backup storage redundancy for $Vault01 to GeoRedundant.
Parameters
-BackupStorageRedundancy
Specifies the backup storage redundancy type.
| Type: | AzureRmRecoveryServicesBackupStorageRedundancyType |
| Accepted values: | GeoRedundant, LocallyRedundant |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Vault
Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object.
| Type: | ARSVault |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Parameters: Vault (ByValue)