az backup protectable-item

Manage the item which is yet to be protected or backed up to an Azure Recovery services vault with an associated policy.

Commands

az backup protectable-item initialize

Trigger the discovery of any unprotected items of the given workload type in the given container.

az backup protectable-item list

Retrieve all protectable items within a certain container or across all registered containers.

az backup protectable-item show

Retrieve the specified protectable item within the given container.

az backup protectable-item initialize

Trigger the discovery of any unprotected items of the given workload type in the given container.

az backup protectable-item initialize --container-name
                                      --resource-group
                                      --vault-name
                                      --workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}
                                      [--subscription]

Examples

Trigger the discovery of any unprotected items of the given workload type in the given container. Use this command to manually discover new DBs and proceed to protect them.

az backup protectable-item initialize --resource-group MyResourceGroup --vault-name MyVault --workload-type MSSQL --container-name MyContainer

Required Parameters

--container-name -c

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.

--resource-group -g

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

--vault-name -v

Name of the Recovery services vault.

--workload-type

Specifiy the type of applications within the Resource which should be discovered and protected by Azure Backup.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az backup protectable-item list

Retrieve all protectable items within a certain container or across all registered containers.

az backup protectable-item list --resource-group
                                --vault-name
                                --workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}
                                [--container-name]
                                [--query-examples]
                                [--subscription]

Examples

Retrieve all protectable items within a certain container or across all registered containers. It consists of all the elements in the hierarchy of the application. Returns DBs and their upper tier entities like Instance, AvailabilityGroup etc.

az backup protectable-item list --resource-group MyResourceGroup --vault-name MyVault --workload-type MSSQL --container-name MyContainer

Required Parameters

--resource-group -g

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

--vault-name -v

Name of the Recovery services vault.

--workload-type

Specifiy the type of applications within the Resource which should be discovered and protected by Azure Backup.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM

Optional Parameters

--container-name -c

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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az backup protectable-item show

Retrieve the specified protectable item within the given container.

az backup protectable-item show --name
                                --protectable-item-type {HANAInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance}
                                --resource-group
                                --server-name
                                --vault-name
                                --workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}
                                [--query-examples]
                                [--subscription]

Examples

Retrieve the specified protectable item within the given container.

az backup protectable-item show --resource-group MyResourceGroup --vault-name MyVault --workload-type MSSQL --protectable-item-type SQLAG --name Name  --server-name MyServerName

Required Parameters

--name

Name of the protectable item.

--protectable-item-type

Specifiy the type of applications within the Resource which should be discovered and protected by Azure Backup.

accepted values: HANAInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance
--resource-group -g

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

--server-name

Parent Server name of the item.

--vault-name -v

Name of the Recovery services vault.

--workload-type

Specifiy the type of applications within the Resource which should be discovered and protected by Azure Backup.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.