az dataprotection backup-instance

Commands

Name	Description	Type	Status
az dataprotection backup-instance adhoc-backup	Trigger adhoc backup.	Extension	GA
az dataprotection backup-instance create	Configure backup for a resource in a backup vault.	Extension	GA
az dataprotection backup-instance delete	Delete a backup instance in a backup vault.	Extension	GA
az dataprotection backup-instance deleted-backup-instance	Perform operations on soft-deleted backup instances.	Extension	GA
az dataprotection backup-instance deleted-backup-instance list	List deleted backup instances belonging to a backup vault.	Extension	GA
az dataprotection backup-instance deleted-backup-instance show	Get a deleted backup instance with name in a backup vault.	Extension	GA
az dataprotection backup-instance deleted-backup-instance undelete	Undelete soft-deleted backup instances.	Extension	GA
az dataprotection backup-instance initialize	Initialize JSON request body for configuring backup of a resource.	Extension	GA
az dataprotection backup-instance initialize-backupconfig	Initialize JSON request body for initializing and configuring backup for AzureKubernetesService or AzureBlobs (for vaulted backups) resources.	Extension	GA
az dataprotection backup-instance initialize-restoreconfig	Initialize JSON request body for initializing and configuring restore of an AzureKubernetesService resource.	Extension	GA
az dataprotection backup-instance list	Gets backup instances belonging to a backup vault.	Extension	GA
az dataprotection backup-instance list-from-resourcegraph	List backup instances across subscriptions, resource groups and vaults.	Extension	GA
az dataprotection backup-instance restore	Restore backed up instances from recovery points in a backup vault.	Extension	GA
az dataprotection backup-instance restore initialize-for-data-recovery	Initialize restore request object to recover all backed up data in a backup vault.	Extension	GA
az dataprotection backup-instance restore initialize-for-data-recovery-as-files	Initialize restore request object to recover all backed up data as files in a backup vault.	Extension	GA
az dataprotection backup-instance restore initialize-for-item-recovery	Initialize restore request object to recover specified items of backed up data in a backup vault.	Extension	GA
az dataprotection backup-instance restore trigger	Triggers restore for a BackupInstance.	Extension	GA
az dataprotection backup-instance resume-protection	This operation will resume protection for a stopped backup instance.	Extension	GA
az dataprotection backup-instance show	Get a backup instance with name in a backup vault.	Extension	GA
az dataprotection backup-instance stop-protection	This operation will stop protection of a backup instance and data will be held forever.	Extension	GA
az dataprotection backup-instance suspend-backup	This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever).	Extension	GA
az dataprotection backup-instance update	Update properties associated with a backup instance.	Extension	GA
az dataprotection backup-instance update-msi-permissions	Assign the required permissions needed to successfully enable backup for the datasource.	Extension	GA
az dataprotection backup-instance update-policy	Update backup policy associated with backup instance.	Extension	GA
az dataprotection backup-instance validate-for-backup	Validate whether configure backup will be successful or not.	Extension	GA
az dataprotection backup-instance validate-for-restore	Validates if Restore can be triggered for a DataSource.	Extension	GA
az dataprotection backup-instance validate-for-update	Validate whether update for backup instance will be successful or not.	Extension	GA
az dataprotection backup-instance wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az dataprotection backup-instance adhoc-backup --rule-name
                                               [--backup-instance-name --name]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--retention-tag-override]
                                               [--subscription]
                                               [--vault-name]

Examples

Fetch Backup Policy details for rule name and Trigger Adhoc Backup

az dataprotection backup-policy show -g "000pikumar" --vault-name "PratikPrivatePreviewVault1" -n "backupPolicy"
az dataprotection backup-instance adhoc-backup --name "testInstance1" --rule-name "BackupWeekly" --retention-tag-override "yearly" --resource-group "000pikumar" --vault-name "PratikPrivatePreviewVault1"

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance create --backup-instance
                                         --resource-group
                                         --vault-name
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

create a backup instance in a backup vault

az dataprotection backup-instance create -g MyResourceGroup --vault-name MyVault --backup-instance backupinstance.json

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance delete [--backup-instance-name --name]
                                         [--ids]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--vault-name]
                                         [--yes]

Examples

Delete BackupInstance

az dataprotection backup-instance delete --name "testInstance1" --resource-group "000pikumar" --vault-name "PratikPrivatePreviewVault1"

