PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/?api-version=2023-09-01
The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.
Servers
- https://management.azure.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
restorePointCollectionName |
String | Yes |
The name of the restore point collection. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
The restore point collection properties. |
properties.source |
Object | No |
The properties of the source resource that this restore point collection is created from. |
properties.source.id |
String | No |
Resource Id of the source resource used to create this restore point collection |
properties.source.location |
String | No |
Location of the source resource used to create this restore point collection. |
properties.provisioningState |
String | No |
The provisioning state of the restore point collection. |
properties.restorePointCollectionId |
String | No |
The unique id of the restore point collection. |
properties.restorePoints[] |
Array | No |
A list containing all restore points created under this restore point collection. |
properties.restorePoints[].id |
String | No |
Resource Id |
properties.restorePoints[].name |
String | No |
Resource name |
properties.restorePoints[].properties |
Object | No |
The restore point properties. |
properties.restorePoints[].properties.excludeDisks[] |
Array | No |
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.restorePoints[].properties.excludeDisks[].id |
String | No |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
properties.restorePoints[].properties.timeCreated |
String | No |
Gets the creation time of the restore point. |
properties.restorePoints[].properties.provisioningState |
String | No |
Gets the provisioning state of the restore point. |
properties.restorePoints[].properties.sourceRestorePoint |
Object | No |
The API entity reference. |
properties.restorePoints[].properties.sourceRestorePoint.id |
String | No |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
properties.restorePoints[].properties.instanceView |
Object | No |
The instance view of a restore point. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[] |
Array | No |
The disk restore points information. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].id |
String | No |
Disk restore point Id. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus |
Object | No |
The instance view of a disk restore point. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status |
Object | No |
Instance view status. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status.time |
String | No |
The time of the status. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status.displayStatus |
String | No |
The short localizable label for the status. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status.message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status.level |
String | No |
The level code. Possible values:
|
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.status.code |
String | No |
The status code. |
properties.restorePoints[].properties.instanceView.diskRestorePoints[].replicationStatus.completionPercent |
Integer | No |
Replication completion percentage. |
properties.restorePoints[].properties.instanceView.statuses[] |
Array | No |
The resource status information. |
properties.restorePoints[].properties.instanceView.statuses[].time |
String | No |
The time of the status. |
properties.restorePoints[].properties.instanceView.statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.restorePoints[].properties.instanceView.statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.restorePoints[].properties.instanceView.statuses[].level |
String | No |
The level code. Possible values:
|
properties.restorePoints[].properties.instanceView.statuses[].code |
String | No |
The status code. |
properties.restorePoints[].properties.sourceMetadata |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile |
Object | No |
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration |
Object | No |
Specifies Windows operating system settings on the virtual machine. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.winRM |
Object | No |
Describes Windows Remote Management configuration of the VM |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.winRM.listeners[] |
Array | No |
The list of Windows Remote Management listeners |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.winRM.listeners[].protocol |
String | No |
Specifies the protocol of WinRM listener. Possible values are: http, https. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.winRM.listeners[].certificateUrl |
String | No |
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 the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.provisionVMAgent |
Boolean | No |
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings |
Object | No |
Specifies settings related to VM Guest Patching on Windows. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.assessmentMode |
String | No |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.patchMode |
String | No |
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:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.enableHotpatching |
Boolean | No |
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'. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.automaticByPlatformSettings |
Object | No |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.automaticByPlatformSettings.bypassPlatformSafetyChecksOnUserSchedule |
Boolean | No |
Enables customer to schedule patching without accidental upgrades |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.patchSettings.automaticByPlatformSettings.rebootSetting |
String | No |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.enableAutomaticUpdates |
Boolean | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.enableVMAgentPlatformUpdates |
Boolean | No |
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.timeZone |
String | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.additionalUnattendContent[] |
Array | No |
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.additionalUnattendContent[].settingName |
String | No |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.additionalUnattendContent[].passName |
String | No |
The pass name. Currently, the only allowable value is OobeSystem. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.additionalUnattendContent[].content |
String | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.windowsConfiguration.additionalUnattendContent[].componentName |
String | No |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.customData |
String | No |
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. The property '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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration |
Object | No |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.provisionVMAgent |
Boolean | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings |
Object | No |
Specifies settings related to VM Guest Patching on Linux. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings.assessmentMode |
String | No |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings.patchMode |
String | No |
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:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings |
Object | No |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings.bypassPlatformSafetyChecksOnUserSchedule |
Boolean | No |
Enables customer to schedule patching without accidental upgrades |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings.rebootSetting |
String | No |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.disablePasswordAuthentication |
Boolean | No |
Specifies whether password authentication should be disabled. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.enableVMAgentPlatformUpdates |
Boolean | No |
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.ssh |
Object | No |
SSH configuration for Linux based VMs running on Azure |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.ssh.publicKeys[] |
Array | No |
The list of SSH public keys used to authenticate with linux based VMs. |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.ssh.publicKeys[].keyData |
String | No |
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). |
properties.restorePoints[].properties.sourceMetadata.osProfile.linuxConfiguration.ssh.publicKeys[].path |
String | No |
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 |
properties.restorePoints[].properties.sourceMetadata.osProfile.allowExtensionOperations |
Boolean | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[] |
Array | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[].sourceVault |
Object | No | |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[].sourceVault.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[].vaultCertificates[] |
Array | No |
The list of key vault references in SourceVault which contain certificates. |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[].vaultCertificates[].certificateStore |
String | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.secrets[].vaultCertificates[].certificateUrl |
String | No |
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: |
properties.restorePoints[].properties.sourceMetadata.osProfile.computerName |
String | No |
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. |
properties.restorePoints[].properties.sourceMetadata.osProfile.adminPassword |
String | No |
Specifies the password of the administrator account. |
properties.restorePoints[].properties.sourceMetadata.osProfile.requireGuestProvisionSignal |
Boolean | No |
Optional property which must either be set to True or omitted. |
properties.restorePoints[].properties.sourceMetadata.osProfile.adminUsername |
String | No |
Specifies the name of the administrator account. |
properties.restorePoints[].properties.sourceMetadata.vmId |
String | No |
Gets the virtual machine unique id. |
properties.restorePoints[].properties.sourceMetadata.hardwareProfile |
Object | No |
Specifies the hardware settings for the virtual machine. |
properties.restorePoints[].properties.sourceMetadata.hardwareProfile.vmSizeProperties |
Object | No |
Specifies VM Size Property settings on the virtual machine. |
properties.restorePoints[].properties.sourceMetadata.hardwareProfile.vmSizeProperties.vCPUsPerCore |
Integer | No |
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. |
properties.restorePoints[].properties.sourceMetadata.hardwareProfile.vmSizeProperties.vCPUsAvailable |
Integer | No |
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. |
properties.restorePoints[].properties.sourceMetadata.hardwareProfile.vmSize |
String | No |
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The 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. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.securityProfile |
Object | No |
Specifies the Security profile settings for the virtual machine or virtual machine scale set. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.encryptionAtHost |
Boolean | No |
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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.securityType |
String | No |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.securityProfile.proxyAgentSettings |
Object | No |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.proxyAgentSettings.enabled |
Boolean | No |
Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.proxyAgentSettings.mode |
String | No |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.securityProfile.proxyAgentSettings.keyIncarnationId |
Integer | No |
Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.uefiSettings |
Object | No |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.uefiSettings.secureBootEnabled |
Boolean | No |
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.uefiSettings.vTpmEnabled |
Boolean | No |
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.encryptionIdentity |
Object | No |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
properties.restorePoints[].properties.sourceMetadata.securityProfile.encryptionIdentity.userAssignedIdentityResourceId |
String | No |
Specifies ARM Resource ID of one of the user identities associated with the VM. |
properties.restorePoints[].properties.sourceMetadata.location |
String | No |
Location of the VM from which the restore point was created. |
properties.restorePoints[].properties.sourceMetadata.diagnosticsProfile |
Object | No |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
properties.restorePoints[].properties.sourceMetadata.diagnosticsProfile.bootDiagnostics |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.diagnosticsProfile.bootDiagnostics.enabled |
Boolean | No |
Whether boot diagnostics should be enabled on the Virtual Machine. |
properties.restorePoints[].properties.sourceMetadata.diagnosticsProfile.bootDiagnostics.storageUri |
String | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile |
Object | No |
Describes the storage profile. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.diskControllerType |
String | No |
Provides the disk controller type configured for the VM. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[] |
Array | No |
Gets the data disks of the VM captured at the time of the restore point creation. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].name |
String | No |
Gets the disk name. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].caching |
String | No |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskSizeGB |
Integer | No |
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].writeAcceleratorEnabled |
Boolean | No |
Shows true if the disk is write-accelerator enabled. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint |
Object | No |
Disk Restore Point details. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.sourceDiskRestorePoint |
Object | No |
The API entity reference. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.sourceDiskRestorePoint.id |
String | No |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.encryption |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.encryption.type |
String | No |
The type of key used to encrypt the data of the disk restore point. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.encryption.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].diskRestorePoint.encryption.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].lun |
Integer | No |
Gets the logical unit number. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk |
Object | No |
The parameters of a managed disk. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.securityProfile |
Object | No |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.securityProfile.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.securityProfile.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.securityProfile.securityEncryptionType |
String | No |
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. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.storageAccountType |
String | No |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.dataDisks[].managedDisk.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk |
Object | No |
Describes an Operating System disk. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings |
Object | No |
Describes a Encryption Settings for a Disk |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.keyEncryptionKey |
Object | No |
Describes a reference to Key Vault Key |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault |
Object | Yes | |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl |
String | Yes |
The URL referencing a key encryption key in Key Vault. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.enabled |
Boolean | No |
Specifies whether disk encryption should be enabled on the virtual machine. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.diskEncryptionKey |
Object | No |
Describes a reference to Key Vault Secret |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault |
Object | Yes | |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl |
String | Yes |
The URL referencing a secret in a Key Vault. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.name |
String | No |
Gets the disk name. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.osType |
String | No |
Gets the Operating System type. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.caching |
String | No |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskSizeGB |
Integer | No |
Gets the disk size in GB. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.writeAcceleratorEnabled |
Boolean | No |
Shows true if the disk is write-accelerator enabled. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint |
Object | No |
Disk Restore Point details. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.sourceDiskRestorePoint |
Object | No |
The API entity reference. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.sourceDiskRestorePoint.id |
String | No |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.encryption |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.encryption.type |
String | No |
The type of key used to encrypt the data of the disk restore point. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.encryption.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.diskRestorePoint.encryption.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk |
Object | No |
The parameters of a managed disk. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.securityProfile |
Object | No |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.securityProfile.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.securityProfile.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.securityProfile.securityEncryptionType |
String | No |
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. Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.storageAccountType |
String | No |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types Possible values:
|
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.diskEncryptionSet |
Object | No |
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. |
properties.restorePoints[].properties.sourceMetadata.storageProfile.osDisk.managedDisk.diskEncryptionSet.id |
String | No |
Resource Id |
properties.restorePoints[].properties.sourceMetadata.licenseType |
String | No |
Gets the license type, which is for bring your own license scenario. |
properties.restorePoints[].properties.sourceMetadata.userData |
String | No |
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. |
properties.restorePoints[].properties.sourceMetadata.hyperVGeneration |
String | No |
Specifies the HyperVGeneration Type Possible values:
|
properties.restorePoints[].properties.consistencyMode |
String | No |
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. Possible values:
|
properties.restorePoints[].type |
String | No |
Resource type |
location |
String | No |
Resource location |
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.