Restore Points - Create

The operation to create the restore point. Updating properties of an existing restore point is not allowed

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2022-03-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group.

restorePointCollectionName
path True
  • string

The name of the restore point collection.

restorePointName
path True
  • string

The name of the restore point.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Request Body

Name Type Description
properties.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.

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

properties.sourceRestorePoint

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

properties.timeCreated
  • string

Gets the creation time of the restore point.

Responses

Name Type Description
201 Created

Created

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Copy a restore point to a different region
Create a restore point

Copy a restore point to a different region

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2022-03-01
{
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    }
  }
}

Sample Response

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    },
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ]
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "provisioningState": "Creating",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-10-25T23:54:29.2796325+00:00"
  }
}

Create a restore point

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2022-03-01
{
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ]
  }
}

Sample Response

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ]
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

Definitions

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

ApiEntityReference

The API entity reference.

ApiError

Api error.

ApiErrorBase

Api error base.

BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

CachingTypes

Gets the caching type.

CloudError

An error response from the Compute service.

ComponentNames

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

ConsistencyModeTypes

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.

DiagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

DiskEncryptionSetParameters

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.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

DiskRestorePointInstanceView

The instance view of a disk restore point.

DiskRestorePointReplicationStatus

The instance view of a disk restore point.

HardwareProfile

Specifies the hardware settings for the virtual machine.

InnerError

Inner error details.

InstanceViewStatus

Instance view status.

KeyVaultKeyReference

Describes a reference to Key Vault Key

KeyVaultSecretReference

Describes a reference to Key Vault Secret

LinuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

LinuxPatchAssessmentMode

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

LinuxVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

LinuxVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

ManagedDiskParameters

The parameters of a managed disk.

OperatingSystemType

Gets the Operating System type.

OSProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

PassNames

The pass name. Currently, the only allowable value is OobeSystem.

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

ProtocolTypes

Specifies the protocol of WinRM listener.

Possible values are:
http

https

RestorePoint

Restore Point details.

RestorePointInstanceView

The instance view of a restore point.

RestorePointSourceMetadata

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

RestorePointSourceVMDataDisk

Describes a data disk.

RestorePointSourceVMOSDisk

Describes an Operating System disk.

RestorePointSourceVMStorageProfile

Describes the storage profile.

securityEncryptionTypes

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.

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

SshConfiguration

SSH configuration for Linux based VMs running on Azure

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

StatusLevelTypes

The level code.

StorageAccountTypes

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.

SubResource
UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

VirtualMachineSizeTypes

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk.

NOTE: It can only be set for Confidential VMs

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

WindowsPatchAssessmentMode

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

WindowsVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

WindowsVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Name Type Description
componentName

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

content
  • string

Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.

passName

The pass name. Currently, the only allowable value is OobeSystem.

settingName

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReference

The API entity reference.

Name Type Description
id
  • string

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

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

Name Type Description
enabled
  • boolean

Whether boot diagnostics should be enabled on the Virtual Machine.

storageUri
  • string

Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

CachingTypes

Gets the caching type.

Name Type Description
None
  • string
ReadOnly
  • string
ReadWrite
  • string

CloudError

An error response from the Compute service.

Name Type Description
error

Api error.

ComponentNames

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

Name Type Description
Microsoft-Windows-Shell-Setup
  • string

ConsistencyModeTypes

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.

Name Type Description
ApplicationConsistent
  • string
CrashConsistent
  • string
FileSystemConsistent
  • string

DiagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Name Type Description
bootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

DiskEncryptionSetParameters

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.

Name Type Description
id
  • string

Resource Id

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

Name Type Description
diskEncryptionKey

Specifies the location of the disk encryption key, which is a Key Vault Secret.

enabled
  • boolean

Specifies whether disk encryption should be enabled on the virtual machine.

keyEncryptionKey

Specifies the location of the key encryption key in Key Vault.

DiskRestorePointInstanceView

The instance view of a disk restore point.

Name Type Description
id
  • string

Disk restore point Id.

replicationStatus

The disk restore point replication status information.

DiskRestorePointReplicationStatus

The instance view of a disk restore point.

Name Type Description
completionPercent
  • integer

Replication completion percentage.

status

The resource status information.

HardwareProfile

Specifies the hardware settings for the virtual machine.

Name Type Description
vmSize

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

vmSizeProperties

Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01.

This feature is still in preview mode and is not supported for VirtualMachineScaleSet.

Please follow the instructions in VM Customization for more details.

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

