az backup vault

Online storage entity in Azure used to hold data such as backup copies, recovery points and backup policies.

Commands

Name	Description	Type	Status
az backup vault backup-properties	Properties of the Recovery Services vault.	Core	GA
az backup vault backup-properties set	Sets backup related properties of the Recovery Services vault.	Core	GA
az backup vault backup-properties show	Gets backup related properties of the Recovery Services vault.	Core	GA
az backup vault create	Create a new Recovery Services vault or update an existing one.	Core	GA
az backup vault delete	Delete an existing Recovery services vault.	Core	GA
az backup vault encryption	Encryption details of a Recovery Services Vault.	Core	GA
az backup vault encryption show	Show details of encryption properties of a Recovery Services Vault.	Core	GA
az backup vault encryption update	Update encryption properties of a Recovery Services Vault.	Core	GA
az backup vault identity	Identity details of a Recovery Services Vault.	Core	GA
az backup vault identity assign	Assign Identities to Recovery Services vault.	Core	GA
az backup vault identity remove	Remove Identities of Recovery Services vault.	Core	GA
az backup vault identity show	Show Identities of Recovery Services vault.	Core	GA
az backup vault list	List Recovery service vaults within a subscription.	Core	GA
az backup vault list-soft-deleted-containers	List soft-deleted containers within a particular Recovery Services vault.	Core	GA
az backup vault resource-guard-mapping	Resource Guard Mapping details of the Recovery Services vault.	Core	GA
az backup vault resource-guard-mapping delete	Delete resource guard mapping of the Recovery Services vault.	Core	GA
az backup vault resource-guard-mapping show	Get resource guard mapping of the Recovery Services vault.	Core	GA
az backup vault resource-guard-mapping update	Create/Update resource guard mapping of the Recovery Services vault.	Core	GA
az backup vault show	Show details of a particular Recovery service vault.	Core	GA
az backup vault update	Update an existing Recovery Services vault.	Core	GA

az backup vault create

Create a new Recovery Services vault or update an existing one.

az backup vault create --location
                       --name
                       --resource-group
                       [--classic-alerts {Disable, Enable}]
                       [--cross-subscription-restore-state {Disable, Enable, PermanentlyDisable}]
                       [--immutability-state {Disabled, Locked, Unlocked}]
                       [--job-failure-alerts {Disable, Enable}]
                       [--public-network-access {Disable, Enable}]
                       [--tags]

Examples

Create a new Recovery Services vault or update an existing one. (autogenerated)

az backup vault create --location westus2 --name MyRecoveryServicesVault --resource-group MyResourceGroup

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the Recovery services vault.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--classic-alerts

Use this property to specify whether backup alerts from the classic solution should be received.

Property	Value
Accepted values:	Disable, Enable

--cross-subscription-restore-state

Use this parameter to configure cross subscription restore settings for the vault. By default, the property is "Enabled" for the vault.

Property	Value
Accepted values:	Disable, Enable, PermanentlyDisable

--immutability-state

Use this parameter to configure immutability settings for the vault. By default, immutability is "Disabled" for the vault. "Unlocked" means that immutability is enabled for the vault and can be reversed. "Locked" means that immutability is enabled for the vault and cannot be reversed.

Property	Value
Accepted values:	Disabled, Locked, Unlocked

--job-failure-alerts

Use this property to specify whether built-in Azure Monitor alerts should be received for every job failure.

Property	Value
Accepted values:	Disable, Enable

--public-network-access

Use this property to specify whether public network access for the vault should be enabled or disabled. It is enabled by default. For setting up private endpoints, it has to be disabled.

Property	Value
Accepted values:	Disable, Enable

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az backup vault delete

Delete an existing Recovery services vault.

az backup vault delete [--force]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--yes]

Examples

Delete an existing Recovery services vault. (autogenerated)

az backup vault delete --name MyRecoveryServicesVault --resource-group MyResourceGroup --yes

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--force

Force completion of the requested action.

Property	Value
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az backup vault list

List Recovery service vaults within a subscription.

az backup vault list [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az backup vault list-soft-deleted-containers

List soft-deleted containers within a particular Recovery Services vault.

az backup vault list-soft-deleted-containers --backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}
                                             [--ids]
                                             [--name]
                                             [--resource-group]
                                             [--subscription]

Examples

List soft deleted containers

az backup vault list-soft-deleted-containers --name MyRecoveryServicesVault --resource-group MyResourceGroup --backup-management-type AzureIaasVM

Required Parameters

--backup-management-type

Specify the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.

Property	Value
Accepted values:	AzureIaasVM, AzureStorage, AzureWorkload

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az backup vault show

Show details of a particular Recovery service vault.

az backup vault show [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Examples

Show details of a particular Recovery service vault. (autogenerated)

az backup vault show --name MyRecoveryServicesVault --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az backup vault update

Update an existing Recovery Services vault.

az backup vault update [--backup-storage-redundancy {GeoRedundant, LocallyRedundant, ZoneRedundant}]
                       [--classic-alerts {Disable, Enable}]
                       [--cross-region-restore-flag {Disabled, Enabled}]
                       [--cross-subscription-restore-state {Disable, Enable, PermanentlyDisable}]
                       [--ids]
                       [--immutability-state {Disabled, Locked, Unlocked}]
                       [--job-failure-alerts {Disable, Enable}]
                       [--name]
                       [--public-network-access {Disable, Enable}]
                       [--resource-group]
                       [--subscription]
                       [--tags]
                       [--tenant-id]

Examples

Update immutability settings of a Recovery Services vault.

az backup vault update --name MyRecoveryServicesVault --resource-group MyResourceGroup --immutability-state Unlocked

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--backup-storage-redundancy

Set backup storage properties for a Recovery Services vault.

Property	Value
Accepted values:	GeoRedundant, LocallyRedundant, ZoneRedundant

--classic-alerts

Use this property to specify whether backup alerts from the classic solution should be received.

Property	Value
Accepted values:	Disable, Enable

--cross-region-restore-flag

Set cross-region-restore feature state for a Recovery Services Vault. Default: False.

Property	Value
Accepted values:	Disabled, Enabled

--cross-subscription-restore-state

Use this parameter to configure cross subscription restore settings for the vault. By default, the property is "Enabled" for the vault.

Property	Value
Accepted values:	Disable, Enable, PermanentlyDisable

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--immutability-state

Use this parameter to configure immutability settings for the vault. By default, immutability is "Disabled" for the vault. "Unlocked" means that immutability is enabled for the vault and can be reversed. "Locked" means that immutability is enabled for the vault and cannot be reversed.

Property	Value
Accepted values:	Disabled, Locked, Unlocked

--job-failure-alerts

Use this property to specify whether built-in Azure Monitor alerts should be received for every job failure.

Property	Value
Accepted values:	Disable, Enable

--name -n

Name of the Recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--public-network-access

Use this property to specify whether public network access for the vault should be enabled or disabled. It is enabled by default. For setting up private endpoints, it has to be disabled.

Property	Value
Accepted values:	Disable, Enable

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--tenant-id

ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False