Note
This reference is part of the dataprotection extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-instance command. Learn more about extensions.
Manage backup instance with dataprotection.
Commands az dataprotection backup-instance adhoc-backupTrigger adhoc backup.
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
Specify backup policy rule name.
Property Value Parameter group: Backup Rule Options Arguments Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yesName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Specify retention override tag.
Property Value Parameter group: Backup Rule Options Trigger Option ArgumentsName or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance createConfigure backup for a resource in a backup vault.
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
Request backup instance object for operation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yes Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance deleteDelete a backup instance in a backup vault.
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yesName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The name of the backup vault.
Property Value Parameter group: Resource Id ArgumentsDo not prompt for confirmation.
Property Value Default value: False Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance initializeInitialize JSON request body for configuring backup of a resource.
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
ARM Id of the resource to be backed up.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Specify the datasource type of the resource to be backed up.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceId of the backup policy the datasource will be associated.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Backup configuration for backup. Use this parameter to configure protection for AzureKubernetesService.
User-defined friendly name for the backup instance.
--mi-system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--mi-user-assigned --uami --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
Specify the secret store type to use for authentication.
Property Value Accepted values: AzureKeyVaultSpecify the secret store uri to use for authentication.
--snapshot-resource-group-name --snapshot-rg
Name of the resource group in which the backup snapshots should be stored.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance initialize-backupconfigInitialize JSON request body for initializing and configuring backup for AzureKubernetesService or AzureBlobs (for vaulted backups) resources.
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
Specify the datasource type of the resource to be backed up.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
--backup-hook-references --backup-hook-refs
Property sets the hook reference to be executed during backup.
--container-list --vaulted-backup-containers
List of containers to be backed up inside the VaultStore. Use this parameter for DatasourceType AzureBlob.
List of namespaces to be excluded for backup.
--excluded-resource-type --excluded-resource-types
List of resource types to be excluded for backup.
Switch parameter to include all containers to be backed up inside the VaultStore. Use this parameter for DatasourceType AzureBlob.
Property Value Accepted values: false, true--include-cluster-scope --include-cluster-scope-resources
Boolean parameter to decide whether cluster scope resources are included for restore. By default this is taken as true.
Property Value Accepted values: false, trueList of namespaces to be included for backup.
--included-resource-type --included-resource-types
List of resource types to be included for backup.
List of labels for internal filtering for backup.
Boolean parameter to decide whether snapshot volumes are included for backup. By default this is taken as true.
Property Value Accepted values: false, trueStorage account where the Datasource is present. Use this parameter for DatasourceType AzureBlob.
--storage-account-resource-group --storage-account-rg
Storage account resource group name where the Datasource is present. Use this parameter for DatasourceType AzureBlob.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance initialize-restoreconfigInitialize JSON request body for initializing and configuring restore of an AzureKubernetesService resource.
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
Specify the datasource type of the resource to be backed up.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Conflict policy for restore. Allowed values are Skip, Patch. Default value is Skip.
Property Value Accepted values: Patch, SkipList of namespaces to be excluded for restore.
--excluded-resource-type --excluded-resource-types
List of resource types to be excluded for restore.
--include-cluster-scope --include-cluster-scope-resources
Boolean parameter to decide whether cluster scope resources are included for restore. By default this is taken as true.
Property Value Accepted values: false, trueList of namespaces to be included for restore.
--included-resource-type --included-resource-types
List of resource types to be included for restore.
List of labels for internal filtering for restore.
Namespaces mapping from source namespaces to target namespaces to resolve namespace naming conflicts in the target cluster.
--persistent-restoremode --persistent-volume-restore-mode
Restore mode for persistent volumes. Allowed values are RestoreWithVolumeData, RestoreWithoutVolumeData. Default value is RestoreWithVolumeData.
Property Value Accepted values: RestoreWithVolumeData, RestoreWithoutVolumeData--resource-modifier --resource-modifier-reference
Key value mapping for resource modifier reference.
--restore-hook-references --restore-hook-refs
Property sets the hook reference to be executed during restore.
--staging-resource-group-id --staging-rg-id
Resource group of the staging storage account for AKS vaulted backups.
--staging-storage-account-id --staging-storage-id
Storage Account ID for AKS vaulted backups.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance listGets backup instances belonging to a backup vault.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property Value Parameter group: Pagination Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance list-from-resourcegraphList backup instances across subscriptions, resource groups and vaults.
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.
Specify backup instance id filter to apply.
Specify backup instance name filter to apply.
Specify datasource id filter to apply.
Specify the datasource type.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceSpecify protection status.
Property Value Accepted values: ProtectionConfigured, ProtectionErrorList of resource groups.
List of subscription Ids.
List of vault names.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance resume-protectionThis operation will resume protection for a stopped backup instance.
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yesName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance showGet a backup instance with name in a backup vault.
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance stop-protectionThis operation will stop protection of a backup instance and data will be held forever.
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yes--operation-requests --resource-guard-operation-requests
Critical operation request which is protected by the resourceGuard. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --operation-requests
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Tenant ID for cross-tenant calls.
The name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance suspend-backupThis 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).
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsOne 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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Accepted values: 0, 1, f, false, n, no, t, true, y, yes--operation-requests --resource-guard-operation-requests
Critical operation request which is protected by the resourceGuard. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --operation-requests
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Tenant ID for cross-tenant calls.
The name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance updateUpdate properties associated with a backup instance.
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
Backup instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
--container-blob-list --vaulted-blob-container-list
Enter the container list to modify a vaulted blob backup. The output for 'az dataprotection backup-instance initialize-backupconfig' needs to be provided as input.
Do not wait for the long-running operation to finish.
Property Value Default value: False--system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--uami --user-assigned --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance update-msi-permissionsAssign the required permissions needed to successfully enable backup for the datasource.
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
Specify the datasource type of the resource to be backed up.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceList of possible operations.
Property Value Accepted values: Backup, RestoreScope for assigning permissions to the backup vault.
Property Value Accepted values: Resource, ResourceGroup, SubscriptionName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Request body for operation "Backup" Expected value: json-string/@json-file. Required when --operation is Backup.
ARM id of the key vault. Required when --datasource-type is AzureDatabaseForPostgreSQL.
Request body for operation "Restore" Expected value: json-string/@json-file. Required when --operation is Restore.
--snapshot-resource-group-id --snapshot-rg-id
ARM id of the snapshot resource group. Required when assigning permissions over snapshot resource group and the --operation is Restore.
--target-storage-account-id
ARM id of the target storage account. Required when assigning permissions over target storage account and the --operation is Restore.
--uami --user-assigned --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity to be used for assigning permissions. Required if the vault does not have a System Assigned Identity associated with it, and can also be used if the vault does have one.
Do not prompt for confirmation.
Property Value Default value: False Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance update-policyUpdate backup policy associated with backup instance.
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
Backup instance name.
Specify the ID of the new policy with which backup instance will be associated with.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property Value Default value: False--operation-requests --resource-guard-operation-requests
Critical operation request which is protected by the resourceGuard.
ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance validate-for-backupValidate whether configure backup will be successful or not.
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
Request body for operation Expected value: json-string/@json-file.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Default value: FalseName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance validate-for-restoreValidates if Restore can be triggered for a DataSource.
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
--backup-instance-name --name -n
Backup instance name.
Request body for operation. Expected value: json-string/@json-file.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Default value: FalseName of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Use this flag to restore from a recoverypoint in secondary region.
Property Value Accepted values: false, trueName of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance validate-for-updateValidate whether update for backup instance will be successful or not.
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
Backup instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the backup vault.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
--container-blob-list --vaulted-blob-container-list
Enter the container list to modify a vaulted blob backup. The output for 'az dataprotection backup-instance initialize-backupconfig' needs to be provided as input.
Do not wait for the long-running operation to finish.
Property Value Default value: False--system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--uami --user-assigned --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az dataprotection backup-instance waitPlace the CLI in a waiting state until a condition is met.
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.
--backup-instance-name --name -n
The name of the backup instance.
Property Value Parameter group: Resource Id ArgumentsWait until created with 'provisioningState' at 'Succeeded'.
Property Value Parameter group: Wait Condition Arguments Default value: FalseWait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property Value Parameter group: Wait Condition ArgumentsWait until deleted.
Property Value Parameter group: Wait Condition Arguments Default value: FalseWait until the resource exists.
Property Value Parameter group: Wait Condition Arguments Default value: FalseOne 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 ArgumentsPolling interval in seconds.
Property Value Parameter group: Wait Condition Arguments Default value: 30Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Property Value Parameter group: Wait Condition Arguments Default value: 3600Wait until updated with provisioningState at 'Succeeded'.
Property Value Parameter group: Wait Condition Arguments Default value: FalseThe name of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: FalseRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4