Share via

Microsoft.Compute restorePointCollections/restorePoints 2023-07-01

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@2023-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    consistencyMode: 'string'
    excludeDisks: [
      {
        id: 'string'
      }
    ]
    sourceMetadata: {
      storageProfile: {
        dataDisks: [
          {
            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: {
          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

Microsoft.Compute/restorePointCollections/restorePoints

Name Description Value
name The resource name 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

ApiEntityReference

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

DiskEncryptionSetParameters

Name Description Value
id Resource Id string

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

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'

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'

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

RestorePointSourceMetadata

Name Description Value
storageProfile Gets the storage profile. RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Contains the managed disk details. ManagedDiskParameters

RestorePointSourceVmosDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Gets the managed disk details ManagedDiskParameters

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

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, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. 'DiskWithVMGuestState'
'VMGuestStateOnly'

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": "2023-07-01",
  "name": "string",
  "properties": {
    "consistencyMode": "string",
    "excludeDisks": [
      {
        "id": "string"
      }
    ],
    "sourceMetadata": {
      "storageProfile": {
        "dataDisks": [
          {
            "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": {
          "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

Microsoft.Compute/restorePointCollections/restorePoints

Name Description Value
apiVersion The api version '2023-07-01'
name The resource name string (required)
properties The restore point properties. RestorePointProperties
type The resource type 'Microsoft.Compute/restorePointCollections/restorePoints'

ApiEntityReference

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

DiskEncryptionSetParameters

Name Description Value
id Resource Id string

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

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'

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'

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

RestorePointSourceMetadata

Name Description Value
storageProfile Gets the storage profile. RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Contains the managed disk details. ManagedDiskParameters

RestorePointSourceVmosDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Gets the managed disk details ManagedDiskParameters

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

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, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. 'DiskWithVMGuestState'
'VMGuestStateOnly'

Usage Examples

Terraform (AzAPI provider) 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/restorePointCollections/restorePoints@2023-07-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      consistencyMode = "string"
      excludeDisks = [
        {
          id = "string"
        }
      ]
      sourceMetadata = {
        storageProfile = {
          dataDisks = [
            {
              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 = {
            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

Microsoft.Compute/restorePointCollections/restorePoints

Name Description Value
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
type The resource type "Microsoft.Compute/restorePointCollections/restorePoints@2023-07-01"

ApiEntityReference

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

DiskEncryptionSetParameters

Name Description Value
id Resource Id string

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

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'

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'

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

RestorePointSourceMetadata

Name Description Value
storageProfile Gets the storage profile. RestorePointSourceVMStorageProfile

RestorePointSourceVMDataDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Contains the managed disk details. ManagedDiskParameters

RestorePointSourceVmosDisk

Name Description Value
diskRestorePoint Contains Disk Restore Point properties. DiskRestorePointAttributes
managedDisk Gets the managed disk details ManagedDiskParameters

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

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, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. 'DiskWithVMGuestState'
'VMGuestStateOnly'

Usage Examples

Terraform Samples

A basic example of deploying Virtual Machine Restore Point.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2024-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-vnet"
  ___location  = var.___location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = ["10.0.0.0/16"]
      }
      dhcpOptions = {
        dnsServers = []
      }
      privateEndpointVNetPolicies = "Disabled"
      subnets                     = []
    }
  }
}

resource "azapi_resource" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2024-05-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = "${var.resource_name}-subnet"
  body = {
    properties = {
      addressPrefix                     = "10.0.0.0/24"
      defaultOutboundAccess             = true
      delegations                       = []
      privateEndpointNetworkPolicies    = "Disabled"
      privateLinkServiceNetworkPolicies = "Enabled"
      serviceEndpointPolicies           = []
      serviceEndpoints                  = []
    }
  }
}

resource "azapi_resource" "networkInterface" {
  type      = "Microsoft.Network/networkInterfaces@2024-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-nic"
  ___location  = var.___location
  body = {
    properties = {
      enableAcceleratedNetworking = false
      enableIPForwarding          = false
      ipConfigurations = [{
        name = "internal"
        properties = {
          primary                   = false
          privateIPAddressVersion   = "IPv4"
          privateIPAllocationMethod = "Dynamic"
          subnet = {
            id = azapi_resource.subnet.id
          }
        }
      }]
    }
  }
}

resource "azapi_resource" "virtualMachine" {
  type      = "Microsoft.Compute/virtualMachines@2024-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-vm"
  ___location  = var.___location
  body = {
    properties = {
      additionalCapabilities = {}
      applicationProfile = {
        galleryApplications = []
      }
      diagnosticsProfile = {
        bootDiagnostics = {
          enabled    = false
          storageUri = ""
        }
      }
      extensionsTimeBudget = "PT1H30M"
      hardwareProfile = {
        vmSize = "Standard_F2"
      }
      networkProfile = {
        networkInterfaces = [{
          id = azapi_resource.networkInterface.id
          properties = {
            primary = true
          }
        }]
      }
      osProfile = {
        adminUsername            = "adminuser"
        allowExtensionOperations = true
        computerName             = "${var.resource_name}-vm"
        linuxConfiguration = {
          disablePasswordAuthentication = true
          patchSettings = {
            assessmentMode = "ImageDefault"
            patchMode      = "ImageDefault"
          }
          provisionVMAgent = true
          ssh = {
            publicKeys = [{
              keyData = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+wWK73dCr+jgQOAxNsHAnNNNMEMWOHYEccp6wJm2gotpr9katuF/ZAdou5AaW1C61slRkHRkpRRX9FA9CYBiitZgvCCz+3nWNN7l/Up54Zps/pHWGZLHNJZRYyAB6j5yVLMVHIHriY49d/GZTZVNB8GoJv9Gakwc/fuEZYYl4YDFiGMBP///TzlI4jhiJzjKnEvqPFki5p2ZRJqcbCiF4pJrxUQR/RXqVFQdbRLZgYfJ8xGB878RENq3yQ39d8dVOkq4edbkzwcUmwwwkYVPIoDGsYLaRHnG+To7FvMeyO7xDVQkMKzopTQV8AuKpyvpqu0a9pWOMaiCyDytO7GGN you@me.com"
              path    = "/home/adminuser/.ssh/authorized_keys"
            }]
          }
        }
        secrets = []
      }
      priority = "Regular"
      storageProfile = {
        dataDisks = []
        imageReference = {
          offer     = "0001-com-ubuntu-server-jammy"
          publisher = "Canonical"
          sku       = "22_04-lts"
          version   = "latest"
        }
        osDisk = {
          caching      = "ReadWrite"
          createOption = "FromImage"
          managedDisk = {
            storageAccountType = "Standard_LRS"
          }
          osType                  = "Linux"
          writeAcceleratorEnabled = false
        }
      }
    }
  }
}

resource "azapi_resource" "restorePointCollection" {
  type      = "Microsoft.Compute/restorePointCollections@2024-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-rpc"
  ___location  = var.___location
  body = {
    properties = {
      source = {
        id = azapi_resource.virtualMachine.id
      }
    }
  }
  tags = {
    foo = "bar"
  }
}

resource "azapi_resource" "restorePoint" {
  type      = "Microsoft.Compute/restorePointCollections/restorePoints@2024-03-01"
  parent_id = azapi_resource.restorePointCollection.id
  name      = "${var.resource_name}-rp"
  body = {
    properties = {}
  }
}