az backup item
An item which is already protected or backed up to an Azure Recovery services vault with an associated policy.
Commands
Name | Description | Type | Status |
---|---|---|---|
az backup item list |
List all backed up items within a container. |
Core | GA |
az backup item set-policy |
Update the policy associated with this item. Use this to change policies of the backup item. |
Core | GA |
az backup item show |
Show details of a particular backed up item. |
Core | GA |
az backup item list
List all backed up items within a container.
az backup item list --resource-group
--vault-name
[--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload, MAB}]
[--container-name]
[--use-secondary-region]
[--workload-type {AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM}]
Examples
List all backed up items within a container. (autogenerated)
az backup item list --resource-group MyResourceGroup --vault-name MyVault
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Recovery services vault.
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 the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.
Property | Value |
---|---|
Accepted values: | AzureIaasVM, AzureStorage, AzureWorkload, MAB |
Name of the backup container. Accepts 'Name' or 'FriendlyName' from the output of az backup container list command. If 'FriendlyName' is passed then BackupManagementType is required.
Use this flag to list items in secondary region.
Specify the type of applications within the Resource which should be discovered and protected by Azure Backup. 'MSSQL' and 'SQLDataBase' can be used interchangeably for SQL in Azure VM, as can 'SAPHANA' and 'SAPHanaDatabase' for SAP HANA in Azure VM.
Property | Value |
---|---|
Accepted values: | AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 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 backup item set-policy
Update the policy associated with this item. Use this to change policies of the backup item.
az backup item set-policy --policy-name
[--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
[--container-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--tenant-id]
[--vault-name]
[--workload-type {AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM}]
[--yes]
Examples
Update the policy associated with this item. Use this to change policies of the backup item.
az backup item set-policy --vault-name MyVault --resource-group MyResourceGroup --container-name MyContainer --name MyItem --policy-name MyPolicy --backup-management-type AzureIaasVM
Required Parameters
Name of the Backup policy. You can use the backup policy list command to get the name of a backup policy.
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 the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.
Property | Value |
---|---|
Accepted values: | AzureIaasVM, AzureStorage, AzureWorkload |
Name of the backup container. Accepts 'Name' or 'FriendlyName' from the output of az backup container list command. If 'FriendlyName' is passed then BackupManagementType is required.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the backed up item. You can use the backup item list command to get the name of a backed up item.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.
Name of the Recovery services vault.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Specify the type of applications within the Resource which should be discovered and protected by Azure Backup. 'MSSQL' and 'SQLDataBase' can be used interchangeably for SQL in Azure VM, as can 'SAPHANA' and 'SAPHanaDatabase' for SAP HANA in Azure VM.
Property | Value |
---|---|
Accepted values: | AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM |
Skip confirmation when updating Standard to Enhanced Policies.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 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 backup item show
Show details of a particular backed up item.
az backup item show [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload, MAB}]
[--container-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--use-secondary-region]
[--vault-name]
[--workload-type {AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM}]
Examples
Show details of a particular backed up item. (autogenerated)
az backup item show --container-name MyContainer --name MyBackedUpItem --resource-group MyResourceGroup --vault-name MyVault
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 the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.
Property | Value |
---|---|
Accepted values: | AzureIaasVM, AzureStorage, AzureWorkload, MAB |
Name of the backup container. Accepts 'Name' or 'FriendlyName' from the output of az backup container list command. If 'FriendlyName' is passed then BackupManagementType is required.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the backed up item. You can use the backup item list command to get the name of a backed up item.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Use this flag to show item in secondary region.
Name of the Recovery services vault.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Specify the type of applications within the Resource which should be discovered and protected by Azure Backup. 'MSSQL' and 'SQLDataBase' can be used interchangeably for SQL in Azure VM, as can 'SAPHANA' and 'SAPHanaDatabase' for SAP HANA in Azure VM.
Property | Value |
---|---|
Accepted values: | AzureFileShare, MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, VM |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 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 |