Microsoft.Compute restorePointCollections/restorePoints 2023-09-01

Article
03/07/2024

Bicep resource definition

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

Resource groups - See resource group deployment commands

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@2023-09-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    consistencyMode: 'string'
    excludeDisks: [
      {
        id: 'string'
      }
    ]
    sourceMetadata: {
      storageProfile: {
        dataDisks: [
          {
            caching: 'string'
            diskRestorePoint: {
              encryption: {
                diskEncryptionSet: {
                  id: 'string'
                }
                type: 'string'
              }
              sourceDiskRestorePoint: {
                id: 'string'
              }
            }
            managedDisk: {
              diskEncryptionSet: {
                id: 'string'
              }
              id: 'string'
              securityProfile: {
                diskEncryptionSet: {
                  id: 'string'
                }
                securityEncryptionType: 'string'
              }
              storageAccountType: 'string'
            }
          }
        ]
        osDisk: {
          caching: 'string'
          diskRestorePoint: {
            encryption: {
              diskEncryptionSet: {
                id: 'string'
              }
              type: 'string'
            }
            sourceDiskRestorePoint: {
              id: 'string'
            }
          }
          managedDisk: {
            diskEncryptionSet: {
              id: 'string'
            }
            id: 'string'
            securityProfile: {
              diskEncryptionSet: {
                id: 'string'
              }
              securityEncryptionType: 'string'
            }
            storageAccountType: '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[]
sourceMetadata	Gets the details of the VM captured at the time of the restore point creation.	RestorePointSourceMetadata
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

RestorePointSourceMetadata

Name	Description	Value
storageProfile	Gets the storage profile.	RestorePointSourceVMStorageProfile

RestorePointSourceVMStorageProfile

Name	Description	Value
dataDisks	Gets the data disks of the VM captured at the time of the restore point creation.	RestorePointSourceVMDataDisk[]
osDisk	Gets the OS disk of the VM captured at the time of the restore point creation.	RestorePointSourceVmosDisk

RestorePointSourceVMDataDisk

Name	Description	Value
caching	Gets the caching type.	'None' 'ReadOnly' 'ReadWrite'
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Contains the managed disk details.	ManagedDiskParameters

DiskRestorePointAttributes

Name	Description	Value
encryption	Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.	RestorePointEncryption
sourceDiskRestorePoint	Resource Id of the source disk restore point.	ApiEntityReference

RestorePointEncryption

Name	Description	Value
diskEncryptionSet	Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer `https://aka.ms/mdssewithcmkoverview` for more details.	DiskEncryptionSetParameters
type	The type of key used to encrypt the data of the disk restore point.	'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey'

DiskEncryptionSetParameters

Name	Description	Value
id	Resource Id	string

ManagedDiskParameters

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	DiskEncryptionSetParameters
id	Resource Id	string
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS'

VMDiskSecurityProfile

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.	DiskEncryptionSetParameters
securityEncryptionType	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.	'DiskWithVMGuestState' 'NonPersistedTPM' 'VMGuestStateOnly'

RestorePointSourceVmosDisk

Name	Description	Value
caching	Gets the caching type.	'None' 'ReadOnly' 'ReadWrite'
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Gets the managed disk details	ManagedDiskParameters

ARM template resource definition

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

Resource groups - See resource group deployment commands

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": "2023-09-01",
  "name": "string",
  "properties": {
    "consistencyMode": "string",
    "excludeDisks": [
      {
        "id": "string"
      }
    ],
    "sourceMetadata": {
      "storageProfile": {
        "dataDisks": [
          {
            "caching": "string",
            "diskRestorePoint": {
              "encryption": {
                "diskEncryptionSet": {
                  "id": "string"
                },
                "type": "string"
              },
              "sourceDiskRestorePoint": {
                "id": "string"
              }
            },
            "managedDisk": {
              "diskEncryptionSet": {
                "id": "string"
              },
              "id": "string",
              "securityProfile": {
                "diskEncryptionSet": {
                  "id": "string"
                },
                "securityEncryptionType": "string"
              },
              "storageAccountType": "string"
            }
          }
        ],
        "osDisk": {
          "caching": "string",
          "diskRestorePoint": {
            "encryption": {
              "diskEncryptionSet": {
                "id": "string"
              },
              "type": "string"
            },
            "sourceDiskRestorePoint": {
              "id": "string"
            }
          },
          "managedDisk": {
            "diskEncryptionSet": {
              "id": "string"
            },
            "id": "string",
            "securityProfile": {
              "diskEncryptionSet": {
                "id": "string"
              },
              "securityEncryptionType": "string"
            },
            "storageAccountType": "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	'2023-09-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[]
sourceMetadata	Gets the details of the VM captured at the time of the restore point creation.	RestorePointSourceMetadata
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

RestorePointSourceMetadata

Name	Description	Value
storageProfile	Gets the storage profile.	RestorePointSourceVMStorageProfile

RestorePointSourceVMStorageProfile

Name	Description	Value
dataDisks	Gets the data disks of the VM captured at the time of the restore point creation.	RestorePointSourceVMDataDisk[]
osDisk	Gets the OS disk of the VM captured at the time of the restore point creation.	RestorePointSourceVmosDisk

RestorePointSourceVMDataDisk

Name	Description	Value
caching	Gets the caching type.	'None' 'ReadOnly' 'ReadWrite'
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Contains the managed disk details.	ManagedDiskParameters

DiskRestorePointAttributes

Name	Description	Value
encryption	Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.	RestorePointEncryption
sourceDiskRestorePoint	Resource Id of the source disk restore point.	ApiEntityReference

RestorePointEncryption

Name	Description	Value
diskEncryptionSet	Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer `https://aka.ms/mdssewithcmkoverview` for more details.	DiskEncryptionSetParameters
type	The type of key used to encrypt the data of the disk restore point.	'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey'

DiskEncryptionSetParameters

Name	Description	Value
id	Resource Id	string

ManagedDiskParameters

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	DiskEncryptionSetParameters
id	Resource Id	string
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS'

VMDiskSecurityProfile

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.	DiskEncryptionSetParameters
securityEncryptionType	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.	'DiskWithVMGuestState' 'NonPersistedTPM' 'VMGuestStateOnly'

RestorePointSourceVmosDisk

Name	Description	Value
caching	Gets the caching type.	'None' 'ReadOnly' 'ReadWrite'
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Gets the managed disk details	ManagedDiskParameters

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@2023-09-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      consistencyMode = "string"
      excludeDisks = [
        {
          id = "string"
        }
      ]
      sourceMetadata = {
        storageProfile = {
          dataDisks = [
            {
              caching = "string"
              diskRestorePoint = {
                encryption = {
                  diskEncryptionSet = {
                    id = "string"
                  }
                  type = "string"
                }
                sourceDiskRestorePoint = {
                  id = "string"
                }
              }
              managedDisk = {
                diskEncryptionSet = {
                  id = "string"
                }
                id = "string"
                securityProfile = {
                  diskEncryptionSet = {
                    id = "string"
                  }
                  securityEncryptionType = "string"
                }
                storageAccountType = "string"
              }
            }
          ]
          osDisk = {
            caching = "string"
            diskRestorePoint = {
              encryption = {
                diskEncryptionSet = {
                  id = "string"
                }
                type = "string"
              }
              sourceDiskRestorePoint = {
                id = "string"
              }
            }
            managedDisk = {
              diskEncryptionSet = {
                id = "string"
              }
              id = "string"
              securityProfile = {
                diskEncryptionSet = {
                  id = "string"
                }
                securityEncryptionType = "string"
              }
              storageAccountType = "string"
            }
          }
        }
      }
      sourceRestorePoint = {
        id = "string"
      }
      timeCreated = "string"
    }
  })
}

Property values

restorePointCollections/restorePoints

Name	Description	Value
type	The resource type	"Microsoft.Compute/restorePointCollections/restorePoints@2023-09-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[]
sourceMetadata	Gets the details of the VM captured at the time of the restore point creation.	RestorePointSourceMetadata
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

RestorePointSourceMetadata

Name	Description	Value
storageProfile	Gets the storage profile.	RestorePointSourceVMStorageProfile

RestorePointSourceVMStorageProfile

Name	Description	Value
dataDisks	Gets the data disks of the VM captured at the time of the restore point creation.	RestorePointSourceVMDataDisk[]
osDisk	Gets the OS disk of the VM captured at the time of the restore point creation.	RestorePointSourceVmosDisk

RestorePointSourceVMDataDisk

Name	Description	Value
caching	Gets the caching type.	"None" "ReadOnly" "ReadWrite"
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Contains the managed disk details.	ManagedDiskParameters

DiskRestorePointAttributes

Name	Description	Value
encryption	Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.	RestorePointEncryption
sourceDiskRestorePoint	Resource Id of the source disk restore point.	ApiEntityReference

RestorePointEncryption

Name	Description	Value
diskEncryptionSet	Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer `https://aka.ms/mdssewithcmkoverview` for more details.	DiskEncryptionSetParameters
type	The type of key used to encrypt the data of the disk restore point.	"EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey"

DiskEncryptionSetParameters

Name	Description	Value
id	Resource Id	string

ManagedDiskParameters

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	DiskEncryptionSetParameters
id	Resource Id	string
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	"PremiumV2_LRS" "Premium_LRS" "Premium_ZRS" "StandardSSD_LRS" "StandardSSD_ZRS" "Standard_LRS" "UltraSSD_LRS"

VMDiskSecurityProfile

Name	Description	Value
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.	DiskEncryptionSetParameters
securityEncryptionType	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.	"DiskWithVMGuestState" "NonPersistedTPM" "VMGuestStateOnly"

RestorePointSourceVmosDisk

Name	Description	Value
caching	Gets the caching type.	"None" "ReadOnly" "ReadWrite"
diskRestorePoint	Contains Disk Restore Point properties.	DiskRestorePointAttributes
managedDisk	Gets the managed disk details	ManagedDiskParameters

Microsoft.Compute restorePointCollections/restorePoints 2023-09-01

Bicep resource definition

Resource format

Property values

restorePointCollections/restorePoints

RestorePointProperties

ApiEntityReference

RestorePointSourceMetadata

RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

DiskRestorePointAttributes

RestorePointEncryption

DiskEncryptionSetParameters

ManagedDiskParameters

VMDiskSecurityProfile

RestorePointSourceVmosDisk

ARM template resource definition

Resource format

Property values

restorePointCollections/restorePoints

RestorePointProperties

ApiEntityReference

RestorePointSourceMetadata

RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

DiskRestorePointAttributes

RestorePointEncryption

DiskEncryptionSetParameters

ManagedDiskParameters

VMDiskSecurityProfile

RestorePointSourceVmosDisk

Terraform (AzAPI provider) resource definition

Resource format

Property values

restorePointCollections/restorePoints

RestorePointProperties

ApiEntityReference

RestorePointSourceMetadata

RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

DiskRestorePointAttributes

RestorePointEncryption

DiskEncryptionSetParameters

ManagedDiskParameters

VMDiskSecurityProfile

RestorePointSourceVmosDisk

Feedback

Feedback

Additional resources