az restore-point

Manage restore point with res.

Commands

Name	Description	Type	Status
az restore-point collection	Create the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.	Core	GA
az restore-point collection create	Create the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.	Core	GA
az restore-point collection delete	Delete the restore point collection. This operation will also delete all the contained restore points.	Core	GA
az restore-point collection list	Get the list of restore point collections in a resource group.	Core	GA
az restore-point collection list-all	Get the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.	Core	GA
az restore-point collection show	Get the restore point collection.	Core	GA
az restore-point collection update	Update the restore point collection.	Core	GA
az restore-point collection wait	Place the CLI in a waiting state until a condition of the restore-point-collection is met.	Core	GA
az restore-point create	Create the restore point. Updating properties of an existing restore point is not allowed.	Core	GA
az restore-point delete	Delete the restore point.	Core	GA
az restore-point show	Get the restore point.	Core	GA
az restore-point wait	Place the CLI in a waiting state until a condition of the restore-point is met.	Core	GA

az restore-point create

Create the restore point. Updating properties of an existing restore point is not allowed.

az restore-point create --collection-name
                        --name
                        --resource-group
                        [--consistency-mode {ApplicationConsistent, CrashConsistent, FileSystemConsistent}]
                        [--data-disk-restore-point-encryption-set]
                        [--data-disk-restore-point-encryption-type {EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey}]
                        [--exclude-disks]
                        [--no-wait]
                        [--os-restore-point-encryption-set]
                        [--os-restore-point-encryption-type {EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey}]
                        [--source-data-disk-resource]
                        [--source-os-resource]
                        [--source-restore-point]

Examples

Create a restore point

az restore-point create --exclude-disks "/subscriptions/{subscription-id}/resourceGroups/myResour               ceGroup/providers/Microsoft.Compute/disks/disk123" --resource-group "myResourceGroup"                --collection-name "rpcName" --name "rpName"

Create a restore point with --consistency-mode CrashConsistent

az vm create -n vm -g rg --image Ubuntu2204 --tag EnableCrashConsistentRestorePoint=True

az restore-point collection create --source-id "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"                -g rg --collection-name "myRpc"

az restore-point create --exclude-disks "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"                --resource-group "myResourceGroup" --collection-name "rpcName" --name "rpName"

Required Parameters

--collection-name

The name of the restore point collection.

--name --restore-point-name -n

The name of the restore point.

--resource-group -g

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

Optional Parameters

--consistency-mode

Preview

Consistency mode of the restore point. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.

accepted values: ApplicationConsistent, CrashConsistent, FileSystemConsistent

--data-disk-restore-point-encryption-set

Customer managed data disk encryption set resource id.

--data-disk-restore-point-encryption-type

The type of key used to encrypt the data of the data disk restore point.

accepted values: EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey

--exclude-disks

List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.

Usage: --exclude-disks XX XX id: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... Multiple actions can be specified by using more than one --exclude-disks argument.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--os-restore-point-encryption-set

Customer managed OS disk encryption set resource id.

--os-restore-point-encryption-type

The type of key used to encrypt the data of the OS disk restore point.

accepted values: EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey

--source-data-disk-resource

Resource Id of the source data disk.

--source-os-resource

Resource Id of the source OS disk.

--source-restore-point

Resource Id of the source restore point from which a copy needs to be created.

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 restore-point delete

Delete the restore point.

az restore-point delete [--collection-name]
                        [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Optional Parameters

--collection-name --restore-point-collection-name

The name of the restore point collection.

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

--name --restore-point-name -n

The name of the restore point.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

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

--yes -y

Do not prompt for confirmation.

default value: False

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 restore-point show

Get the restore point.

az restore-point show --collection-name
                      --name
                      --resource-group
                      [--instance-view]

Examples

Get a restore point

az restore-point show --resource-group "myResourceGroup" --collection-name "rpcName" --name "rpName"

Required Parameters

--collection-name

The name of the restore point collection.

--name --restore-point-name -n

The name of the restore point.

--resource-group -g

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

Optional Parameters

--instance-view

Show the instance view of a restore point.

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 restore-point wait

Place the CLI in a waiting state until a condition of the restore-point is met.

az restore-point wait --collection-name
                      --name
                      --resource-group
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--expand]
                      [--interval]
                      [--timeout]
                      [--updated]

Examples

Pause executing next line of CLI script until the restore-point is successfully created.

az restore-point wait --resource-group "myResourceGroup" --collection-name "rpcName" --name "rpName" --created

Pause executing next line of CLI script until the restore-point is successfully deleted.

az restore-point wait --resource-group "myResourceGroup" --collection-name "rpcName" --name "rpName" --deleted

Required Parameters

--collection-name

The name of the restore point collection.

--name --restore-point-name -n

The name of the restore point.

--resource-group -g

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--expand

The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point. 'instanceView' Default value is None.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

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.