Optional Parameters

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

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 dataprotection backup-instance initialize --datasource-id
                                             --datasource-location
                                             --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                             --policy-id
                                             [--backup-configuration]
                                             [--friendly-name]
                                             [--mi-system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
                                             [--mi-user-assigned --uami --user-assigned-identity-arm-url]
                                             [--secret-store-type {AzureKeyVault}]
                                             [--secret-store-uri]
                                             [--snapshot-resource-group-name --snapshot-rg]
                                             [--tags]

Examples

Initialize backup instance request for Azure Disk

az dataprotection backup-instance initialize --datasource-type AzureDisk -l southeastasia --policy-id {disk_policy_id} --datasource-id {disk_id}

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance initialize-backupconfig --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                          [--backup-hook-references --backup-hook-refs]
                                                          [--container-list --vaulted-backup-containers]
                                                          [--excluded-namespaces]
                                                          [--excluded-resource-type --excluded-resource-types]
                                                          [--include-all-containers {false, true}]
                                                          [--include-cluster-scope --include-cluster-scope-resources {false, true}]
                                                          [--included-namespaces]
                                                          [--included-resource-type --included-resource-types]
                                                          [--label-selectors]
                                                          [--snapshot-volumes {false, true}]
                                                          [--storage-account-name]
                                                          [--storage-account-resource-group --storage-account-rg]

Examples

Initialize backup configuration for AzureKubernetesService

az dataprotection backup-instance initialize-backupconfig --datasource-type AzureKubernetesService --label-selectors key=val foo=bar --excluded-namespaces excludeNS1 excludeNS2

Initialize backup configuration for AzureBlob

az dataprotection backup-instance initialize-backupconfig --datasource-type "AzureBlob" --include-all-containers --storage-account-rg "sampleRG" --storage-account-name "samplestorage"

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance initialize-restoreconfig --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                           [--conflict-policy {Patch, Skip}]
                                                           [--excluded-namespaces]
                                                           [--excluded-resource-type --excluded-resource-types]
                                                           [--include-cluster-scope --include-cluster-scope-resources {false, true}]
                                                           [--included-namespaces]
                                                           [--included-resource-type --included-resource-types]
                                                           [--label-selectors]
                                                           [--namespace-mappings]
                                                           [--persistent-restoremode --persistent-volume-restore-mode {RestoreWithVolumeData, RestoreWithoutVolumeData}]
                                                           [--resource-modifier --resource-modifier-reference]
                                                           [--restore-hook-references --restore-hook-refs]
                                                           [--staging-resource-group-id --staging-rg-id]
                                                           [--staging-storage-account-id --staging-storage-id]

Examples

Initialize restore configuration

az dataprotection backup-instance initialize-restoreconfig --datasource-type AzureKubernetesService

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance list --resource-group
                                       --vault-name
                                       [--max-items]
                                       [--next-token]

Examples

List backup instances in a vault

az dataprotection backup-instance list --resource-group "000pikumar" --vault-name "PratikPrivatePreviewVault1"

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance list-from-resourcegraph [--backup-instance-id]
                                                          [--backup-instance-name]
                                                          [--datasource-id]
                                                          [--datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}]
                                                          [--protection-status {ProtectionConfigured, ProtectionError}]
                                                          [--resource-groups]
                                                          [--subscriptions]
                                                          [--vaults]

Examples

list backup instances across multiple vaults across multiple resource groups

az dataprotection backup-instance list-from-resourcegraph --resource-groups resourceGroup1 resourceGroup2 --vaults vault1 vault2 --datasource-type AzureBlob

list backup instances in a vault which are in a protection error state.

az dataprotection backup-instance list-from-resourcegraph --resource-groups resourceGroup --vaults vault --protection-status ProtectionError --datasource-type AzureDisk

Optional Parameters

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

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 dataprotection backup-instance resume-protection [--backup-instance-name --name]
                                                    [--ids]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--vault-name]

Examples

Resume protection

az dataprotection backup-instance resume-protection --name "testbi" --resource-group "testrg" --vault-name "testvault"

Optional Parameters

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

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 dataprotection backup-instance show [--backup-instance-name --name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--vault-name]

Examples

Get BackupInstance

az dataprotection backup-instance show --name "testInstance1" --resource-group "000pikumar" --vault-name "PratikPrivatePreviewVault1"