InstanceViewStatus

Instance view status.

Name Type Description
code
  • string

The status code.

displayStatus
  • string

The short localizable label for the status.

level

The level code.

message
  • string

The detailed status message, including for alerts and error messages.

time
  • string

The time of the status.

KeyVaultKeyReference

Describes a reference to Key Vault Key

Name Type Description
keyUrl
  • string

The URL referencing a key encryption key in Key Vault.

sourceVault

The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

Describes a reference to Key Vault Secret

Name Type Description
secretUrl
  • string

The URL referencing a secret in a Key Vault.

sourceVault

The relative URL of the Key Vault containing the secret.

LinuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Name Type Description
disablePasswordAuthentication
  • boolean

Specifies whether password authentication should be disabled.

patchSettings

[Preview Feature] Specifies settings related to VM Guest Patching on Linux.

provisionVMAgent
  • boolean

Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

ssh

Specifies the ssh key configuration for a Linux OS.

LinuxPatchAssessmentMode

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

Name Type Description
assessmentMode

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

automaticByPlatformSettings

Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

patchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Name Type Description
Always
  • string
IfRequired
  • string
Never
  • string
Unknown
  • string

LinuxVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Name Type Description
rebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

LinuxVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

ManagedDiskParameters

The parameters of a managed disk.

Name Type Description
diskEncryptionSet

Specifies the customer managed disk encryption set resource id for the managed disk.

id
  • string

Resource Id

securityProfile

Specifies the security profile for the managed disk.

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.

OperatingSystemType

Gets the Operating System type.

Name Type Description
Linux
  • string
Windows
  • string

OSProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Name Type Description
adminPassword
  • string

Specifies the password of the administrator account.

Minimum-length (Windows): 8 characters

Minimum-length (Linux): 6 characters

Max-length (Windows): 123 characters

Max-length (Linux): 72 characters

Complexity requirements: 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

adminUsername
  • string

Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

Windows-only restriction: Cannot end in "."

Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Minimum-length (Linux): 1 character

Max-length (Linux): 64 characters

Max-length (Windows): 20 characters.

allowExtensionOperations
  • boolean

Specifies whether extension operations should be allowed on the virtual machine.

This may only be set to False when no extensions are present on the virtual machine.

computerName
  • string

Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

Max-length (Windows): 15 characters

Max-length (Linux): 64 characters.

For naming conventions and restrictions see Azure infrastructure services implementation guidelines.

customData
  • string

Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

Note: Do not pass any secrets or passwords in customData property

This property cannot be updated after the VM is created.

customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs

For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

linuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

requireGuestProvisionSignal
  • boolean

Optional property which must either be set to True or omitted.

secrets

Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

windowsConfiguration

Specifies Windows operating system settings on the virtual machine.

PassNames

The pass name. Currently, the only allowable value is OobeSystem.

Name Type Description
OobeSystem
  • string

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

Name Type Description
assessmentMode

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

automaticByPlatformSettings

Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

enableHotpatching
  • boolean

Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.

patchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

ProtocolTypes

Specifies the protocol of WinRM listener.

Possible values are:
http

https

Name Type Description
Http
  • string
Https
  • string

RestorePoint

Restore Point details.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

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

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

properties.instanceView

The restore point instance view.

properties.provisioningState
  • string

Gets the provisioning state of the restore point.

properties.sourceMetadata

Gets the details of the VM captured at the time of the restore point creation.

properties.sourceRestorePoint

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

properties.timeCreated
  • string

Gets the creation time of the restore point.

type
  • string

Resource type

RestorePointInstanceView

The instance view of a restore point.

Name Type Description
diskRestorePoints

The disk restore points information.

statuses

The resource status information.

RestorePointSourceMetadata

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

Name Type Description
diagnosticsProfile

Gets the diagnostics profile.

hardwareProfile

Gets the hardware profile.

licenseType
  • string

Gets the license type, which is for bring your own license scenario.

location
  • string

Location of the VM from which the restore point was created.

osProfile

Gets the OS profile.

securityProfile

Gets the security profile.

storageProfile

Gets the storage profile.

vmId
  • string

Gets the virtual machine unique id.

RestorePointSourceVMDataDisk

Describes a data disk.

Name Type Description
caching

Gets the caching type.

diskRestorePoint

Gets the disk restore point Id.

diskSizeGB
  • integer

Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.

lun
  • integer

Gets the logical unit number.

managedDisk

Gets the managed disk details

name
  • string

Gets the disk name.

