az backup recoverypoint

  • Reference

A snapshot of data at that point-of-time, stored in Recovery Services Vault, from which you can restore information.

Commands

Name Description Type Status
az backup recoverypoint list

List all recovery points of a backed up item.

 Core GA
az backup recoverypoint move

Move a particular recovery point of a backed up item from one tier to another tier.

 Core GA
az backup recoverypoint show

Shows details of a particular recovery point.

 Core GA
az backup recoverypoint show-log-chain

List the start and end points of the unbroken log chain(s) of the given backup item.

 Core GA

az backup recoverypoint list

Edit

List all recovery points of a backed up item.

az backup recoverypoint list --container-name
                             --item-name
                             --resource-group
                             --vault-name
                             [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
                             [--end-date]
                             [--is-ready-for-move {false, true}]
                             [--recommended-for-archive]
                             [--start-date]
                             [--target-tier {VaultArchive}]
                             [--tier {Snapshot, SnapshotAndVaultArchive, SnapshotAndVaultStandard, VaultArchive, VaultStandard, VaultStandardRehydrated}]
                             [--use-secondary-region]
                             [--workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}]

Examples

List all recovery points of a backed up item. (autogenerated)

az backup recoverypoint list --container-name MyContainer --backup-management-type AzureIaasVM --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault

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.

--item-name -i

Name of the backed up item.

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

Optional Parameters

--backup-management-type

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.

accepted values: AzureIaasVM, AzureStorage, AzureWorkload
--end-date

The end date of the range in UTC (d-m-Y).

--is-ready-for-move

Use this flag to retrieve the recoverypoints that are ready to be moved to destination-tier.

accepted values: false, true
--recommended-for-archive

Use this flag to retrieve recommended archivable recoverypoints.

--start-date

The start date of the range in UTC (d-m-Y).

--target-tier

The destination/target tier to which a particular recovery point has to be moved.

accepted values: VaultArchive
--tier

Provide 'tier' parameter to filter recovery points.

accepted values: Snapshot, SnapshotAndVaultArchive, SnapshotAndVaultStandard, VaultArchive, VaultStandard, VaultStandardRehydrated
--use-secondary-region

Use this flag to list recoverypoints in secondary region.

--workload-type

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.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az backup recoverypoint move

Edit

Move a particular recovery point of a backed up item from one tier to another tier.

az backup recoverypoint move --container-name
                             --destination-tier {VaultArchive}
                             --item-name
                             --name
                             --resource-group
                             --source-tier {VaultStandard}
                             --vault-name
                             [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
                             [--workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}]

Examples

Move a particular recovery point of a backed up item.

az backup recoverypoint move --container-name MyContainer --backup-management-type AzureIaasVM --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault --name RpId --source-tier SourceTier --destination-tier DestinationTier

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.

--destination-tier

The destination/target tier to which a particular recovery point has to be moved.

accepted values: VaultArchive
--item-name -i

Name of the backed up item.

--name -n

Name of the recovery point.

--resource-group -g

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

--source-tier

The source tier from which a particular recovery point has to be moved.

accepted values: VaultStandard
--vault-name -v

Name of the Recovery services vault.

Optional Parameters

--backup-management-type

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.

accepted values: AzureIaasVM, AzureStorage, AzureWorkload
--workload-type

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.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az backup recoverypoint show

Edit

Shows details of a particular recovery point.

az backup recoverypoint show [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
                             [--container-name]
                             [--ids]
                             [--item-name]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--use-secondary-region]
                             [--vault-name]
                             [--workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}]

Examples

Shows details of a particular recovery point. (autogenerated)

az backup recoverypoint show --container-name MyContainer --backup-management-type AzureIaasVM --item-name MyItem --name MyRecoveryPoint --resource-group MyResourceGroup --vault-name MyVault

Optional Parameters

--backup-management-type

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.

accepted values: AzureIaasVM, AzureStorage, AzureWorkload
--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.

--ids

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.

--item-name -i

Name of the backed up item.

--name -n

Name of the recovery point. You can use the backup recovery point list command to get the name of a backed up item.

--resource-group -g

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

--subscription

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

--use-secondary-region

Use this flag to show recoverypoints in secondary region.

--vault-name -v

Name of the Recovery services vault.

--workload-type

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.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az backup recoverypoint show-log-chain

Edit

List the start and end points of the unbroken log chain(s) of the given backup item.

az backup recoverypoint show-log-chain --container-name
                                       --item-name
                                       --resource-group
                                       --vault-name
                                       [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
                                       [--end-date]
                                       [--start-date]
                                       [--use-secondary-region]
                                       [--workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}]

Examples

List the start and end points of the unbroken log chain(s) of the given backup item. Use it to determine whether the point-in-time, to which the user wants the DB to be restored, is valid or not.

az backup recoverypoint show-log-chain --container-name MyContainer --backup-management-type AzureWorkload --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault

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.

--item-name -i

Name of the backed up item.

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

Optional Parameters

--backup-management-type

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.

accepted values: AzureIaasVM, AzureStorage, AzureWorkload
--end-date

The end date of the range in UTC (d-m-Y).

--start-date

The start date of the range in UTC (d-m-Y).

--use-secondary-region

Use this flag to list recoverypoints in secondary region.

--workload-type

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.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.