Feedback

az restore-point

  • Reference

Manage restore point with res.

Commands

az restore-point collection

Manage restore point collection.
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.
az restore-point collection delete

Delete the restore point collection. This operation will also delete all the contained restore points.
az restore-point collection list

Get the list of restore point collections in a resource group.
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.
az restore-point collection show

Get the restore point collection.
az restore-point collection update

Update the restore point collection.
az restore-point collection wait

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

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

Delete the restore point.
az restore-point show

Get the restore point.
az restore-point wait

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

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
                        [--exclude-disks]
                        [--no-wait]
                        [--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"

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

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

--no-wait

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

--source-restore-point

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

az restore-point delete

Delete the restore point.

az restore-point delete --collection-name
                        --name
                        --resource-group
                        [--no-wait]
                        [--yes]

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

--no-wait

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

--yes -y

Do not prompt for confirmation.

az restore-point show

Get the restore point.

az restore-point show --collection-name
                      --name
                      --resource-group
                      [--expand]
                      [--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

--expand

The expand expression to apply on the operation.

--instance-view

Show the instance view of a restore point.

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--expand

The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point. 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'.