Optional Parameters

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

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 dataprotection backup-instance stop-protection [--backup-instance-name --name]
                                                  [--ids]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--operation-requests --resource-guard-operation-requests]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--tenant-id]
                                                  [--vault-name]

Examples

Stop protection

az dataprotection backup-instance stop-protection --name "testbi" --resource-group "testrg" --vault-name "testvault"

Optional Parameters

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

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 dataprotection backup-instance suspend-backup [--backup-instance-name --name]
                                                 [--ids]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--operation-requests --resource-guard-operation-requests]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--tenant-id]
                                                 [--vault-name]

Examples

Suspend backups

az dataprotection backup-instance suspend-backup --name "testbi" --resource-group "testrg" --vault-name "testvault"

Optional Parameters

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

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 dataprotection backup-instance update --backup-instance-name
                                         --resource-group
                                         --vault-name
                                         [--container-blob-list --vaulted-blob-container-list]
                                         [--no-wait]
                                         [--system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
                                         [--uami --user-assigned --user-assigned-identity-arm-url]

Examples

Update backed up containers for a vaulted blob backup instance

az dataprotection backup-instance update --backup-instance-name MyDisk1 --vaulted-blob-container-list {backup_configuration} -g MyResourceGroup --vault-name MyVault

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance update-msi-permissions --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                         --operation {Backup, Restore}
                                                         --permissions-scope {Resource, ResourceGroup, Subscription}
                                                         --resource-group
                                                         --vault-name
                                                         [--backup-instance]
                                                         [--keyvault-id]
                                                         [--restore-request-object]
                                                         [--snapshot-resource-group-id --snapshot-rg-id]
                                                         [--target-storage-account-id]
                                                         [--uami --user-assigned --user-assigned-identity-arm-url]
                                                         [--yes]

Examples

Assign the required permissions needed to successfully enable backup for the datasource.

az dataprotection backup-instance update-msi-permissions --backup-instance backup_inst.json --resource-group samarth_resource_group --vault-name samarthbackupvault --datasource-type AzureDisk --operation Backup --permissions-scope ResourceGroup

Assign the required permissions needed to successfully enable restore for the datasource.

az dataprotection backup-instance update-msi-permissions --datasource-type AzureKubernetesService --operation Restore --permissions-scope Resource --resource-group sampleRG --vault-name samplevault --restore-request-object aksrestore.json --snapshot-resource-group-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sampleRG

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance update-policy --backup-instance-name
                                                --policy-id
                                                --resource-group
                                                --vault-name
                                                [--no-wait]
                                                [--operation-requests --resource-guard-operation-requests]
                                                [--tenant-id]

Examples

Update backup policy associated with backup instance

az dataprotection backup-instance update-policy --backup-instance-name MyDisk1 --policy-id {policy_id} -g MyResourceGroup --vault-name MyVault

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance validate-for-backup --backup-instance
                                                      [--ids]
                                                      [--no-wait]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--vault-name]

Examples

Validate for backup

az dataprotection backup-instance validate-for-backup -g sarath-rg --vault-name sarath-vault --backup-instance backup_instance.json

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance validate-for-restore --backup-instance-name --name
                                                       --restore-request-object
                                                       [--ids]
                                                       [--no-wait]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--use-secondary-region {false, true}]
                                                       [--vault-name]

Examples

Validate for restore

az dataprotection backup-instance validate-for-restore -g sample_rg --vault-name sample_backupvault --backup-instance-name sample_biname-fd53a211-3f3e-4c7e-ba45-81050e27c0be --restore-request-object restorerequestobject.json

Validate for cross-region-restore

az dataprotection backup-instance validate-for-restore -g sample_rg --vault-name sample_backupvault --backup-instance-name sample_biname-fd53a211-3f3e-4c7e-ba45-81050e27c0be --restore-request-object restorerequestobject.json --use-secondary-region

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance validate-for-update --backup-instance-name
                                                      --resource-group
                                                      --vault-name
                                                      [--container-blob-list --vaulted-blob-container-list]
                                                      [--no-wait]
                                                      [--system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
                                                      [--uami --user-assigned --user-assigned-identity-arm-url]

Examples

Validate for modify backup

az dataprotection backup-instance validate-for-update -g testRG -v testVault --backup-instance-name "testdisk-testdisk-00000000-0000-0000-0000-0000000000000" --uami "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuami"

Required Parameters

Optional Parameters

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

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 dataprotection backup-instance wait [--backup-instance-name --name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]
                                       [--vault-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.

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