az backup vault

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

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

Commands

az backup vault backup-properties	Properties of the Recovery Services vault.
az backup vault backup-properties set	Sets backup related properties of the Recovery Services vault.
az backup vault backup-properties show	Gets backup related properties of the Recovery Services vault.
az backup vault create	Create a new Recovery Services vault.
az backup vault delete	Delete an existing Recovery services vault.
az backup vault encryption	Encryption details of a Recovery Services Vault.
az backup vault encryption show	Show details of encryption properties of a Recovery Services Vault.
az backup vault encryption update	Update encryption properties of a Recovery Services Vault.
az backup vault identity	Identity details of a Recovery Services Vault.
az backup vault identity assign	Assign Identities to Recovery Services vault.
az backup vault identity remove	Remove Identities of Recovery Services vault.
az backup vault identity show	Show Identities of Recovery Services vault.
az backup vault list	List Recovery service vaults within a subscription.
az backup vault show	Show details of a particular Recovery service vault.

az backup vault create

Create a new Recovery Services vault.

az backup vault create --location
                       --name
                       --resource-group
                       [--tags]

Examples

Create a new Recovery Services vault. (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

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az backup vault delete

Delete an existing Recovery services vault.

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

Examples

Delete an existing Recovery services vault. (autogenerated)

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

Optional Parameters

--force

Force completion of the requested action.

--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.

--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>.

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az backup vault list

List Recovery service vaults within a subscription.

az backup vault list [--resource-group]

Optional Parameters

--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az backup vault show

Show details of a particular Recovery service vault.

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

Examples

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

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

Optional Parameters

--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.

--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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.