RestorePointSourceVMOSDisk

Describes an Operating System disk.

Name Type Description
caching

Gets the caching type.

diskRestorePoint

Gets the disk restore point Id.

diskSizeGB
  • integer

Gets the disk size in GB.

encryptionSettings

Gets the disk encryption settings.

managedDisk

Gets the managed disk details

name
  • string

Gets the disk name.

osType

Gets the Operating System type.

RestorePointSourceVMStorageProfile

Describes the storage profile.

Name Type Description
dataDisks

Gets the data disks of the VM captured at the time of the restore point creation.

osDisk

Gets the OS disk of the VM captured at the time of the restore point creation.

securityEncryptionTypes

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.

Name Type Description
DiskWithVMGuestState
  • string
VMGuestStateOnly
  • string

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Name Type Description
encryptionAtHost
  • boolean

This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

Default: The Encryption at host will be disabled unless this property is set to true for the resource.

securityType

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

uefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

Name Type Description
ConfidentialVM
  • string
TrustedLaunch
  • string

SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Name Type Description
AutoLogon
  • string
FirstLogonCommands
  • string

SshConfiguration

SSH configuration for Linux based VMs running on Azure

Name Type Description
publicKeys

The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Name Type Description
keyData
  • string

SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path
  • string

Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

StatusLevelTypes

The level code.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

StorageAccountTypes

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.

Name Type Description
PremiumV2_LRS
  • string
Premium_LRS
  • string
Premium_ZRS
  • string
StandardSSD_LRS
  • string
StandardSSD_ZRS
  • string
Standard_LRS
  • string
UltraSSD_LRS
  • string

SubResource

Name Type Description
id
  • string

Resource Id

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

Specifies whether secure boot should be enabled on the virtual machine.

Minimum api-version: 2020-12-01

vTpmEnabled
  • boolean

Specifies whether vTPM should be enabled on the virtual machine.

Minimum api-version: 2020-12-01

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Name Type Description
certificateStore
  • string

For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.

certificateUrl
  • string

This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

Name Type Description
sourceVault

The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

vaultCertificates

The list of key vault references in SourceVault which contain certificates.

VirtualMachineSizeTypes

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

Name Type Description
Basic_A0
  • string
Basic_A1
  • string
Basic_A2
  • string
Basic_A3
  • string
Basic_A4
  • string
Standard_A0
  • string
Standard_A1
  • string
Standard_A10
  • string
Standard_A11
  • string
Standard_A1_v2
  • string
Standard_A2
  • string
Standard_A2_v2
  • string
Standard_A2m_v2
  • string
Standard_A3
  • string
Standard_A4
  • string
Standard_A4_v2
  • string
Standard_A4m_v2
  • string
Standard_A5
  • string
Standard_A6
  • string
Standard_A7
  • string
Standard_A8
  • string
Standard_A8_v2
  • string
Standard_A8m_v2
  • string
Standard_A9
  • string
Standard_B1ms
  • string
Standard_B1s
  • string
Standard_B2ms
  • string
Standard_B2s
  • string
Standard_B4ms
  • string
Standard_B8ms
  • string
Standard_D1
  • string
Standard_D11
  • string
Standard_D11_v2
  • string
Standard_D12
  • string
Standard_D12_v2
  • string
Standard_D13
  • string
Standard_D13_v2
  • string
Standard_D14
  • string
Standard_D14_v2
  • string
Standard_D15_v2
  • string
Standard_D16_v3
  • string
Standard_D16s_v3
  • string
Standard_D1_v2
  • string
Standard_D2
  • string
Standard_D2_v2
  • string
Standard_D2_v3
  • string
Standard_D2s_v3
  • string
Standard_D3
  • string
Standard_D32_v3
  • string
Standard_D32s_v3
  • string
Standard_D3_v2
  • string
Standard_D4
  • string
Standard_D4_v2
  • string
Standard_D4_v3
  • string
Standard_D4s_v3
  • string
Standard_D5_v2
  • string
Standard_D64_v3
  • string
Standard_D64s_v3
  • string
Standard_D8_v3
  • string
Standard_D8s_v3
  • string
Standard_DS1
  • string
Standard_DS11
  • string
Standard_DS11_v2
  • string
Standard_DS12
  • string
Standard_DS12_v2
  • string
Standard_DS13
  • string
Standard_DS13-2_v2
  • string
Standard_DS13-4_v2
  • string
Standard_DS13_v2
  • string
Standard_DS14
  • string
