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

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-vault command. Learn more about extensions.

Manage backup vault with dataprotection.

Commands

az dataprotection backup-vault create	Create a BackupVault resource belonging to a resource group.
az dataprotection backup-vault delete	Deletes a BackupVault resource from the resource group.
az dataprotection backup-vault list	Gets list of backup vault in a subscription or in a resource group.
az dataprotection backup-vault show	Returns a resource belonging to a resource group.
az dataprotection backup-vault update	Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
az dataprotection backup-vault wait	Place the CLI in a waiting state until a condition of the dataprotection backup-vault is met.

az dataprotection backup-vault create

Create a BackupVault resource belonging to a resource group.

az dataprotection backup-vault create --resource-group
                                      --storage-settings
                                      --vault-name
                                      [--e-tag]
                                      [--location]
                                      [--no-wait]
                                      [--tags]
                                      [--type]

Examples

Create BackupVault

az dataprotection backup-vault create --type "None" --location "WestUS" --storage-settings type="LocallyRedundant" datastore-type="VaultStore" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Create BackupVault With MSI

az dataprotection backup-vault create --type "systemAssigned" --location "WestUS" --storage-settings type="LocallyRedundant" datastore-type="VaultStore" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Required Parameters

--resource-group -g

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

--storage-settings

Storage Settings.

--vault-name

The name of the backup vault.

Optional Parameters

--e-tag

Optional ETag.

--location -l

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

--no-wait

Do not wait for the long-running operation to finish.

--tags

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

--type

The identityType which can be either SystemAssigned or None.

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 dataprotection backup-vault delete

Deletes a BackupVault resource from the resource group.

az dataprotection backup-vault delete --resource-group
                                      --vault-name
                                      [--yes]

Examples

Delete BackupVault

az dataprotection backup-vault delete --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Required Parameters

--resource-group -g

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

--vault-name

The name of the backup vault.

Optional Parameters

--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 dataprotection backup-vault list

Gets list of backup vault in a subscription or in a resource group.

az dataprotection backup-vault list [--resource-group]

Examples

List backup vault in a subscription

az dataprotection backup-vault list

List backup vault in a resource group

az dataprotection backup-vault list -g sarath-rg

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 dataprotection backup-vault show

Returns a resource belonging to a resource group.

az dataprotection backup-vault show --resource-group
                                    --vault-name

Examples

Get BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Get BackupVault With MSI

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Required Parameters

--resource-group -g

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

--vault-name

The name of the backup vault.

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 dataprotection backup-vault update

Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.

az dataprotection backup-vault update --resource-group
                                      --vault-name
                                      [--no-wait]
                                      [--tags]
                                      [--type]

Examples

Patch BackupVault

az dataprotection backup-vault update --tags newKey="newVal" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Required Parameters

--resource-group -g

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

--vault-name

The name of the backup vault.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--tags

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

--type

The identityType which can be either SystemAssigned or None.

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 dataprotection backup-vault wait

Place the CLI in a waiting state until a condition of the dataprotection backup-vault is met.

az dataprotection backup-vault wait --resource-group
                                    --vault-name
                                    [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--interval]
                                    [--timeout]
                                    [--updated]

Examples

Pause executing next line of CLI script until the dataprotection backup-vault is successfully created.

az dataprotection backup-vault wait --resource-group "SampleResourceGroup" --vault-name "swaggerExample" --created

Pause executing next line of CLI script until the dataprotection backup-vault is successfully updated.

az dataprotection backup-vault wait --resource-group "SampleResourceGroup" --vault-name "swaggerExample" --updated

Required Parameters

--resource-group -g

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

--vault-name

The name of the backup vault.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.