Share via

Microsoft.Compute restorePointCollections/restorePoints 2022-08-01

  • Article

Bicep resource definition

The restorePointCollections/restorePoints resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/restorePointCollections/restorePoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/restorePointCollections/restorePoints@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    consistencyMode: 'string'
    excludeDisks: [
      {
        id: 'string'
      }
    ]
    sourceRestorePoint: {
      id: 'string'
    }
    timeCreated: 'string'
  }
}

Property values

restorePointCollections/restorePoints

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: restorePointCollections
properties The restore point properties. RestorePointProperties

RestorePointProperties

Name Description Value
consistencyMode ConsistencyMode of the RestorePoint. 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. 'ApplicationConsistent'
'CrashConsistent'
'FileSystemConsistent'
excludeDisks 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. ApiEntityReference[]
sourceRestorePoint Resource Id of the source restore point from which a copy needs to be created. ApiEntityReference
timeCreated Gets the creation time of the restore point. string

ApiEntityReference

Name Description Value
id The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... string

ARM template resource definition

The restorePointCollections/restorePoints resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/restorePointCollections/restorePoints resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/restorePointCollections/restorePoints",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "consistencyMode": "string",
    "excludeDisks": [
      {
        "id": "string"
      }
    ],
    "sourceRestorePoint": {
      "id": "string"
    },
    "timeCreated": "string"
  }
}

Property values

restorePointCollections/restorePoints

Name Description Value
type The resource type 'Microsoft.Compute/restorePointCollections/restorePoints'
apiVersion The resource api version '2022-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The restore point properties. RestorePointProperties

RestorePointProperties

Name Description Value
consistencyMode ConsistencyMode of the RestorePoint. 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. 'ApplicationConsistent'
'CrashConsistent'
'FileSystemConsistent'
excludeDisks 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. ApiEntityReference[]
sourceRestorePoint Resource Id of the source restore point from which a copy needs to be created. ApiEntityReference
timeCreated Gets the creation time of the restore point. string

ApiEntityReference

Name Description Value
id The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... string

Terraform (AzAPI provider) resource definition

The restorePointCollections/restorePoints resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/restorePointCollections/restorePoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/restorePointCollections/restorePoints@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      consistencyMode = "string"
      excludeDisks = [
        {
          id = "string"
        }
      ]
      sourceRestorePoint = {
        id = "string"
      }
      timeCreated = "string"
    }
  })
}

Property values

restorePointCollections/restorePoints

Name Description Value
type The resource type "Microsoft.Compute/restorePointCollections/restorePoints@2022-08-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: restorePointCollections
properties The restore point properties. RestorePointProperties

RestorePointProperties

Name Description Value
consistencyMode ConsistencyMode of the RestorePoint. 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. "ApplicationConsistent"
"CrashConsistent"
"FileSystemConsistent"
excludeDisks 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. ApiEntityReference[]
sourceRestorePoint Resource Id of the source restore point from which a copy needs to be created. ApiEntityReference
timeCreated Gets the creation time of the restore point. string

ApiEntityReference

Name Description Value
id The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... string