Standard_DS14-4_v2
  • string
Standard_DS14-8_v2
  • string
Standard_DS14_v2
  • string
Standard_DS15_v2
  • string
Standard_DS1_v2
  • string
Standard_DS2
  • string
Standard_DS2_v2
  • string
Standard_DS3
  • string
Standard_DS3_v2
  • string
Standard_DS4
  • string
Standard_DS4_v2
  • string
Standard_DS5_v2
  • string
Standard_E16_v3
  • string
Standard_E16s_v3
  • string
Standard_E2_v3
  • string
Standard_E2s_v3
  • string
Standard_E32-16_v3
  • string
Standard_E32-8s_v3
  • string
Standard_E32_v3
  • string
Standard_E32s_v3
  • string
Standard_E4_v3
  • string
Standard_E4s_v3
  • string
Standard_E64-16s_v3
  • string
Standard_E64-32s_v3
  • string
Standard_E64_v3
  • string
Standard_E64s_v3
  • string
Standard_E8_v3
  • string
Standard_E8s_v3
  • string
Standard_F1
  • string
Standard_F16
  • string
Standard_F16s
  • string
Standard_F16s_v2
  • string
Standard_F1s
  • string
Standard_F2
  • string
Standard_F2s
  • string
Standard_F2s_v2
  • string
Standard_F32s_v2
  • string
Standard_F4
  • string
Standard_F4s
  • string
Standard_F4s_v2
  • string
Standard_F64s_v2
  • string
Standard_F72s_v2
  • string
Standard_F8
  • string
Standard_F8s
  • string
Standard_F8s_v2
  • string
Standard_G1
  • string
Standard_G2
  • string
Standard_G3
  • string
Standard_G4
  • string
Standard_G5
  • string
Standard_GS1
  • string
Standard_GS2
  • string
Standard_GS3
  • string
Standard_GS4
  • string
Standard_GS4-4
  • string
Standard_GS4-8
  • string
Standard_GS5
  • string
Standard_GS5-16
  • string
Standard_GS5-8
  • string
Standard_H16
  • string
Standard_H16m
  • string
Standard_H16mr
  • string
Standard_H16r
  • string
Standard_H8
  • string
Standard_H8m
  • string
Standard_L16s
  • string
Standard_L32s
  • string
Standard_L4s
  • string
Standard_L8s
  • string
Standard_M128-32ms
  • string
Standard_M128-64ms
  • string
Standard_M128ms
  • string
Standard_M128s
  • string
Standard_M64-16ms
  • string
Standard_M64-32ms
  • string
Standard_M64ms
  • string
Standard_M64s
  • string
Standard_NC12
  • string
Standard_NC12s_v2
  • string
Standard_NC12s_v3
  • string
Standard_NC24
  • string
Standard_NC24r
  • string
Standard_NC24rs_v2
  • string
Standard_NC24rs_v3
  • string
Standard_NC24s_v2
  • string
Standard_NC24s_v3
  • string
Standard_NC6
  • string
Standard_NC6s_v2
  • string
Standard_NC6s_v3
  • string
Standard_ND12s
  • string
Standard_ND24rs
  • string
Standard_ND24s
  • string
Standard_ND6s
  • string
Standard_NV12
  • string
Standard_NV24
  • string
Standard_NV6
  • string

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk.

NOTE: It can only be set for Confidential VMs

Name Type Description
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.

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.

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

Name Type Description
vCPUsAvailable
  • integer

Specifies the number of vCPUs available for the VM.

When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

vCPUsPerCore
  • integer

Specifies the vCPU to physical core ratio.

When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region

Setting this property to 1 also means that hyper-threading is disabled.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

Name Type Description
additionalUnattendContent

Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

enableAutomaticUpdates
  • boolean

Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.

patchSettings

[Preview Feature] Specifies settings related to VM Guest Patching on Windows.

provisionVMAgent
  • boolean

Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

timeZone
  • string

Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.

winRM

Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

WindowsPatchAssessmentMode

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Name Type Description
Always
  • string
IfRequired
  • string
Never
  • string
Unknown
  • string

WindowsVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Name Type Description
rebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

WindowsVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

Name Type Description
AutomaticByOS
  • string
AutomaticByPlatform
  • string
Manual
  • string

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

Name Type Description
listeners

The list of Windows Remote Management listeners

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

Name Type Description
certificateUrl
  • string

This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

protocol

Specifies the protocol of WinRM listener.

Possible values are:
http

https