Virtual Machines - Create Or Update

  • Referenz
Service:
Compute
API Version:
2024-03-01

Der Vorgang zum Erstellen oder Aktualisieren eines virtuellen Computers. Beachten Sie, dass einige Eigenschaften nur während der Erstellung eines virtuellen Computers festgelegt werden können.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?api-version=2024-03-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe.
subscriptionId
 path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmName
 path True

string

Der Name des virtuellen Computers.
api-version
 query True

string

Client-API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

Das ETag der Transformation. Lassen Sie diesen Wert aus, um die aktuelle Ressource immer zu überschreiben. Geben Sie den zuletzt angezeigten ETag-Wert an, um zu verhindern, dass gleichzeitige Änderungen versehentlich überschrieben werden.
If-None-Match

string

Legen Sie diese Einstellung auf "*" fest, um das Erstellen eines neuen Datensatzsatzes zu ermöglichen, aber zu verhindern, dass ein vorhandener Datensatz aktualisiert wird. Andere Werte führen zu einem Fehler vom Server, da sie nicht unterstützt werden.

Anforderungstext

Name Typ Beschreibung
parameters

VirtualMachine

Parameter, die für den Vorgang virtuellen Computer erstellen bereitgestellt werden.

Antworten

Name Typ Beschreibung
200 OK

VirtualMachine

OK
201 Created

VirtualMachine

Erstellt
Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Create a custom-image vm from an unmanaged generalized os image.
Create a Linux vm with a patch setting assessmentMode of ImageDefault.
Create a Linux vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.
Create a Linux vm with a patch setting patchMode of ImageDefault.
Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.
Create a platform-image vm with unmanaged os and data disks.
Create a VM from a community gallery image
Create a vm from a custom image.
Create a vm from a generalized shared image.
Create a VM from a shared gallery image
Create a vm from a specialized shared image.
Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.
Create a vm in an availability set.
Create a vm with a marketplace image plan.
Create a vm with an extensions time budget.
Create a vm with Application Profile.
Create a vm with boot diagnostics.
Create a vm with data disks using 'Copy' and 'Restore' options.
Create a VM with Disk Controller Type
Create a vm with DiskEncryptionSet resource id in the os disk and data disk.
Create a vm with empty data disks.
Create a VM with encryption identity
Create a vm with ephemeral os disk provisioning in Cache disk using placement property.
Create a vm with ephemeral os disk provisioning in Nvme disk using placement property.
Create a vm with ephemeral os disk provisioning in Resource disk using placement property.
Create a vm with ephemeral os disk.
Create a VM with HibernationEnabled
Create a vm with Host Encryption using encryptionAtHost property.
Create a vm with managed boot diagnostics.
Create a VM with network interface configuration
Create a VM with network interface configuration with public ip address dns settings
Create a vm with password authentication.
Create a vm with premium storage.
Create a VM with ProxyAgent Settings of enabled and mode.
Create a vm with Scheduled Events Profile
Create a VM with securityType ConfidentialVM with Customer Managed Keys
Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType
Create a VM with securityType ConfidentialVM with Platform Managed Keys
Create a vm with ssh authentication.
Create a VM with Uefi Settings of secureBoot and vTPM.
Create a VM with UserData
Create a VM with VM Size Properties
Create a Windows vm with a patch setting assessmentMode of ImageDefault.
Create a Windows vm with a patch setting patchMode of AutomaticByOS.
Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.
Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.
Create a Windows vm with a patch setting patchMode of Manual.
Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.
Create or update a VM with capacity reservation

Create a custom-image vm from an unmanaged generalized os image.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "osDisk": {
        "name": "myVMosdisk",
        "image": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd"
        },
        "osType": "Windows",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
        }
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "osDisk": {
        "name": "myVMosdisk",
        "image": {
          "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Windows",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
        }
      },
      "dataDisks": []
    },
    "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "osDisk": {
        "name": "myVMosdisk",
        "image": {
          "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Windows",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
        }
      },
      "dataDisks": []
    },
    "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Linux vm with a patch setting assessmentMode of ImageDefault.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Linux vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": true
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": true
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": true
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Linux vm with a patch setting patchMode of ImageDefault.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a platform-image vm with unmanaged os and data disks.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": [
        {
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 0,
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd"
          }
        },
        {
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 1,
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd"
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "caching": "ReadWrite"
      },
      "dataDisks": [
        {
          "name": "dataDisk0",
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "caching": "None",
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd"
          },
          "lun": 0
        },
        {
          "name": "dataDisk1",
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "caching": "None",
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd"
          },
          "lun": 1
        }
      ]
    },
    "vmId": "5230a749-2f68-4830-900b-702182d32e63",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "vhd": {
          "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "caching": "ReadWrite"
      },
      "dataDisks": [
        {
          "name": "dataDisk0",
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "caching": "None",
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd"
          },
          "lun": 0
        },
        {
          "name": "dataDisk1",
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "caching": "None",
          "vhd": {
            "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd"
          },
          "lun": 1
        }
      ]
    },
    "vmId": "5230a749-2f68-4830-900b-702182d32e63",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm from a custom image.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm from a generalized shared image.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm from a specialized shared image.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": []
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "virtualMachineScaleSet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{existing-flex-vmss-name-with-platformFaultDomainCount-greater-than-1}"
    },
    "platformFaultDomain": 1
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "virtualMachineScaleSet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss"
    },
    "platformFaultDomain": 1,
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "virtualMachineScaleSet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss"
    },
    "platformFaultDomain": 1,
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm in an availability set.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with a marketplace image plan.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with an extensions time budget.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    },
    "extensionsTimeBudget": "PT30M"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "extensionsTimeBudget": "PT30M",
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "extensionsTimeBudget": "PT30M",
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with Application Profile.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "{image_sku}",
        "publisher": "{image_publisher}",
        "version": "latest",
        "offer": "{image_offer}"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config",
          "treatFailureAsDeploymentFailure": false,
          "enableAutomaticUpgrade": false
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "ssh": {
          "publicKeys": [
            {
              "path": "/home/{your-username}/.ssh/authorized_keys",
              "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
            }
          ]
        },
        "disablePasswordAuthentication": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "ssh": {
          "publicKeys": [
            {
              "path": "/home/{your-username}/.ssh/authorized_keys",
              "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
            }
          ]
        },
        "disablePasswordAuthentication": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with boot diagnostics.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with data disks using 'Copy' and 'Restore' options.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      },
      "dataDisks": [
        {
          "diskSizeGB": 1023,
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/{existing-snapshot-name}"
          },
          "lun": 0
        },
        {
          "diskSizeGB": 1023,
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-disk-name}"
          },
          "lun": 1
        },
        {
          "diskSizeGB": 1023,
          "createOption": "Restore",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/{existing-rpc-name}/restorePoints/{existing-rp-name}/diskRestorePoints/{existing-disk-restore-point-name}"
          },
          "lun": 2
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/{existing-snapshot-name}"
          },
          "lun": 0,
          "diskSizeGB": 1023
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-disk-name}"
          },
          "lun": 1,
          "diskSizeGB": 1023
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Restore",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/{existing-rpc-name}/restorePoints/{existing-rp-name}/diskRestorePoints/{existing-disk-restore-point-name}"
          },
          "lun": 2,
          "diskSizeGB": 1023
        }
      ]
    },
    "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/{existing-snapshot-name}"
          },
          "lun": 0,
          "diskSizeGB": 1023,
          "toBeDetached": false
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Copy",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-disk-name}"
          },
          "lun": 1,
          "diskSizeGB": 1023,
          "toBeDetached": false
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Restore",
          "sourceResource": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/{existing-rpc-name}/restorePoints/{existing-rp-name}/diskRestorePoints/{existing-disk-restore-point-name}"
          },
          "lun": 2,
          "diskSizeGB": 1023,
          "toBeDetached": false
        }
      ]
    },
    "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with Disk Controller Type

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      },
      "diskControllerType": "NVMe"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    },
    "userData": "U29tZSBDdXN0b20gRGF0YQ=="
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [],
      "diskControllerType": "NVMe"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "provisioningState": "Updating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [],
      "diskControllerType": "NVMe"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with DiskEncryptionSet resource id in the os disk and data disk.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS",
          "diskEncryptionSet": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
          }
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      },
      "dataDisks": [
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 0
        },
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Attach",
          "lun": 1
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS",
          "diskEncryptionSet": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskencryptionset-name}"
          }
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": [
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 0
        },
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Attach",
          "lun": 1
        }
      ]
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
      },
      "osDisk": {
        "name": "myVMosdisk",
        "diskSizeGB": 30,
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "osType": "Linux"
      },
      "dataDisks": [
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 0
        },
        {
          "caching": "ReadWrite",
          "managedDisk": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          },
          "diskSizeGB": 1023,
          "createOption": "Attach",
          "lun": 1
        }
      ]
    },
    "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with empty data disks.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      },
      "dataDisks": [
        {
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 0
        },
        {
          "diskSizeGB": 1023,
          "createOption": "Empty",
          "lun": 1
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Empty",
          "lun": 0,
          "diskSizeGB": 1023
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Empty",
          "lun": 1,
          "diskSizeGB": 1023
        }
      ]
    },
    "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": [
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Empty",
          "lun": 0,
          "diskSizeGB": 1023,
          "toBeDetached": false
        },
        {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS"
          },
          "createOption": "Empty",
          "lun": 1,
          "diskSizeGB": 1023,
          "toBeDetached": false
        }
      ]
    },
    "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
    "hardwareProfile": {
      "vmSize": "Standard_D2_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with encryption identity

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "securityProfile": {
      "encryptionIdentity": {
        "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "encryptionIdentity": {
        "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
      }
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "encryptionIdentity": {
        "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
      }
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with ephemeral os disk provisioning in Cache disk using placement property.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "CacheDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "CacheDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "CacheDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with ephemeral os disk provisioning in Nvme disk using placement property.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "NvmeDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "NvmeDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "NvmeDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with ephemeral os disk provisioning in Resource disk using placement property.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "ResourceDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "ResourceDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "ResourceDisk"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with ephemeral os disk.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "diffDiskSettings": {
          "option": "Local"
        },
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a VM with HibernationEnabled

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}?api-version=2024-03-01

{
  "location": "eastus2euap",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "additionalCapabilities": {
      "hibernationEnabled": true
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "vmOSdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "{vm-name}",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "{vm-name}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "vmOSdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "additionalCapabilities": {
      "hibernationEnabled": true
    },
    "provisioningState": "Updating"
  },
  "name": "{vm-name}",
  "location": "eastus2euap"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "{vm-name}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "vmOSdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "additionalCapabilities": {
      "hibernationEnabled": true
    },
    "provisioningState": "Creating"
  },
  "name": "{vm-name}",
  "location": "eastus2euap"
}

Create a vm with Host Encryption using encryptionAtHost property.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "securityProfile": {
      "encryptionAtHost": true
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "encryptionAtHost": true
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "encryptionAtHost": true
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with managed boot diagnostics.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with network interface configuration

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkApiVersion": "2020-11-01",
      "networkInterfaceConfigurations": [
        {
          "name": "{nic-config-name}",
          "properties": {
            "primary": true,
            "deleteOption": "Delete",
            "ipConfigurations": [
              {
                "name": "{ip-config-name}",
                "properties": {
                  "primary": true,
                  "publicIPAddressConfiguration": {
                    "name": "{publicIP-config-name}",
                    "sku": {
                      "name": "Basic",
                      "tier": "Global"
                    },
                    "properties": {
                      "deleteOption": "Detach",
                      "publicIPAllocationMethod": "Static"
                    }
                  }
                }
              }
            ]
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with network interface configuration with public ip address dns settings

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkApiVersion": "2020-11-01",
      "networkInterfaceConfigurations": [
        {
          "name": "{nic-config-name}",
          "properties": {
            "primary": true,
            "deleteOption": "Delete",
            "ipConfigurations": [
              {
                "name": "{ip-config-name}",
                "properties": {
                  "primary": true,
                  "publicIPAddressConfiguration": {
                    "name": "{publicIP-config-name}",
                    "sku": {
                      "name": "Basic",
                      "tier": "Global"
                    },
                    "properties": {
                      "deleteOption": "Detach",
                      "publicIPAllocationMethod": "Static",
                      "dnsSettings": {
                        "domainNameLabel": "aaaaa",
                        "domainNameLabelScope": "TenantReuse"
                      }
                    }
                  }
                }
              }
            ]
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with password authentication.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a vm with premium storage.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with ProxyAgent Settings of enabled and mode.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "securityProfile": {
      "proxyAgentSettings": {
        "enabled": true,
        "mode": "Enforce"
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "proxyAgentSettings": {
        "enabled": true,
        "mode": "Enforce"
      }
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "proxyAgentSettings": {
        "enabled": true,
        "mode": "Enforce"
      }
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with Scheduled Events Profile

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    },
    "scheduledEventsProfile": {
      "terminateNotificationProfile": {
        "notBeforeTimeout": "PT10M",
        "enable": true
      },
      "osImageNotificationProfile": {
        "notBeforeTimeout": "PT15M",
        "enable": true
      }
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "scheduledEventsProfile": {
      "terminateNotificationProfile": {
        "notBeforeTimeout": "PT10M",
        "enable": true
      },
      "osImageNotificationProfile": {
        "notBeforeTimeout": "PT15M",
        "enable": true
      }
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "scheduledEventsPolicy": {
      "scheduledEventsAdditionalPublishingTargets": {
        "eventGridAndResourceGraph": {
          "enable": true
        }
      },
      "userInitiatedRedeploy": {
        "automaticallyApprove": true
      },
      "userInitiatedReboot": {
        "automaticallyApprove": true
      }
    },
    "scheduledEventsProfile": {
      "terminateNotificationProfile": {
        "notBeforeTimeout": "PT10M",
        "enable": true
      },
      "osImageNotificationProfile": {
        "notBeforeTimeout": "PT15M",
        "enable": true
      }
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with securityType ConfidentialVM with Customer Managed Keys

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState",
            "diskEncryptionSet": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
            }
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DC2es_v5"
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "linux-cvm",
        "publisher": "UbuntuServer",
        "version": "17763.2183.2109130127",
        "offer": "2022-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "NonPersistedTPM"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "linux-cvm",
        "publisher": "UbuntuServer",
        "version": "17763.2183.2109130127",
        "offer": "2022-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "NonPersistedTPM"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2es_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "linux-cvm",
        "publisher": "UbuntuServer",
        "version": "17763.2183.2109130127",
        "offer": "2022-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "NonPersistedTPM"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2es_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a VM with securityType ConfidentialVM with Platform Managed Keys

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows-cvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "17763.2183.2109130127",
        "offer": "2019-datacenter-cvm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS",
          "securityProfile": {
            "securityEncryptionType": "DiskWithVMGuestState"
          }
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "ConfidentialVM"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DC2as_v5"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a vm with ssh authentication.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "{image_sku}",
        "publisher": "{image_publisher}",
        "version": "latest",
        "offer": "{image_offer}"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "linuxConfiguration": {
        "ssh": {
          "publicKeys": [
            {
              "path": "/home/{your-username}/.ssh/authorized_keys",
              "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
            }
          ]
        },
        "disablePasswordAuthentication": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "ssh": {
          "publicKeys": [
            {
              "path": "/home/{your-username}/.ssh/authorized_keys",
              "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
            }
          ]
        },
        "disablePasswordAuthentication": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "ssh": {
          "publicKeys": [
            {
              "path": "/home/{your-username}/.ssh/authorized_keys",
              "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
            }
          ]
        },
        "disablePasswordAuthentication": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "16.04-LTS",
        "publisher": "Canonical",
        "version": "latest",
        "offer": "UbuntuServer"
      },
      "osDisk": {
        "osType": "Linux",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a VM with Uefi Settings of secureBoot and vTPM.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "TrustedLaunch"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows10-tvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "18363.592.2001092016",
        "offer": "windowsserver-gen2preview-preview"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows10-tvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "18363.592.2001092016",
        "offer": "windowsserver-gen2preview-preview"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "TrustedLaunch"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows10-tvm",
        "publisher": "MicrosoftWindowsServer",
        "version": "18363.592.2001092016",
        "offer": "windowsserver-gen2preview-preview"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "StandardSSD_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "TrustedLaunch"
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "provisioningState": "Creating"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Create a VM with UserData

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "vmOSdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "{vm-name}",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ=="
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "{vm-name}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "vmOSdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "{vm-name}",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "{vm-name}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "vmOSdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "{vm-name}",
  "location": "westus"
}

Create a VM with VM Size Properties

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    },
    "userData": "U29tZSBDdXN0b20gRGF0YQ=="
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "provisioningState": "Updating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        }
      },
      "dataDisks": []
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
        "enabled": true
      }
    },
    "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
    "hardwareProfile": {
      "vmSize": "Standard_D4_v3",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with a patch setting assessmentMode of ImageDefault.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false,
        "patchSettings": {
          "assessmentMode": "ImageDefault"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with a patch setting patchMode of AutomaticByOS.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByOS"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByOS"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByOS"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": false
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": false
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never",
            "bypassPlatformSafetyChecksOnUserSchedule": false
          }
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "enableHotpatching": true
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "enableHotpatching": true
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "enableHotpatching": true
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with a patch setting patchMode of Manual.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "Manual"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "Manual"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false,
        "patchSettings": {
          "patchMode": "Manual"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        },
        "name": "myVMosdisk",
        "createOption": "FromImage"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}
Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform"
        }
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "2016-Datacenter",
        "publisher": "MicrosoftWindowsServer",
        "version": "latest",
        "offer": "WindowsServer"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadWrite",
        "createOption": "FromImage",
        "name": "myVMosdisk",
        "managedDisk": {
          "storageAccountType": "Premium_LRS"
        }
      },
      "dataDisks": []
    },
    "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "name": "myVM",
  "location": "westus"
}

Create or update a VM with capacity reservation

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

{
  "location": "westus",
  "plan": {
    "publisher": "microsoft-ads",
    "product": "windows-data-science-vm",
    "name": "windows2016"
  },
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "storageProfile": {
      "imageReference": {
        "sku": "windows2016",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "windows-data-science-vm"
      },
      "osDisk": {
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      }
    },
    "capacityReservation": {
      "capacityReservationGroup": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
      }
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "myVM",
      "adminPassword": "{your-password}"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "capacityReservation": {
      "capacityReservationGroup": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}
Status code:
201 
{
  "name": "myVM",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      }
    },
    "capacityReservation": {
      "capacityReservationGroup": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "storageProfile": {
      "imageReference": {
        "sku": "standard-data-science-vm",
        "publisher": "microsoft-ads",
        "version": "latest",
        "offer": "standard-data-science-vm"
      },
      "osDisk": {
        "osType": "Windows",
        "caching": "ReadOnly",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "createOption": "FromImage",
        "name": "myVMosdisk"
      },
      "dataDisks": []
    },
    "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
    "hardwareProfile": {
      "vmSize": "Standard_DS1_v2"
    },
    "provisioningState": "Creating"
  },
  "plan": {
    "publisher": "microsoft-ads",
    "product": "standard-data-science-vm",
    "name": "standard-data-science-vm"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "location": "westus"
}

Definitionen

Name Beschreibung
AdditionalCapabilities

Gibt zusätzliche Funktionen an, die auf dem virtuellen Computer aktiviert oder deaktiviert sind.
AdditionalUnattendContent

Gibt zusätzliche Base-64-codierte Informationen im XML-Format an, die in die von Windows Setup verwendete Datei Unattend.xml eingeschlossen werden können.
ApiEntityReference

Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.
ApiError

API-Fehler.
ApiErrorBase

API-Fehlerbasis.
ApplicationProfile

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.
AvailablePatchSummary

Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
BillingProfile

Gibt die Abrechnungsdetails eines virtuellen Azure Spot-Computers an. Api-Mindestversion: 2019-03-01.
BootDiagnostics

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. HINWEIS: Wenn storageUri angegeben wird, stellen Sie sicher, dass sich das Speicherkonto in derselben Region und demselben Abonnement wie die VM befindet. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.
BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.
CachingTypes

Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.
CapacityReservationProfile

Gibt Informationen zur Kapazitätsreservierung an, die zum Zuweisen virtueller Computer verwendet wird. Api-Mindestversion: 2021-04-01.
CloudError

Eine Fehlerantwort des Computediensts.
ComponentNames

Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.
DataDisk

Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
DeleteOptions

Angeben, was mit der Netzwerkschnittstelle geschieht, wenn die VM gelöscht wird
DiagnosticsProfile

Gibt den Status der Startdiagnoseeinstellungen an. Api-Mindestversion: 2015-06-15.
DiffDiskOptions

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.
DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.
DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
DiskControllerTypes

Gibt den Datenträgercontrollertyp an, der für den virtuellen Computer konfiguriert ist. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird und "hyperVGeneration" auf V2 festgelegt ist, basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe der angegebenen Mindestversion der API. Sie müssen die Zuordnung des virtuellen Computers vor dem Aktualisieren des Datenträgercontrollertyps behandeln, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, die implizit zuordnungs- und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.
DiskCreateOptionTypes

Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.
DiskDeleteOptionTypes

Gibt an, ob der Betriebssystemdatenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.
DiskDetachOptionTypes

Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits im Trennvorgang vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Trennungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie die Erzwungene Trennung als letzte Option, um den Datenträger zwangsweise von der VM zu trennen. Bei Verwendung dieses Trennverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich noch im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie einen Datenträger mit Erzwingung aufBeDetached auf "true", zusammen mit der Einstellung detachOption: "ForceDetach".
DiskEncryptionSetParameters

Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.
DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.
DiskInstanceView

Die Datenträgerinformationen des virtuellen Computers.
DomainNameLabelScopeTypes

Der Domänennamensbezeichnungsbereich der PublicIPAddress-Ressourcen, die erstellt werden. Die generierte Namensbezeichnung ist die Verkettung der Hash-Domänennamenbezeichnung mit der Richtlinie gemäß dem Domänennamensbezeichnungsbereich und der eindeutigen ID des VM-Netzwerkprofils.
EncryptionIdentity

Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für keyvault-Vorgänge verwendet wird.
EventGridAndResourceGraph

Die Konfigurationsparameter, die beim Erstellen der Einstellung eventGridAndResourceGraph Scheduled Event verwendet werden.
ExtendedLocation

Der erweiterte Speicherort des virtuellen Computers.
ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.
HardwareProfile

Legt die Hardwareeinstellungen für den virtuellen Computer fest.
HyperVGenerationType

Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist
ImageReference

Gibt Informationen zum zu verwendenden Image an. Sie können Informationen zu Plattformimages, Marketplace-Images oder Vm-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, aber nicht in anderen Erstellungsvorgängen verwendet wird.
InnerError

Details zu inneren Fehlern.
InstanceViewStatus

Instanzansicht status.
IPVersions

Sie ist ab Api-Version 01.07.2019 verfügbar und gibt an, ob die spezifische ipconfiguration IPv4 oder IPv6 ist. Der Standardwert wird als IPv4 verwendet. Mögliche Werte sind: "IPv4" und "IPv6".
KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.
KeyVaultSecretReference

Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und aus dem Schlüsseltresor verwendet werden
LastPatchInstallationSummary

Die Installationszusammenfassung des letzten Installationsvorgangs für den virtuellen Computer.
LinuxConfiguration

Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux auf Azure-Endorsed Distributionen.
LinuxPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
LinuxPatchSettings

[Vorschaufunktion] Gibt Einstellungen im Zusammenhang mit VM-Gastpatches unter Linux an.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.
LinuxVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform im VM-Gastpatching unter Linux an.
LinuxVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

ImageDefault : Die Standard-Patchkonfiguration des virtuellen Computers wird verwendet.

AutomaticByPlatform : Der virtuelle Computer wird von der Plattform automatisch aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.
MaintenanceOperationResultCodeTypes

Der Ergebniscode des letzten Wartungsvorgangs.
MaintenanceRedeployStatus

Der Wartungsvorgang status auf dem virtuellen Computer.
ManagedDiskParameters

Die Parameter für verwaltete Datenträger.
Mode

Gibt den Modus an, in dem ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während er im Erzwingungsmodus die Zugriffssteuerung erzwingt. Der Standardwert ist Erzwingungsmodus.
NetworkApiVersion

Gibt die Microsoft.Network-API-Version an, die beim Erstellen von Netzwerkressourcen in den Netzwerkschnittstellenkonfigurationen verwendet wird.
NetworkInterfaceAuxiliaryMode

Gibt an, ob der Hilfsmodus für die Netzwerkschnittstellenressource aktiviert ist.
NetworkInterfaceAuxiliarySku

Gibt an, ob die Hilfs-SKU für die Netzwerkschnittstellenressource aktiviert ist.
NetworkInterfaceReference

Gibt die Liste der Ressourcen-IDs für die Netzwerkschnittstellen an, die dem virtuellen Computer zugeordnet sind.
NetworkProfile

Legt die Netzwerkschnittstellen des virtuellen Computers fest.
OperatingSystemTypes

Der Betriebssystemtyp.
OSDisk

Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
OSImageNotificationProfile

Gibt konfigurationen im Zusammenhang mit dem geplanten Ereignis des Betriebssystemimages an.
OSProfile

Gibt die Betriebssystemeinstellungen an, die beim Erstellen des virtuellen Computers verwendet werden. Einige der Einstellungen können nicht geändert werden, nachdem der virtuelle Computer bereitgestellt wurde.
PassNames

Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.
PatchOperationStatus

Der gesamte Erfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unknown", "Failed", "Succeeded" oder "CompletedWithWarnings".
PatchSettings

[Vorschaufunktion] Gibt Einstellungen im Zusammenhang mit vm-Gastpatches unter Windows an.
Plan

Gibt Informationen zum Marketplace-Image an, das zum Erstellen des virtuellen Computers verwendet wird. Dieses Element wird nur für Marketplace-Images verwendet. Bevor Sie ein Marketplace-Image über eine API verwenden können, müssen Sie das Image für die programmgesteuerte Verwendung aktivieren. Suchen Sie im Azure-Portal nach dem Marketplace-Image, das Sie verwenden möchten, und klicken Sie dann auf Programmgesteuerte Bereitstellung, Erste Schritte ->. Geben Sie alle erforderlichen Informationen ein, und klicken Sie dann auf Speichern.
ProtocolTypes

Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.
ProxyAgentSettings

Gibt beim Erstellen des virtuellen Computers ProxyAgent-Einstellungen an. Api-Mindestversion: 2024-03-01.
PublicIPAddressSku

Beschreibt die öffentliche IP-SKU. Er kann nur mit OrchestrationMode als Flexibel festgelegt werden.
PublicIPAddressSkuName

Angeben des Namens der öffentlichen IP-SKU
PublicIPAddressSkuTier

Angeben der SKU-Ebene für öffentliche IP-Adressen
PublicIPAllocationMethod

Angeben des Öffentlichen IP-Zuordnungstyps
ResourceIdentityType

Der Identitätstyp, der für den virtuellen Computer verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten vom virtuellen Computer.
ScheduledEventsAdditionalPublishingTargets

Die Konfigurationsparameter, die beim Veröffentlichen von scheduledEventsAdditionalPublishingTargets verwendet werden.
ScheduledEventsPolicy

Gibt Redeploy, Reboot und ScheduledEventsAdditionalPublishingTargets Scheduled Event related konfigurationen für den virtuellen Computer an.
ScheduledEventsProfile

Gibt konfigurationen für geplante Ereignisse an.
securityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.
SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer an.
SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.
SettingNames

Gibt den Namen der Einstellung an, auf die sich der Inhalt bezieht. Mögliche Werte sind: FirstLogonCommands und AutoLogon.
SshConfiguration

Gibt die SSH-Schlüsselkonfiguration für ein Linux-Betriebssystem an.
SshPublicKey

Die Liste der öffentlichen SSH-Schlüssel, die für die Authentifizierung bei linuxbasierten VMs verwendet werden.
StatusLevelTypes

Der Ebenencode.
StorageAccountTypes

Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.
StorageProfile

Legt die Speichereinstellungen für die Datenträger des virtuellen Computers fest.
SubResource

Die relative URL der Key Vault, die das Geheimnis enthält.
TerminateNotificationProfile

Gibt Konfigurationen im Zusammenhang mit geplanten Terminereignissen an.
UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Api-Mindestversion: 2020-12-01.
UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem virtuellen Computer zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
UserInitiatedReboot

Die Konfigurationsparameter, die beim Erstellen von geplanten UserInitiatedReboot-Ereigniseinstellungen verwendet werden.
UserInitiatedRedeploy

Die Konfigurationsparameter, die beim Erstellen von "userInitiatedRedeploy scheduled event setting" verwendet werden.
VaultCertificate

Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten.
VaultSecretGroup

Gibt eine Gruppe von Zertifikaten an, die auf dem virtuellen Computer installiert werden sollen. Zum Installieren von Zertifikaten auf einem virtuellen Computer wird empfohlen, die Azure Key Vault-VM-Erweiterung für Linux oder die Azure Key Vault Vm-Erweiterung für Windows zu verwenden.
VirtualHardDisk

Die virtuelle Festplatte.
VirtualMachine

Beschreibt einen virtuellen Computer.
VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
VirtualMachineEvictionPolicyTypes

Gibt die Entfernungsrichtlinie für den virtuellen Azure Spot-Computer und die Azure Spot-Skalierungsgruppe an. Für virtuelle Azure Spot-Computer werden sowohl "Zuordnung aufheben" als auch "Löschen" unterstützt, und die API-Mindestversion ist 2019-03-01. Für Azure Spot-Skalierungsgruppen werden sowohl "Zuordnung aufheben" als auch "Löschen" unterstützt, und die API-Mindestversion ist 2017-10-30-preview.
VirtualMachineExtension

Die ressourcen der untergeordneten VM-Erweiterung.
VirtualMachineExtensionHandlerInstanceView

Der Vm-Erweiterungshandler instance Ansicht.
VirtualMachineExtensionInstanceView

Die VM-Erweiterung instance Ansicht.
VirtualMachineHealthStatus

Die Integrität status für den virtuellen Computer.
VirtualMachineIdentity

Die Identität des virtuellen Computers, sofern konfiguriert.
VirtualMachineInstanceView

Der virtuelle Computer instance Ansicht.
VirtualMachineIpTag

Die Liste der IP-Tags, die der öffentlichen IP-Adresse zugeordnet sind.
VirtualMachineNetworkInterfaceConfiguration

Gibt die Netzwerkkonfigurationen an, die zum Erstellen der Netzwerkressourcen des virtuellen Computers verwendet werden.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die Netzwerkschnittstellen angewendet werden sollen.
VirtualMachineNetworkInterfaceIPConfiguration

Gibt die IP-Konfigurationen der Netzwerkschnittstelle an.
VirtualMachinePatchStatus

[Vorschaufunktion] Die status von Vm-Patchvorgängen.
VirtualMachinePriorityTypes

Gibt die Priorität für den virtuellen Computer an. Api-Mindestversion: 2019-03-01
VirtualMachinePublicIPAddressConfiguration

Die publicIPAddressConfiguration.
VirtualMachinePublicIPAddressDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die publicIP-Adressen angewendet werden sollen.
VirtualMachineSizeTypes

Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung der folgenden APIs: Auflisten aller verfügbaren VM-Größen in einer Verfügbarkeitsgruppe, Auflisten aller verfügbaren VM-Größen in einer Region, Auflisten aller verfügbaren VM-Größen zum Ändern der Größe. Weitere Informationen zu VM-Größen finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen hängen von der Region und der Verfügbarkeitsgruppe ab.
VMDiskSecurityProfile

Gibt das Sicherheitsprofil für den verwalteten Datenträger an.
VMGalleryApplication

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.
VMSizeProperties

Gibt die Eigenschaften zum Anpassen der Größe des virtuellen Computers an. Api-Mindestversion: 2021-07-01. Dieses Feature befindet sich weiterhin im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. Weitere Informationen finden Sie in den Anweisungen unter Vm-Anpassung .
WindowsConfiguration

Gibt die Einstellungen des Windows-Betriebssystems auf dem virtuellen Computer an.
WindowsPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.
WindowsVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform in VM-Gastpatches unter Windows an.
WindowsVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

Manuell : Sie steuern die Anwendung von Patches auf einem virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss false sein.

AutomaticByOS : Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss true sein.

AutomaticByPlatform : Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.
WinRMConfiguration

Gibt die Windows-Remoteverwaltungslistener an. Dadurch wird die Remoteverwendung von Windows PowerShell ermöglicht.
WinRMListener

Die Liste der Windows-Remoteverwaltungslistener

AdditionalCapabilities

Gibt zusätzliche Funktionen an, die auf dem virtuellen Computer aktiviert oder deaktiviert sind.

Name Typ Beschreibung
hibernationEnabled

boolean

Das Flag, das die Ruhezustandsfunktion auf dem virtuellen Computer aktiviert oder deaktiviert.
ultraSSDEnabled

boolean

Das Flag, das eine Funktion für einen oder mehrere verwaltete Datenträger mit UltraSSD_LRS Speicherkontotyp auf der VM oder VMSS aktiviert oder deaktiviert. Verwaltete Datenträger mit dem Speicherkontotyp UltraSSD_LRS können einem virtuellen Computer oder einer VM-Skalierungsgruppe nur hinzugefügt werden, wenn diese Eigenschaft aktiviert ist.

AdditionalUnattendContent

Gibt zusätzliche Base-64-codierte Informationen im XML-Format an, die in die von Windows Setup verwendete Datei Unattend.xml eingeschlossen werden können.

Name Typ Beschreibung
componentName

ComponentNames

Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.
content

string

Gibt den XML-formatierten Inhalt an, der der unattend.xml-Datei für den angegebenen Pfad und die angegebene Komponente hinzugefügt wird. Der XML-Code muss kleiner als 4 KB sein und das Stammelement für die Einstellung oder das Feature enthalten, das eingefügt wird.
passName

PassNames

Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.
settingName

SettingNames

Gibt den Namen der Einstellung an, auf die sich der Inhalt bezieht. Mögliche Werte sind: FirstLogonCommands und AutoLogon.

ApiEntityReference

Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.

Name Typ Beschreibung
id

string

Die ARM-Ressourcen-ID in Form von /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

API-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.
details

ApiErrorBase[]

Details zu API-Fehlern
innererror

InnerError

Innerer API-Fehler
message

string

Die Fehlermeldung.
target

string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.
message

string

Die Fehlermeldung.
target

string

Das Ziel des bestimmten Fehlers.

ApplicationProfile

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.

Name Typ Beschreibung
galleryApplications

VMGalleryApplication[]

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.

AvailablePatchSummary

Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.

Name Typ Beschreibung
assessmentActivityId

string

Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um CRP- und Erweiterungsprotokolle hinweg zu korrelieren.
criticalAndSecurityPatchCount

integer

Die Anzahl kritischer Patches oder Sicherheitspatches, die als verfügbar erkannt und noch nicht installiert wurden.
error

ApiError

Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Daten.
lastModifiedTime

string

Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
otherPatchCount

integer

Die Anzahl aller verfügbaren Patches mit Ausnahme von "Kritisch" und "Sicherheit".
rebootPending

boolean

Der allgemeine Neustart status des virtuellen Computers. Dies trifft zu, wenn teilweise installierte Patches einen Neustart erfordern, um die Installation abzuschließen, der Neustart jedoch noch nicht erfolgt ist.
startTime

string

Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
status

PatchOperationStatus

Der gesamte Erfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unknown", "Failed", "Succeeded" oder "CompletedWithWarnings".

BillingProfile

Gibt die Abrechnungsdetails eines virtuellen Azure Spot-Computers an. Api-Mindestversion: 2019-03-01.

Name Typ Beschreibung
maxPrice

number

Gibt den maximalen Preis an, den Sie für eine Azure Spot-VM/VMSS bezahlen möchten. Dieser Preis ist in US-Dollar.

Dieser Preis wird mit dem aktuellen Azure Spot-Preis für die VM-Größe verglichen. Außerdem werden die Preise zum Zeitpunkt der Erstellung/Aktualisierung der Azure Spot-VM/VMSS verglichen, und der Vorgang ist nur erfolgreich, wenn der maxPrice über dem aktuellen Azure Spot-Preis liegt.

Der maxPrice wird auch zum Entfernen einer Azure Spot-VM/VMSS verwendet, wenn der aktuelle Azure Spot-Preis nach der Erstellung von VM/VMSS über den maxPrice hinausgeht.

Mögliche Werte:

– Ein beliebiger Dezimalwert größer als 00. Beispiel: 0,01538

-1 – Gibt an, dass der Standardpreis bei Bedarf auf dem aktuellsten Stand ist.

Sie können maxPrice auf -1 festlegen, um anzugeben, dass die Azure Spot-VM/VMSS aus Preisgründen nicht entfernt werden soll. Außerdem ist der maximale Standardpreis -1, wenn er nicht von Ihnen bereitgestellt wird.

Api-Mindestversion: 2019-03-01.

BootDiagnostics

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. HINWEIS: Wenn storageUri angegeben wird, stellen Sie sicher, dass sich das Speicherkonto in derselben Region und demselben Abonnement wie die VM befindet. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.

Name Typ Beschreibung
enabled

boolean

Gibt an, ob der Start Diagnose auf dem virtuellen Computer aktiviert werden soll.
storageUri

string

URI des Speicherkontos, das zum Platzieren der Konsolenausgabe und des Screenshots verwendet werden soll. Wenn storageUri beim Aktivieren des Startvorgangs Diagnose nicht angegeben wird, wird verwalteter Speicher verwendet.

BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.

Name Typ Beschreibung
consoleScreenshotBlobUri

string

Der Blob-URI der Konsole. Hinweis: Dies wird nicht festgelegt, wenn der Start Diagnose derzeit mit verwaltetem Speicher aktiviert ist.
serialConsoleLogBlobUri

string

Der Protokollblob-URI der seriellen Konsole. Hinweis: Dies wird nicht festgelegt, wenn der Start Diagnose derzeit mit verwaltetem Speicher aktiviert ist.
status

InstanceViewStatus

Der Start Diagnose status Informationen für den virtuellen Computer. Hinweis: Sie wird nur festgelegt, wenn Fehler beim Aktivieren des Startvorgangs Diagnose auftreten.

CachingTypes

Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.

Name Typ Beschreibung
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

Gibt Informationen zur Kapazitätsreservierung an, die zum Zuweisen virtueller Computer verwendet wird. Api-Mindestversion: 2021-04-01.

Name Typ Beschreibung
capacityReservationGroup

SubResource

Gibt die Ressourcen-ID der Kapazitätsreservierungsgruppe an, die für die Zuordnung der VM- oder Scaleset-VM-Instanzen verwendet werden soll, sofern genügend Kapazität reserviert wurde. Weitere Informationen finden Sie unter https://aka.ms/CapacityReservation .

CloudError

Eine Fehlerantwort des Computediensts.

Name Typ Beschreibung
error

ApiError

API-Fehler.

ComponentNames

Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.

Name Typ Beschreibung
Microsoft-Windows-Shell-Setup

string

DataDisk

Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

Name Typ Beschreibung
caching

CachingTypes

Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten lautet: Keine für Standardspeicher. ReadOnly für Storage Premium.
createOption

DiskCreateOptionTypes

Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Attach: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image verwenden, um den Datenträger des virtuellen Computers zu erstellen. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden. Leer: Dieser Wert wird beim Erstellen eines leeren Datenträgers verwendet. Kopieren: Dieser Wert wird verwendet, um einen Datenträger aus einem Momentaufnahme oder einem anderen Datenträger zu erstellen. Wiederherstellen: Dieser Wert wird verwendet, um einen Datenträger von einem Datenträgerwiederherstellungspunkt aus zu erstellen.
deleteOption

DiskDeleteOptionTypes

Gibt an, ob der Datenträger beim Löschen eines virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Datenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Datenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt.
detachOption

DiskDetachOptionTypes

Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits in der Ablösung vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Ablösungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie force-detach als letzte Option, um den Datenträger gewaltsam von der VM zu trennen. Bei Verwendung dieses Trennungsverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich weiterhin im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie ein Datenträgerupdate auf "BeDetached" auf "true", und legen Sie detachOption: "ForceDetach" fest.
diskIOPSReadWrite

integer

Gibt die Read-Write IOPS für den verwalteten Datenträger an, wenn StorageAccountType UltraSSD_LRS ist. Wird nur für VirtualMachine ScaleSet-VM-Datenträger zurückgegeben. Kann nur über Updates für die VirtualMachine-Skalierungsgruppe aktualisiert werden.
diskMBpsReadWrite

integer

Gibt die Bandbreite in MB pro Sekunde für den verwalteten Datenträger an, wenn StorageAccountType UltraSSD_LRS ist. Wird nur für VirtualMachine ScaleSet-VM-Datenträger zurückgegeben. Kann nur über Updates für die VirtualMachine-Skalierungsgruppe aktualisiert werden.
diskSizeGB

integer

Gibt die Größe eines leeren Datenträgers in Gigabyte an. Dieses Element kann verwendet werden, um die Größe des Datenträgers in einem VM-Image zu überschreiben. Die Eigenschaft "diskSizeGB" ist die Anzahl der Bytes x 1024^3 für den Datenträger, und der Wert darf nicht größer als 1023 sein.
image

VirtualHardDisk

Die virtuelle Festplatte des Quellbenutzerimages. Die virtuelle Festplatte wird kopiert, bevor sie an den virtuellen Computer angefügt wird. Wenn SourceImage bereitgestellt wird, darf die virtuelle Zielfestplatte nicht vorhanden sein.
lun

integer

Gibt die Nummer der logischen Einheit des Datenträgers an. Dieser Wert wird verwendet, um Datenträger innerhalb des virtuellen Computers zu identifizieren und muss daher für jeden Datenträger, der an einen virtuellen Computer angefügt ist, eindeutig sein.
managedDisk

ManagedDiskParameters

Die Parameter des verwalteten Datenträgers.
name

string

Der Name des Datenträgers
sourceResource

ApiEntityReference

Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.
toBeDetached

boolean

Gibt an, ob sich der Datenträger vom VirtualMachine/VirtualMachineScaleset trennt.
vhd

VirtualHardDisk

Die virtuelle Festplatte.
writeAcceleratorEnabled

boolean

Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

DeleteOptions

Angeben, was mit der Netzwerkschnittstelle geschieht, wenn die VM gelöscht wird

Name Typ Beschreibung
Delete

string

Detach

string

DiagnosticsProfile

Gibt den Status der Startdiagnoseeinstellungen an. Api-Mindestversion: 2015-06-15.

Name Typ Beschreibung
bootDiagnostics

BootDiagnostics

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. HINWEIS: Wenn storageUri angegeben wird, stellen Sie sicher, dass sich das Speicherkonto in derselben Region und demselben Abonnement wie die VM befindet. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.

DiffDiskOptions

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.

Name Typ Beschreibung
Local

string

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.

Name Typ Beschreibung
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.

Name Typ Beschreibung
option

DiffDiskOptions

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.
placement

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.

DiskControllerTypes

Gibt den Datenträgercontrollertyp an, der für den virtuellen Computer konfiguriert ist. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird und "hyperVGeneration" auf V2 festgelegt ist, basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe der angegebenen Mindestversion der API. Sie müssen die Zuordnung des virtuellen Computers vor dem Aktualisieren des Datenträgercontrollertyps behandeln, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, die implizit zuordnungs- und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.

Name Typ Beschreibung
NVMe

string

SCSI

string

DiskCreateOptionTypes

Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.

Name Typ Beschreibung
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

Gibt an, ob der Betriebssystemdatenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.

Name Typ Beschreibung
Delete

string

Detach

string

DiskDetachOptionTypes

Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits im Trennvorgang vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Trennungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie die Erzwungene Trennung als letzte Option, um den Datenträger zwangsweise von der VM zu trennen. Bei Verwendung dieses Trennverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich noch im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie einen Datenträger mit Erzwingung aufBeDetached auf "true", zusammen mit der Einstellung detachOption: "ForceDetach".

Name Typ Beschreibung
ForceDetach

string

DiskEncryptionSetParameters

Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.

Name Typ Beschreibung
id

string

Ressourcen-ID

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.

Name Typ Beschreibung
diskEncryptionKey

KeyVaultSecretReference

Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, der ein Key Vault Geheimnis ist.
enabled

boolean

Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

DiskInstanceView

Die Datenträgerinformationen des virtuellen Computers.

Name Typ Beschreibung
encryptionSettings

DiskEncryptionSettings[]

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an.

Api-Mindestversion: 2015-06-15
name

string

Der Name des Datenträgers
statuses

InstanceViewStatus[]

Die Ressource status Informationen.

DomainNameLabelScopeTypes

Der Domänennamensbezeichnungsbereich der PublicIPAddress-Ressourcen, die erstellt werden. Die generierte Namensbezeichnung ist die Verkettung der Hash-Domänennamenbezeichnung mit der Richtlinie gemäß dem Domänennamensbezeichnungsbereich und der eindeutigen ID des VM-Netzwerkprofils.

Name Typ Beschreibung
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für keyvault-Vorgänge verwendet wird.

Name Typ Beschreibung
userAssignedIdentityResourceId

string

Gibt die ARM-Ressourcen-ID einer der Benutzeridentitäten an, die der VM zugeordnet sind.

EventGridAndResourceGraph

Die Konfigurationsparameter, die beim Erstellen der Einstellung eventGridAndResourceGraph Scheduled Event verwendet werden.

Name Typ Beschreibung
enable

boolean

Gibt an, ob Event Grid und Resource Graph für geplante ereignisbezogene Konfigurationen aktiviert sind.

ExtendedLocation

Der erweiterte Speicherort des virtuellen Computers.

Name Typ Beschreibung
name

string

Der Name des erweiterten Speicherorts.
type

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

Name Typ Beschreibung
EdgeZone

string

HardwareProfile

Legt die Hardwareeinstellungen für den virtuellen Computer fest.

Name Typ Beschreibung
vmSize

VirtualMachineSizeTypes

Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung der folgenden APIs: Auflisten aller verfügbaren VM-Größen in einer Verfügbarkeitsgruppe, Auflisten aller verfügbaren VM-Größen in einer Region, Auflisten aller verfügbaren VM-Größen zum Ändern der Größe. Weitere Informationen zu VM-Größen finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen hängen von der Region und der Verfügbarkeitsgruppe ab.
vmSizeProperties

VMSizeProperties

Gibt die Eigenschaften zum Anpassen der Größe des virtuellen Computers an. Api-Mindestversion: 2021-07-01. Dieses Feature befindet sich weiterhin im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. Weitere Informationen finden Sie in den Anweisungen unter Vm-Anpassung .

HyperVGenerationType

Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist

Name Typ Beschreibung
V1

string

V2

string

ImageReference

Gibt Informationen zum zu verwendenden Image an. Sie können Informationen zu Plattformimages, Marketplace-Images oder Vm-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, aber nicht in anderen Erstellungsvorgängen verwendet wird.

Name Typ Beschreibung
communityGalleryImageId

string

Gibt die eindeutige ID des Communitykatalogimages für die VM-Bereitstellung an. Dies kann aus dem GET-Aufruf des Communitykatalogimages abgerufen werden.
exactVersion

string

Gibt in Dezimalzahlen die Version des Plattformimages oder Marketplace-Images an, die zum Erstellen des virtuellen Computers verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich von "version", nur wenn der im Feld "version" angegebene Wert "neueste" ist.
id

string

Ressourcen-ID
offer

string

Gibt das Angebot des Plattformimages oder Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird.
publisher

string

Der Imageherausgeber.
sharedGalleryImageId

string

Geben Sie die eindeutige ID des freigegebenen Katalogimages für die VM-Bereitstellung an. Dies kann aus dem GET-Aufruf des freigegebenen Katalogimages abgerufen werden.
sku

string

Die Image-SKU.
version

string

Gibt die Version des Plattformimages oder Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird. Die zulässigen Formate sind Major.Minor.Build oder "latest". Haupt-, Neben- und Buildzahlen sind Dezimalzahlen. Geben Sie „latest“ an, damit Sie die neueste Version eines Images verwenden können, das zum Zeitpunkt der Bereitstellung verfügbar ist. Selbst wenn Sie "neueste" verwenden, wird das VM-Image nach der Bereitstellungszeit nicht automatisch aktualisiert, auch wenn eine neue Version verfügbar wird. Verwenden Sie das Feld "version" nicht für die Bereitstellung des Katalogimages. Das Katalogimage sollte immer das Feld "id" für die Bereitstellung verwenden. Um die neueste Version des Katalogimages zu verwenden, legen Sie einfach "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}" im Feld "id" ohne Versionseingabe fest.

InnerError

Details zu inneren Fehlern.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype

string

Der Ausnahmetyp.

InstanceViewStatus

Instanzansicht status.

Name Typ Beschreibung
code

string

Der Statuscode.
displayStatus

string

Die kurze lokalisierbare Bezeichnung für die status.
level

StatusLevelTypes

Der Ebenencode.
message

string

Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen.
time

string

Die Zeit der status.

IPVersions

Sie ist ab Api-Version 01.07.2019 verfügbar und gibt an, ob die spezifische ipconfiguration IPv4 oder IPv6 ist. Der Standardwert wird als IPv4 verwendet. Mögliche Werte sind: "IPv4" und "IPv6".

Name Typ Beschreibung
IPv4

string

IPv6

string

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

Name Typ Beschreibung
keyUrl

string

Die URL, die auf einen Schlüsselverschlüsselungsschlüssel in Key Vault verweist.
sourceVault

SubResource

Die relative URL der Key Vault, die den Schlüssel enthält.

KeyVaultSecretReference

Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und aus dem Schlüsseltresor verwendet werden

Name Typ Beschreibung
secretUrl

string

Die URL, die auf ein Geheimnis in einer Key Vault verweist.
sourceVault

SubResource

Die relative URL der Key Vault, die das Geheimnis enthält.

LastPatchInstallationSummary

Die Installationszusammenfassung des letzten Installationsvorgangs für den virtuellen Computer.

Name Typ Beschreibung
error

ApiError

Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Daten.
excludedPatchCount

integer

Die Anzahl aller verfügbaren Patches, aber explizit durch eine vom Kunden angegebene Ausschlusslisten-Übereinstimmung ausgeschlossen.
failedPatchCount

integer

Die Anzahl der Patches, bei denen die Installation fehlgeschlagen ist.
installationActivityId

string

Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um CRP- und Erweiterungsprotokolle hinweg zu korrelieren.
installedPatchCount

integer

Die Anzahl der patches, die erfolgreich installiert wurden.
lastModifiedTime

string

Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
maintenanceWindowExceeded

boolean

Beschreibt, ob der Vorgang nicht mehr lange dauerte, bevor er alle beabsichtigten Aktionen abgeschlossen hat.
notSelectedPatchCount

integer

Die Anzahl aller verfügbaren Patches, die jedoch nicht installiert werden sollen, da sie nicht mit einem Klassifizierungs- oder Aufnahmelisteneintrag übereinstimmten.
pendingPatchCount

integer

Die Anzahl aller verfügbaren Patches, die während des Patchinstallationsvorgangs installiert werden sollen.
startTime

string

Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
status

PatchOperationStatus

Der gesamte Erfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unknown", "Failed", "Succeeded" oder "CompletedWithWarnings".

LinuxConfiguration

Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux auf Azure-Endorsed Distributionen.

Name Typ Beschreibung
disablePasswordAuthentication

boolean

Gibt an, ob die Kennwortauthentifizierung deaktiviert werden soll.
enableVMAgentPlatformUpdates

boolean

Gibt an, ob VMAgent Platform Updates für den virtuellen Linux-Computer aktiviert ist. Der Standardwert ist „false“.
patchSettings

LinuxPatchSettings

[Vorschaufeature] Gibt Einstellungen im Zusammenhang mit dem Vm-Gastpatching unter Linux an.
provisionVMAgent

boolean

Gibt an, ob der VM-Agent auf dem virtuellen Computer bereitgestellt werden soll. Wenn diese Eigenschaft im Anforderungstext nicht angegeben ist, wird sie standardmäßig auf true festgelegt. Dadurch wird sichergestellt, dass der VM-Agent auf dem virtuellen Computer installiert ist, sodass erweiterungen später dem virtuellen Computer hinzugefügt werden können.
ssh

SshConfiguration

Gibt die SSH-Schlüsselkonfiguration für ein Linux-Betriebssystem an.

LinuxPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.

Name Typ Beschreibung
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

[Vorschaufunktion] Gibt Einstellungen im Zusammenhang mit VM-Gastpatches unter Linux an.

Name Typ Beschreibung
assessmentMode

LinuxPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform im VM-Gastpatching unter Linux an.
patchMode

LinuxVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

ImageDefault : Die Standard-Patchkonfiguration des virtuellen Computers wird verwendet.

AutomaticByPlatform : Der virtuelle Computer wird von der Plattform automatisch aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

Name Typ Beschreibung
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform im VM-Gastpatching unter Linux an.

Name Typ Beschreibung
bypassPlatformSafetyChecksOnUserSchedule

boolean

Ermöglicht dem Kunden das Planen von Patches ohne versehentliche Upgrades.
rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

LinuxVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

ImageDefault : Die Standard-Patchkonfiguration des virtuellen Computers wird verwendet.

AutomaticByPlatform : Der virtuelle Computer wird von der Plattform automatisch aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.

Name Typ Beschreibung
AutomaticByPlatform

string

ImageDefault

string

MaintenanceOperationResultCodeTypes

Der Ergebniscode des letzten Wartungsvorgangs.

Name Typ Beschreibung
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

Der Wartungsvorgang status auf dem virtuellen Computer.

Name Typ Beschreibung
isCustomerInitiatedMaintenanceAllowed

boolean

True, wenn der Kunde die Wartung ausführen darf.
lastOperationMessage

string

Meldung, die für den letzten Wartungsvorgang zurückgegeben wird.
lastOperationResultCode

MaintenanceOperationResultCodeTypes

Der Ergebniscode des letzten Wartungsvorgangs.
maintenanceWindowEndTime

string

Endzeit für das Wartungsfenster.
maintenanceWindowStartTime

string

Startzeit für das Wartungsfenster.
preMaintenanceWindowEndTime

string

Endzeit für das Fenster vor der Wartung.
preMaintenanceWindowStartTime

string

Startzeit für das Fenster Vorwartung.

ManagedDiskParameters

Die Parameter für verwaltete Datenträger.

Name Typ Beschreibung
diskEncryptionSet

DiskEncryptionSetParameters

Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.
id

string

Ressourcen-ID
securityProfile

VMDiskSecurityProfile

Gibt das Sicherheitsprofil für den verwalteten Datenträger an.
storageAccountType

StorageAccountTypes

Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.

Mode

Gibt den Modus an, in dem ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während er im Erzwingungsmodus die Zugriffssteuerung erzwingt. Der Standardwert ist Erzwingungsmodus.

Name Typ Beschreibung
Audit

string

Enforce

string

NetworkApiVersion

Gibt die Microsoft.Network-API-Version an, die beim Erstellen von Netzwerkressourcen in den Netzwerkschnittstellenkonfigurationen verwendet wird.

Name Typ Beschreibung
2020-11-01

string

NetworkInterfaceAuxiliaryMode

Gibt an, ob der Hilfsmodus für die Netzwerkschnittstellenressource aktiviert ist.

Name Typ Beschreibung
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

Gibt an, ob die Hilfs-SKU für die Netzwerkschnittstellenressource aktiviert ist.

Name Typ Beschreibung
A1

string

A2

string

A4

string

A8

string

None

string

NetworkInterfaceReference

Gibt die Liste der Ressourcen-IDs für die Netzwerkschnittstellen an, die dem virtuellen Computer zugeordnet sind.

Name Typ Beschreibung
id

string

Ressourcen-ID
properties.deleteOption

DeleteOptions

Geben Sie an, was mit der Netzwerkschnittstelle geschieht, wenn der virtuelle Computer gelöscht wird.
properties.primary

boolean

Gibt die primäre Netzwerkschnittstelle an, falls der virtuelle Computer über mehr als 1 Netzwerkschnittstelle verfügt.

NetworkProfile

Legt die Netzwerkschnittstellen des virtuellen Computers fest.

Name Typ Beschreibung
networkApiVersion

NetworkApiVersion

Gibt die Microsoft.Network-API-Version an, die beim Erstellen von Netzwerkressourcen in den Netzwerkschnittstellenkonfigurationen verwendet wird.
networkInterfaceConfigurations

VirtualMachineNetworkInterfaceConfiguration[]

Gibt die Netzwerkkonfigurationen an, die zum Erstellen der Netzwerkressourcen des virtuellen Computers verwendet werden.
networkInterfaces

NetworkInterfaceReference[]

Gibt die Liste der Ressourcen-IDs für die Netzwerkschnittstellen an, die dem virtuellen Computer zugeordnet sind.

OperatingSystemTypes

Der Betriebssystemtyp.

Name Typ Beschreibung
Linux

string

Windows

string

OSDisk

Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

Name Typ Beschreibung
caching

CachingTypes

Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten lautet: Keine für Standardspeicher. ReadOnly für Storage Premium.
createOption

DiskCreateOptionTypes

Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Attach: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.
deleteOption

DiskDeleteOptionTypes

Gibt an, ob der Betriebssystemdatenträger beim Löschen eines virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger beibehalten, nachdem der virtuelle Computer gelöscht wurde. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.
diffDiskSettings

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
diskSizeGB

integer

Gibt die Größe eines leeren Datenträgers in Gigabyte an. Dieses Element kann verwendet werden, um die Größe des Datenträgers in einem VM-Image zu überschreiben. Die Eigenschaft "diskSizeGB" ist die Anzahl der Bytes x 1024^3 für den Datenträger, und der Wert darf nicht größer als 1023 sein.
encryptionSettings

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.
image

VirtualHardDisk

Die virtuelle Festplatte des Quellbenutzerimages. Die virtuelle Festplatte wird kopiert, bevor sie an den virtuellen Computer angefügt wird. Wenn SourceImage bereitgestellt wird, darf die virtuelle Zielfestplatte nicht vorhanden sein.
managedDisk

ManagedDiskParameters

Die Parameter des verwalteten Datenträgers.
name

string

Der Name des Datenträgers
osType

OperatingSystemTypes

Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn Sie einen virtuellen Computer aus einem Benutzerimage oder einer spezialisierten VHD erstellen. Mögliche Werte sind: Windows,Linux.
vhd

VirtualHardDisk

Die virtuelle Festplatte.
writeAcceleratorEnabled

boolean

Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

OSImageNotificationProfile

Gibt konfigurationen im Zusammenhang mit dem geplanten Ereignis des Betriebssystemimages an.

Name Typ Beschreibung
enable

boolean

Gibt an, ob das Ereignis "Betriebssystemabbild geplant" aktiviert oder deaktiviert ist.
notBeforeTimeout

string

Die Dauer der Zeit, für die ein virtueller Computer neu erstellt oder das Betriebssystem aktualisiert wird, muss möglicherweise das geplante Ereignis des Betriebssystemimages genehmigen, bevor das Ereignis automatisch genehmigt wird (Timeout). Die Konfiguration wird im ISO 8601-Format angegeben, und der Wert muss 15 Minuten (PT15M) betragen.

OSProfile

Gibt die Betriebssystemeinstellungen an, die beim Erstellen des virtuellen Computers verwendet werden. Einige der Einstellungen können nicht geändert werden, nachdem der virtuelle Computer bereitgestellt wurde.

Name Typ Beschreibung
adminPassword

string

Gibt das Kennwort des Administratorkontos an.

Mindestlänge (Windows): 8 Zeichen

Mindestlänge (Linux): 6 Zeichen

Maximale Länge (Windows): 123 Zeichen

Maximale Länge (Linux): 72 Zeichen

Komplexitätsanforderungen: 3 von vier folgenden Bedingungen müssen erfüllt werden
Hat niedrigere Zeichen
Hat obere Zeichen
Verfügt über eine Ziffer
Hat ein Sonderzeichen (Regex-Übereinstimmung [\W_])

Unzulässige Werte: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

Informationen zum Zurücksetzen des Kennworts finden Sie unter Zurücksetzen des Remotedesktopdiensts oder seines Anmeldekennworts auf einem virtuellen Windows-Computer.

Informationen zum Zurücksetzen des Stammkennworts finden Sie unter Verwalten von Benutzern, SSH und Überprüfen oder Reparieren von Datenträgern auf Azure Linux-VMs mithilfe der VMAccess-Erweiterung.
adminUsername

string

Gibt den Namen des Administratorkontos an.

Diese Eigenschaft kann nicht aktualisiert werden, nachdem die VM erstellt wurde.

Einschränkung nur für Windows: Kann nicht auf "" enden.

Unzulässige Werte: "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".

Mindestlänge (Linux): 1 Zeichen

Maximale Länge (Linux): 64 Zeichen

Maximale Länge (Windows): 20 Zeichen.
allowExtensionOperations

boolean

Gibt an, ob Erweiterungsvorgänge auf dem virtuellen Computer zulässig sein sollen. Dies kann nur dann auf False festgelegt werden, wenn keine Erweiterungen auf dem virtuellen Computer vorhanden sind.
computerName

string

Gibt den Hostnamennamen des virtuellen Computers an. Dieser Name kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Maximale Länge (Windows): 15 Zeichen. Maximale Länge (Linux): 64 Zeichen. Benennungskonventionen und -einschränkungen finden Sie unter Implementierungsrichtlinien für Azure-Infrastrukturdienste.
customData

string

Gibt eine Base-64-codierte Zeichenfolge benutzerdefinierter Daten an. Die Base-64-codierte Zeichenfolge wird in ein binäres Array decodiert, das auf dem virtuellen Computer als Datei gespeichert wird. Die maximale Länge des binären Arrays beträgt 65535 Bytes. Hinweis: Übergeben Sie keine Geheimnisse oder Kennwörter in der customData-Eigenschaft. Diese Eigenschaft kann nicht aktualisiert werden, nachdem die VM erstellt wurde. Die Eigenschaft "customData" wird an den virtuellen Computer übergeben, der als Datei gespeichert werden soll. Weitere Informationen finden Sie unter Benutzerdefinierte Daten auf azure-VMs. Informationen zur Verwendung von cloud-init für Ihre Linux-VM finden Sie unter Verwenden von cloud-init zum Anpassen einer Linux-VM während der Erstellung.
linuxConfiguration

LinuxConfiguration

Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux auf Azure-Endorsed Distributionen.
requireGuestProvisionSignal

boolean

Optionale Eigenschaft, die entweder auf True festgelegt oder ausgelassen werden muss.
secrets

VaultSecretGroup[]

Gibt eine Gruppe von Zertifikaten an, die auf dem virtuellen Computer installiert werden sollen. Zum Installieren von Zertifikaten auf einem virtuellen Computer wird empfohlen, die Azure Key Vault-VM-Erweiterung für Linux oder die Azure Key Vault Vm-Erweiterung für Windows zu verwenden.
windowsConfiguration

WindowsConfiguration

Gibt die Einstellungen des Windows-Betriebssystems auf dem virtuellen Computer an.

PassNames

Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.

Name Typ Beschreibung
OobeSystem

string

PatchOperationStatus

Der gesamte Erfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unknown", "Failed", "Succeeded" oder "CompletedWithWarnings".

Name Typ Beschreibung
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

PatchSettings

[Vorschaufunktion] Gibt Einstellungen im Zusammenhang mit vm-Gastpatches unter Windows an.

Name Typ Beschreibung
assessmentMode

WindowsPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform in VM-Gastpatches unter Windows an.
enableHotpatching

boolean

Ermöglicht Es Kunden, ihre Azure-VMs zu patchen, ohne dass ein Neustart erforderlich ist. Für enableHotpatching muss "provisionVMAgent" auf true und "patchMode" auf "AutomaticByPlatform" festgelegt werden.
patchMode

WindowsVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

Manuell : Sie steuern die Anwendung von Patches auf einem virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss false sein.

AutomaticByOS : Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss true sein.

AutomaticByPlatform : Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.

Plan

Gibt Informationen zum Marketplace-Image an, das zum Erstellen des virtuellen Computers verwendet wird. Dieses Element wird nur für Marketplace-Images verwendet. Bevor Sie ein Marketplace-Image über eine API verwenden können, müssen Sie das Image für die programmgesteuerte Verwendung aktivieren. Suchen Sie im Azure-Portal nach dem Marketplace-Image, das Sie verwenden möchten, und klicken Sie dann auf Programmgesteuerte Bereitstellung, Erste Schritte ->. Geben Sie alle erforderlichen Informationen ein, und klicken Sie dann auf Speichern.

Name Typ Beschreibung
name

string

Die Plan-ID.
product

string

Gibt das Produkt des Images aus dem Marketplace an. Dies ist der gleiche Wert wie Offer unter dem imageReference-Element.
promotionCode

string

Der Promotionscode.
publisher

string

Die Herausgeber-ID.

ProtocolTypes

Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.

Name Typ Beschreibung
Http

string

Https

string

ProxyAgentSettings

Gibt beim Erstellen des virtuellen Computers ProxyAgent-Einstellungen an. Api-Mindestversion: 2024-03-01.

Name Typ Beschreibung
enabled

boolean

Gibt an, ob das ProxyAgent-Feature auf dem virtuellen Computer oder auf der VM-Skalierungsgruppe aktiviert werden soll.
keyIncarnationId

integer

Erhöhen Des Werts dieser Eigenschaft ermöglicht es dem Benutzer, den Schlüssel zurückzusetzen, der zum Schützen des Kommunikationskanals zwischen Gast und Host verwendet wird.
mode

Mode

Gibt den Modus an, in dem ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während er im Erzwingungsmodus die Zugriffssteuerung erzwingt. Der Standardwert ist Erzwingungsmodus.

PublicIPAddressSku

Beschreibt die öffentliche IP-SKU. Er kann nur mit OrchestrationMode als Flexibel festgelegt werden.

Name Typ Beschreibung
name

PublicIPAddressSkuName

Angeben des Namens der öffentlichen IP-SKU
tier

PublicIPAddressSkuTier

Angeben der SKU-Ebene für öffentliche IP-Adressen

PublicIPAddressSkuName

Angeben des Namens der öffentlichen IP-SKU

Name Typ Beschreibung
Basic

string

Standard

string

PublicIPAddressSkuTier

Angeben der SKU-Ebene für öffentliche IP-Adressen

Name Typ Beschreibung
Global

string

Regional

string

PublicIPAllocationMethod

Angeben des Öffentlichen IP-Zuordnungstyps

Name Typ Beschreibung
Dynamic

string

Static

string

ResourceIdentityType

Der Identitätstyp, der für den virtuellen Computer verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten vom virtuellen Computer.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ScheduledEventsAdditionalPublishingTargets

Die Konfigurationsparameter, die beim Veröffentlichen von scheduledEventsAdditionalPublishingTargets verwendet werden.

Name Typ Beschreibung
eventGridAndResourceGraph

EventGridAndResourceGraph

Die Konfigurationsparameter, die beim Erstellen der Einstellung eventGridAndResourceGraph Scheduled Event verwendet werden.

ScheduledEventsPolicy

Gibt Redeploy, Reboot und ScheduledEventsAdditionalPublishingTargets Scheduled Event related konfigurationen für den virtuellen Computer an.

Name Typ Beschreibung
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

Die Konfigurationsparameter, die beim Veröffentlichen von scheduledEventsAdditionalPublishingTargets verwendet werden.
userInitiatedReboot

UserInitiatedReboot

Die Konfigurationsparameter, die beim Erstellen von geplanten UserInitiatedReboot-Ereigniseinstellungen verwendet werden.
userInitiatedRedeploy

UserInitiatedRedeploy

Die Konfigurationsparameter, die beim Erstellen von "userInitiatedRedeploy scheduled event setting" verwendet werden.

ScheduledEventsProfile

Gibt konfigurationen für geplante Ereignisse an.

Name Typ Beschreibung
osImageNotificationProfile

OSImageNotificationProfile

Gibt konfigurationen für geplantes Betriebssystemimageereignis an.
terminateNotificationProfile

TerminateNotificationProfile

Gibt Konfigurationen für geplante Ereignisse beenden an.

securityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.

Name Typ Beschreibung
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer an.

Name Typ Beschreibung
encryptionAtHost

boolean

Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die VM-Skalierungsgruppe zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger aktiviert, einschließlich ressourcen-/temporärer Datenträger auf dem Host selbst. Das Standardverhalten lautet: Die Verschlüsselung auf dem Host wird deaktiviert, es sei denn, diese Eigenschaft ist für die Ressource auf true festgelegt.
encryptionIdentity

EncryptionIdentity

Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für keyvault-Vorgänge verwendet wird.
proxyAgentSettings

ProxyAgentSettings

Gibt beim Erstellen des virtuellen Computers ProxyAgent-Einstellungen an. Api-Mindestversion: 2024-03-01.
securityType

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.
uefiSettings

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Api-Mindestversion: 2020-12-01.

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.

Name Typ Beschreibung
ConfidentialVM

string

TrustedLaunch

string

SettingNames

Gibt den Namen der Einstellung an, auf die sich der Inhalt bezieht. Mögliche Werte sind: FirstLogonCommands und AutoLogon.

Name Typ Beschreibung
AutoLogon

string

FirstLogonCommands

string

SshConfiguration

Gibt die SSH-Schlüsselkonfiguration für ein Linux-Betriebssystem an.

Name Typ Beschreibung
publicKeys

SshPublicKey[]

Die Liste der öffentlichen SSH-Schlüssel, die für die Authentifizierung bei linuxbasierten VMs verwendet werden.

SshPublicKey

Die Liste der öffentlichen SSH-Schlüssel, die für die Authentifizierung bei linuxbasierten VMs verwendet werden.

Name Typ Beschreibung
keyData

string

Öffentliches SSH-Schlüsselzertifikat, das für die Authentifizierung bei der VM über SSH verwendet wird. Der Schlüssel muss mindestens 2048 Bit und im ssh-rsa-Format vorliegen. Informationen zum Erstellen von SSH-Schlüsseln finden Sie unter [Erstellen von SSH-Schlüsseln unter Linux und Mac für Linux-VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path

string

Gibt den vollständigen Pfad auf der erstellten VM an, in der der öffentliche SSH-Schlüssel gespeichert wird. Wenn die Datei bereits vorhanden ist, wird der angegebene Schlüssel an die Datei angefügt. Beispiel: /home/user/.ssh/authorized_keys

StatusLevelTypes

Der Ebenencode.

Name Typ Beschreibung
Error

string

Info

string

Warning

string

StorageAccountTypes

Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.

Name Typ Beschreibung
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

StorageProfile

Legt die Speichereinstellungen für die Datenträger des virtuellen Computers fest.

Name Typ Beschreibung
dataDisks

DataDisk[]

Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
diskControllerType

DiskControllerTypes

Gibt den Datenträgercontrollertyp an, der für den virtuellen Computer konfiguriert ist. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird und "hyperVGeneration" auf V2 festgelegt ist, basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe der angegebenen Mindestversion der API. Sie müssen die Zuordnung des virtuellen Computers vor dem Aktualisieren des Datenträgercontrollertyps behandeln, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, die implizit zuordnungs- und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.
imageReference

ImageReference

Gibt Informationen zum zu verwendenden Image an. Sie können Informationen zu Plattformimages, Marketplace-Images oder Vm-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, aber nicht in anderen Erstellungsvorgängen verwendet wird.
osDisk

OSDisk

Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

SubResource

Die relative URL der Key Vault, die das Geheimnis enthält.

Name Typ Beschreibung
id

string

Ressourcen-ID

TerminateNotificationProfile

Gibt Konfigurationen im Zusammenhang mit geplanten Terminereignissen an.

Name Typ Beschreibung
enable

boolean

Gibt an, ob das Terminierungsereignis "Scheduled" aktiviert oder deaktiviert ist.
notBeforeTimeout

string

Die konfigurierbare Dauer, für die ein virtueller Computer gelöscht wird, muss möglicherweise das geplante Terminereignis genehmigen, bevor das Ereignis automatisch genehmigt wird (Timeout). Die Konfiguration muss im ISO 8601-Format angegeben werden, der Standardwert ist 5 Minuten (PT5M).

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Api-Mindestversion: 2020-12-01.

Name Typ Beschreibung
secureBootEnabled

boolean

Gibt an, ob der sichere Start auf dem virtuellen Computer aktiviert werden soll. Api-Mindestversion: 2020-12-01.
vTpmEnabled

boolean

Gibt an, ob vTPM auf dem virtuellen Computer aktiviert werden soll. Api-Mindestversion: 2020-12-01.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem virtuellen Computer zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name Typ Beschreibung

UserInitiatedReboot

Die Konfigurationsparameter, die beim Erstellen von geplanten UserInitiatedReboot-Ereigniseinstellungen verwendet werden.

Name Typ Beschreibung
automaticallyApprove

boolean

Gibt Konfigurationen für geplante Ereignisse für neustarten an.

UserInitiatedRedeploy

Die Konfigurationsparameter, die beim Erstellen von "userInitiatedRedeploy scheduled event setting" verwendet werden.

Name Typ Beschreibung
automaticallyApprove

boolean

Gibt Konfigurationen für geplante Ereignisse erneut bereitstellen an.

VaultCertificate

Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten.

Name Typ Beschreibung
certificateStore

string

Gibt für Windows-VMs den Zertifikatspeicher auf dem virtuellen Computer an, dem das Zertifikat hinzugefügt werden soll. Der angegebene Zertifikatspeicher befindet sich implizit im LocalMachine-Konto. Bei Linux-VMs wird die Zertifikatdatei unter dem Verzeichnis /var/lib/waagent mit dem Dateinamen <UppercaseThumbprint.crt> für die X509-Zertifikatdatei und <UppercaseThumbprint.prv> für den privaten Schlüssel platziert. Beide Dateien sind PEM-formatiert.
certificateUrl

string

Dies ist die URL eines Zertifikats, das als Geheimnis in Key Vault hochgeladen wurde. Informationen zum Hinzufügen eines Geheimnisses zum Key Vault finden Sie unter Hinzufügen eines Schlüssels oder Geheimnisses zum Schlüsseltresor. In diesem Fall muss Ihr Zertifikat die Base64-Codierung des folgenden JSON-Objekts sein, das in UTF-8 codiert ist:

{
"data":"",
"dataType":"pfx",
"password":""
}
Zum Installieren von Zertifikaten auf einem virtuellen Computer wird empfohlen, die Azure Key Vault-VM-Erweiterung für Linux oder die Azure Key Vault-VM-Erweiterung für Windows zu verwenden.

VaultSecretGroup

Gibt eine Gruppe von Zertifikaten an, die auf dem virtuellen Computer installiert werden sollen. Zum Installieren von Zertifikaten auf einem virtuellen Computer wird empfohlen, die Azure Key Vault-VM-Erweiterung für Linux oder die Azure Key Vault Vm-Erweiterung für Windows zu verwenden.

Name Typ Beschreibung
sourceVault

SubResource

Die relative URL der Key Vault, die alle Zertifikate in VaultCertificates enthält.
vaultCertificates

VaultCertificate[]

Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten.

VirtualHardDisk

Die virtuelle Festplatte.

Name Typ Beschreibung
uri

string

Gibt den URI der virtuellen Festplatte an.

VirtualMachine

Beschreibt einen virtuellen Computer.

Name Typ Beschreibung
etag

string

Etag ist eine Eigenschaft, die in Create/Update/Get Response der VM zurückgegeben wird, sodass der Kunde sie im Header bereitstellen kann, um optimistische Updates sicherzustellen.
extendedLocation

ExtendedLocation

Der erweiterte Speicherort des virtuellen Computers.
id

string

Ressourcen-ID
identity

VirtualMachineIdentity

Die Identität des virtuellen Computers, sofern konfiguriert.
location

string

Ressourcenspeicherort
managedBy

string

ManagedBy ist auf VMSS(VMSS) flex ARM resourceID festgelegt, wenn die VM Teil der VMSS ist. Diese Eigenschaft wird von der Plattform für die Optimierung des internen Löschens von Ressourcengruppen verwendet.
name

string

Ressourcenname
plan

Plan

Gibt Informationen zum Marketplace-Image an, das zum Erstellen des virtuellen Computers verwendet wird. Dieses Element wird nur für Marketplace-Images verwendet. Bevor Sie ein Marketplace-Image über eine API verwenden können, müssen Sie das Image für die programmgesteuerte Verwendung aktivieren. Suchen Sie im Azure-Portal nach dem Marketplace-Image, das Sie verwenden möchten, und klicken Sie dann auf Programmgesteuerte Bereitstellung, Erste Schritte ->. Geben Sie alle erforderlichen Informationen ein, und klicken Sie dann auf Speichern.
properties.additionalCapabilities

AdditionalCapabilities

Gibt zusätzliche Funktionen an, die auf dem virtuellen Computer aktiviert oder deaktiviert sind.
properties.applicationProfile

ApplicationProfile

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.
properties.availabilitySet

SubResource

Gibt Informationen zur Verfügbarkeitsgruppe an, der der virtuelle Computer zugewiesen werden soll. Die virtuellen Computern, die in derselben Verfügbarkeitsgruppe angegeben werden, sind verschiedenen Knoten zugeordnet, um die Verfügbarkeit zu maximieren. Weitere Informationen zu Verfügbarkeitsgruppen finden Sie unter Übersicht über Verfügbarkeitssätze. Weitere Informationen zur geplanten Azure-Wartung finden Sie unter Wartung und Updates für Virtual Machines in Azure. Derzeit kann eine VM nur zur Erstellungszeit der Verfügbarkeitsgruppe hinzugefügt werden. Der Verfügbarkeitssatz, dem die VM hinzugefügt wird, sollte sich unter derselben Ressourcengruppe wie die Verfügbarkeitsgruppenressource befinden. Eine vorhandene VM kann nicht zu einer Verfügbarkeitsgruppe hinzugefügt werden. Diese Eigenschaft kann nicht zusammen mit einem Nicht-NULL-Properties.virtualMachineScaleSet-Verweis vorhanden sein.
properties.billingProfile

BillingProfile

Gibt die Abrechnungsdetails eines virtuellen Azure Spot-Computers an. Api-Mindestversion: 2019-03-01.
properties.capacityReservation

CapacityReservationProfile

Gibt Informationen zur Kapazitätsreservierung an, die zum Zuweisen virtueller Computer verwendet wird. Api-Mindestversion: 2021-04-01.
properties.diagnosticsProfile

DiagnosticsProfile

Gibt den Status der Startdiagnoseeinstellungen an. Api-Mindestversion: 2015-06-15.
properties.evictionPolicy

VirtualMachineEvictionPolicyTypes

Gibt die Entfernungsrichtlinie für den virtuellen Azure Spot-Computer und die Azure Spot-Skalierungsgruppe an. Für virtuelle Azure Spot-Computer werden sowohl "Deallocate" als auch "Delete" unterstützt, und die API-Mindestversion ist 2019-03-01. Für Azure Spot-Skalierungsgruppen werden sowohl "Deallocate" als auch "Delete" unterstützt, und die API-Mindestversion ist 2017-10-30-preview.
properties.extensionsTimeBudget

string

Gibt die Zeit an, die für den Start aller Erweiterungen zugewiesen wird. Die Zeitdauer sollte zwischen 15 Minuten und 120 Minuten (einschließlich) liegen und im ISO 8601-Format angegeben werden. Der Standardwert ist 90 Minuten (PT1H30M). Api-Mindestversion: 2020-06-01.
properties.hardwareProfile

HardwareProfile

Legt die Hardwareeinstellungen für den virtuellen Computer fest.
properties.host

SubResource

Gibt Informationen zum dedizierten Host an, in dem sich der virtuelle Computer befindet. Api-Mindestversion: 2018-10-01.
properties.hostGroup

SubResource

Gibt Informationen zur dedizierten Hostgruppe an, in der sich der virtuelle Computer befindet. Hinweis: Der Benutzer kann keine Host- und HostGroup-Eigenschaften angeben. Api-Mindestversion: 2020-06-01.
properties.instanceView

VirtualMachineInstanceView

Der virtuelle Computer instance Ansicht.
properties.licenseType

string

Gibt an, dass das verwendete Image oder der verwendete Datenträger lokal lizenziert wurde.

Mögliche Werte für das Windows Server-Betriebssystem sind:

Windows_Client

Windows_Server

Mögliche Werte für das Linux Server-Betriebssystem sind:

RHEL_BYOS (für RHEL)

SLES_BYOS (für SUSE)

Weitere Informationen finden Sie unter Azure Hybrid Use Benefit for Windows Server

Azure-Hybridnutzungsvorteil für Linux Server

Api-Mindestversion: 2015-06-15
properties.networkProfile

NetworkProfile

Legt die Netzwerkschnittstellen des virtuellen Computers fest.
properties.osProfile

OSProfile

Gibt die Betriebssystemeinstellungen an, die beim Erstellen des virtuellen Computers verwendet werden. Einige der Einstellungen können nicht geändert werden, nachdem der virtuelle Computer bereitgestellt wurde.
properties.platformFaultDomain

integer

Gibt die logische Fehlerdomäne des Skalierungsgruppen an, in der der virtuelle Computer erstellt wird. Standardmäßig wird der virtuelle Computer automatisch einer Fehlerdomäne zugewiesen, die das Gleichgewicht zwischen den verfügbaren Fehlerdomänen am besten gewährleistet. Dies gilt nur, wenn die Eigenschaft "virtualMachineScaleSet" dieses virtuellen Computers festgelegt ist. Die VM-Skalierungsgruppe, auf die verwiesen wird, muss "platformFaultDomainCount" größer als 1 haben. Diese Eigenschaft kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Die Fehlerdomänenzuweisung kann in der Vm-Instanzansicht angezeigt werden. Api-Mindestversion: 2020‐12‐01.
properties.priority

VirtualMachinePriorityTypes

Gibt die Priorität für den virtuellen Computer an. Api-Mindestversion: 2019-03-01
properties.provisioningState

string

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.proximityPlacementGroup

SubResource

Gibt Informationen zur Näherungsplatzierungsgruppe an, der der virtuelle Computer zugewiesen werden soll. Api-Mindestversion: 2018-04-01.
properties.scheduledEventsPolicy

ScheduledEventsPolicy

Gibt Redeploy, Reboot und ScheduledEventsAdditionalPublishingTargets Scheduled Event related konfigurationen für den virtuellen Computer an.
properties.scheduledEventsProfile

ScheduledEventsProfile

Gibt konfigurationen für geplante Ereignisse an.
properties.securityProfile

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer an.
properties.storageProfile

StorageProfile

Legt die Speichereinstellungen für die Datenträger des virtuellen Computers fest.
properties.timeCreated

string

Gibt den Zeitpunkt an, zu dem die VM-Ressource erstellt wurde. Api-Mindestversion: 2021-11-01.
properties.userData

string

UserData für den virtuellen Computer, der Base64-codiert sein muss. Der Kunde sollte hier keine Geheimnisse weitergeben. Api-Mindestversion: 2021-03-01.
properties.virtualMachineScaleSet

SubResource

Gibt Informationen zur VM-Skalierungsgruppe an, der der virtuelle Computer zugewiesen werden soll. Virtuelle Computer, die in derselben VM-Skalierungsgruppe angegeben sind, werden verschiedenen Knoten zugeordnet, um die Verfügbarkeit zu maximieren. Derzeit kann ein virtueller Computer nur zur Erstellungszeit der VM-Skalierungsgruppe hinzugefügt werden. Eine vorhandene VM kann nicht zu einer VM-Skalierungsgruppe hinzugefügt werden. Diese Eigenschaft kann nicht zusammen mit einem Properties.availabilitySet-Verweis ohne NULL vorhanden sein. Api-Mindestversion: 2019‐03‐01.
properties.vmId

string

Gibt die eindeutige VM-ID an, bei der es sich um einen 128-Bit-Bezeichner handelt, der in allen Azure IaaS-VMs SMBIOS codiert und gespeichert ist und mithilfe von Plattform-BIOS-Befehlen gelesen werden kann.
resources

VirtualMachineExtension[]

Die ressourcen der untergeordneten VM-Erweiterung.
tags

object

Ressourcentags
type

string

Ressourcentyp
zones

string[]

Die Zonen des virtuellen Computers.

VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.

Name Typ Beschreibung
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Der VM-Erweiterungshandler instance Ansicht.
statuses

InstanceViewStatus[]

Die Ressource status Informationen.
vmAgentVersion

string

Die Vollversion des VM-Agents.

VirtualMachineEvictionPolicyTypes

Gibt die Entfernungsrichtlinie für den virtuellen Azure Spot-Computer und die Azure Spot-Skalierungsgruppe an. Für virtuelle Azure Spot-Computer werden sowohl "Zuordnung aufheben" als auch "Löschen" unterstützt, und die API-Mindestversion ist 2019-03-01. Für Azure Spot-Skalierungsgruppen werden sowohl "Zuordnung aufheben" als auch "Löschen" unterstützt, und die API-Mindestversion ist 2017-10-30-preview.

Name Typ Beschreibung
Deallocate

string

Delete

string

VirtualMachineExtension

Die ressourcen der untergeordneten VM-Erweiterung.

Name Typ Beschreibung
id

string

Ressourcen-ID
location

string

Ressourcenspeicherort
name

string

Ressourcenname
properties.autoUpgradeMinorVersion

boolean

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist.
properties.enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.
properties.forceUpdateTag

string

Wie der Erweiterungshandler zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.
properties.instanceView

VirtualMachineExtensionInstanceView

Die VM-Erweiterung instance Ansicht.
properties.protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder überhaupt keine geschützten Einstellungen enthalten.
properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und aus dem Schlüsseltresor verwendet werden
properties.provisionAfterExtensions

string[]

Auflistung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.
properties.provisioningState

string

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.publisher

string

Der Name des Erweiterungshandlerherausgebers.
properties.settings

object

Json-formatierte öffentliche Einstellungen für die Erweiterung.
properties.suppressFailures

boolean

Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, werden unabhängig von diesem Wert nicht unterdrückt). Die Standardeinstellung ist „false“.
properties.type

string

Gibt den Typ der Erweiterung an. ein Beispiel ist "CustomScriptExtension".
properties.typeHandlerVersion

string

Gibt die Version des Skripthandlers an.
tags

object

Ressourcentags
type

string

Ressourcentyp

VirtualMachineExtensionHandlerInstanceView

Der Vm-Erweiterungshandler instance Ansicht.

Name Typ Beschreibung
status

InstanceViewStatus

Der Erweiterungshandler status.
type

string

Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

VirtualMachineExtensionInstanceView

Die VM-Erweiterung instance Ansicht.

Name Typ Beschreibung
name

string

Der Name der VM-Erweiterung.
statuses

InstanceViewStatus[]

Die Ressource status Informationen.
substatuses

InstanceViewStatus[]

Die Ressource status Informationen.
type

string

Gibt den Typ der Erweiterung an. ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

VirtualMachineHealthStatus

Die Integrität status für den virtuellen Computer.

Name Typ Beschreibung
status

InstanceViewStatus

Die Integrität status Informationen für den virtuellen Computer.

VirtualMachineIdentity

Die Identität des virtuellen Computers, sofern konfiguriert.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Identität virtueller Computer. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId

string

Die Mandanten-ID, die dem virtuellen Computer zugeordnet ist. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type

ResourceIdentityType

Der Identitätstyp, der für den virtuellen Computer verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten vom virtuellen Computer.
userAssignedIdentities

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem virtuellen Computer zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

VirtualMachineInstanceView

Der virtuelle Computer instance Ansicht.

Name Typ Beschreibung
assignedHost

string

Ressourcen-ID des dedizierten Hosts, auf dem der virtuelle Computer durch automatische Platzierung zugewiesen wird, wenn der virtuelle Computer einer dedizierten Hostgruppe zugeordnet ist, für die die automatische Platzierung aktiviert ist. Api-Mindestversion: 2020-06-01.
bootDiagnostics

BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.
computerName

string

Der Computername, der dem virtuellen Computer zugewiesen ist.
disks

DiskInstanceView[]

Die Datenträgerinformationen des virtuellen Computers.
extensions

VirtualMachineExtensionInstanceView[]

Die Erweiterungsinformationen.
hyperVGeneration

HyperVGenerationType

Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist
isVMInStandbyPool

boolean

[Vorschaufeature] Gibt an, ob sich der virtuelle Computer derzeit im Standbypool befindet oder nicht.
maintenanceRedeployStatus

MaintenanceRedeployStatus

Der Wartungsvorgang status auf dem virtuellen Computer.
osName

string

Das Betriebssystem, das auf dem virtuellen Computer ausgeführt wird.
osVersion

string

Die Version des Betriebssystems, das auf dem virtuellen Computer ausgeführt wird.
patchStatus

VirtualMachinePatchStatus

[Vorschaufeature] Die status von Vm-Patchvorgängen.
platformFaultDomain

integer

Gibt die Fehlerdomäne des virtuellen Computers an.
platformUpdateDomain

integer

Gibt die Updatedomäne des virtuellen Computers an.
rdpThumbPrint

string

Der Remotedesktopzertifikatfingerabdruck.
statuses

InstanceViewStatus[]

Die Ressource status Informationen.
vmAgent

VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
vmHealth

VirtualMachineHealthStatus

Die Integritäts-status für den virtuellen Computer.

VirtualMachineIpTag

Die Liste der IP-Tags, die der öffentlichen IP-Adresse zugeordnet sind.

Name Typ Beschreibung
ipTagType

string

IP-Tagtyp. Beispiel: FirstPartyUsage.
tag

string

Der öffentlichen IP-Adresse zugeordnetes IP-Tag. Beispiel: SQL, Storage usw.

VirtualMachineNetworkInterfaceConfiguration

Gibt die Netzwerkkonfigurationen an, die zum Erstellen der Netzwerkressourcen des virtuellen Computers verwendet werden.

Name Typ Beschreibung
name

string

Der Name der Netzwerkschnittstellenkonfiguration.
properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

Gibt an, ob der Hilfsmodus für die Netzwerkschnittstellenressource aktiviert ist.
properties.auxiliarySku

NetworkInterfaceAuxiliarySku

Gibt an, ob die Hilfssku für die Netzwerkschnittstellenressource aktiviert ist.
properties.deleteOption

DeleteOptions

Geben Sie an, was mit der Netzwerkschnittstelle geschieht, wenn der virtuelle Computer gelöscht wird.
properties.disableTcpStateTracking

boolean

Gibt an, ob die Netzwerkschnittstelle für die TCP-Zustandsnachverfolgung deaktiviert ist.
properties.dnsSettings

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die Netzwerkschnittstellen angewendet werden sollen.
properties.dscpConfiguration

SubResource

properties.enableAcceleratedNetworking

boolean

Gibt an, ob die Netzwerkschnittstelle netzwerkbeschleunigt ist.
properties.enableFpga

boolean

Gibt an, ob die Netzwerkschnittstelle FPGA-netzwerkfähig ist.
properties.enableIPForwarding

boolean

Gibt an, ob die IP-Weiterleitung für diese NIC aktiviert ist.
properties.ipConfigurations

VirtualMachineNetworkInterfaceIPConfiguration[]

Gibt die IP-Konfigurationen der Netzwerkschnittstelle an.
properties.networkSecurityGroup

SubResource

Die Netzwerksicherheitsgruppe.
properties.primary

boolean

Gibt die primäre Netzwerkschnittstelle an, falls der virtuelle Computer über mehr als 1 Netzwerkschnittstelle verfügt.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die Netzwerkschnittstellen angewendet werden sollen.

Name Typ Beschreibung
dnsServers

string[]

Liste der IP-Adressen von DNS-Servern

VirtualMachineNetworkInterfaceIPConfiguration

Gibt die IP-Konfigurationen der Netzwerkschnittstelle an.

Name Typ Beschreibung
name

string

Der NAME der IP-Konfiguration.
properties.applicationGatewayBackendAddressPools

SubResource[]

Gibt ein Array von Verweisen auf Back-End-Adresspools von Anwendungsgateways an. Ein virtueller Computer kann auf Back-End-Adresspools mehrerer Anwendungsgateways verweisen. Mehrere virtuelle Computer können nicht dasselbe Anwendungsgateway verwenden.
properties.applicationSecurityGroups

SubResource[]

Gibt ein Array von Verweisen auf die Anwendungssicherheitsgruppe an.
properties.loadBalancerBackendAddressPools

SubResource[]

Gibt ein Array von Verweisen auf Back-End-Adresspools von Lastenausgleichsmodulen an. Ein virtueller Computer kann auf Back-End-Adresspools eines öffentlichen und eines internen Lastenausgleichs verweisen. [Mehrere virtuelle Computer können nicht denselben Lastenausgleich für basic-SKU verwenden].
properties.primary

boolean

Gibt die primäre Netzwerkschnittstelle an, falls der virtuelle Computer über mehr als 1 Netzwerkschnittstelle verfügt.
properties.privateIPAddressVersion

IPVersions

Sie ist ab Api-Version 30.03.2017 verfügbar und gibt an, ob die spezifische ipconfiguration IPv4 oder IPv6 ist. Der Standardwert wird als IPv4 verwendet. Mögliche Werte sind: "IPv4" und "IPv6".
properties.publicIPAddressConfiguration

VirtualMachinePublicIPAddressConfiguration

Die publicIPAddressConfiguration.
properties.subnet

SubResource

Gibt den Bezeichner des Subnetzes an.

VirtualMachinePatchStatus

[Vorschaufunktion] Die status von Vm-Patchvorgängen.

Name Typ Beschreibung
availablePatchSummary

AvailablePatchSummary

Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
configurationStatuses

InstanceViewStatus[]

Die aktivierungs-status des angegebenen patchMode
lastPatchInstallationSummary

LastPatchInstallationSummary

Die Installationszusammenfassung des letzten Installationsvorgangs für den virtuellen Computer.

VirtualMachinePriorityTypes

Gibt die Priorität für den virtuellen Computer an. Api-Mindestversion: 2019-03-01

Name Typ Beschreibung
Low

string

Regular

string

Spot

string

VirtualMachinePublicIPAddressConfiguration

Die publicIPAddressConfiguration.

Name Typ Beschreibung
name

string

Der Name der publicIP-Adresskonfiguration.
properties.deleteOption

DeleteOptions

Angeben, was mit der öffentlichen IP-Adresse geschieht, wenn die VM gelöscht wird
properties.dnsSettings

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die publicIP-Adressen angewendet werden sollen.
properties.idleTimeoutInMinutes

integer

Das Leerlauftimeout der öffentlichen IP-Adresse.
properties.ipTags

VirtualMachineIpTag[]

Die Liste der IP-Tags, die der öffentlichen IP-Adresse zugeordnet sind.
properties.publicIPAddressVersion

IPVersions

Sie ist ab Api-Version 01.07.2019 verfügbar und gibt an, ob die spezifische ipconfiguration IPv4 oder IPv6 ist. Der Standardwert wird als IPv4 verwendet. Mögliche Werte sind: "IPv4" und "IPv6".
properties.publicIPAllocationMethod

PublicIPAllocationMethod

Angeben des Öffentlichen IP-Zuordnungstyps
properties.publicIPPrefix

SubResource

Das PublicIPPrefix, aus dem publicIP-Adressen zugeordnet werden sollen.
sku

PublicIPAddressSku

Beschreibt die öffentliche IP-SKU. Er kann nur mit OrchestrationMode als Flexibel festgelegt werden.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Die DNS-Einstellungen, die auf die publicIP-Adressen angewendet werden sollen.

Name Typ Beschreibung
domainNameLabel

string

Das Präfix der Domänennamenbezeichnung der PublicIPAddress-Ressourcen, die erstellt werden. Die generierte Namensbezeichnung ist die Verkettung der Domänennamenbezeichnung und der eindeutigen ID des VM-Netzwerkprofils.
domainNameLabelScope

DomainNameLabelScopeTypes

Der Domänennamensbezeichnungsbereich der PublicIPAddress-Ressourcen, die erstellt werden. Die generierte Namensbezeichnung ist die Verkettung der Hash-Domänennamenbezeichnung mit der Richtlinie gemäß dem Domänennamensbezeichnungsbereich und der eindeutigen ID des VM-Netzwerkprofils.

VirtualMachineSizeTypes

Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung der folgenden APIs: Auflisten aller verfügbaren VM-Größen in einer Verfügbarkeitsgruppe, Auflisten aller verfügbaren VM-Größen in einer Region, Auflisten aller verfügbaren VM-Größen zum Ändern der Größe. Weitere Informationen zu VM-Größen finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen hängen von der Region und der Verfügbarkeitsgruppe ab.

Name Typ Beschreibung
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

Gibt das Sicherheitsprofil für den verwalteten Datenträger an.

Name Typ Beschreibung
diskEncryptionSet

DiskEncryptionSetParameters

Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an, der für vom Kunden verwaltete Schlüssel verschlüsselte ConfidentialVM-Betriebssystemdatenträger und VMGuest-Blobs verwendet wird.
securityEncryptionType

securityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.

VMGalleryApplication

Gibt die Kataloganwendungen an, die für die VM/VMSS zur Verfügung gestellt werden sollen.

Name Typ Beschreibung
configurationReference

string

Optional: Gibt den URI für ein Azure-Blob an, das die Standardkonfiguration für das Paket ersetzt, sofern angegeben.
enableAutomaticUpgrade

boolean

Wenn auf TRUE festgelegt ist, wird eine neue Kataloganwendungsversion in PIR/SIG automatisch für die VM/VMSS aktualisiert.
order

integer

Optional, Gibt die Reihenfolge an, in der die Pakete installiert werden müssen.
packageReferenceId

string

Gibt die GalleryApplicationVersion-Ressourcen-ID im Format /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} an.
tags

string

Optional: Gibt einen Passthroughwert für einen generischeren Kontext an.
treatFailureAsDeploymentFailure

boolean

Optional: Falls true, tritt bei jedem Fehler für einen Beliebigen Vorgang in der VmApplication ein Fehler bei der Bereitstellung auf.

VMSizeProperties

Gibt die Eigenschaften zum Anpassen der Größe des virtuellen Computers an. Api-Mindestversion: 2021-07-01. Dieses Feature befindet sich weiterhin im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. Weitere Informationen finden Sie in den Anweisungen unter Vm-Anpassung .

Name Typ Beschreibung
vCPUsAvailable

integer

Gibt die Anzahl der für den virtuellen Computer verfügbaren vCPUs an. Wenn diese Eigenschaft nicht im Anforderungstext angegeben wird, wird sie standardmäßig auf den Wert der vCPUs festgelegt, die für diese VM-Größe verfügbar sind, die in der API-Antwort von List all available virtual machine size in a region verfügbar sind.
vCPUsPerCore

integer

Gibt das Verhältnis von vCPU zu physischem Kern an. Wenn diese Eigenschaft im Anforderungstext nicht angegeben ist, wird das Standardverhalten auf den Wert von vCPUsPerCore für die VM-Größe festgelegt, die in der API-Antwort von List all available virtual machine size in a region verfügbar ist. Das Festlegen dieser Eigenschaft auf 1 bedeutet auch, dass Hyperthreading deaktiviert ist.

WindowsConfiguration

Gibt die Einstellungen des Windows-Betriebssystems auf dem virtuellen Computer an.

Name Typ Beschreibung
additionalUnattendContent

AdditionalUnattendContent[]

Gibt zusätzliche Base-64-codierte Informationen im XML-Format an, die in die von Windows Setup verwendete Datei Unattend.xml eingeschlossen werden können.
enableAutomaticUpdates

boolean

Gibt an, ob automatische Updates für den virtuellen Windows-Computer aktiviert ist. Der Standardwert ist true. Für VM-Skalierungsgruppen kann diese Eigenschaft aktualisiert werden, und Updates werden auf die erneute Bereitstellung des Betriebssystems wirksam.
enableVMAgentPlatformUpdates

boolean

Gibt an, ob VMAgent Platform Updates für den virtuellen Windows-Computer aktiviert ist. Der Standardwert ist „false“.
patchSettings

PatchSettings

[Vorschaufeature] Gibt Einstellungen im Zusammenhang mit vm-Gastpatches unter Windows an.
provisionVMAgent

boolean

Gibt an, ob der VM-Agent auf dem virtuellen Computer bereitgestellt werden soll. Wenn diese Eigenschaft nicht im Anforderungstext angegeben ist, wird sie standardmäßig auf TRUE festgelegt. Dadurch wird sichergestellt, dass der VM-Agent auf dem virtuellen Computer installiert ist, sodass erweiterungen später dem virtuellen Computer hinzugefügt werden können.
timeZone

string

Gibt die Zeitzone des virtuellen Computers an. z.B. "Pacific Standard Time". Mögliche Werte können TimeZoneInfo.Id Wert aus Zeitzonen sein, die von TimeZoneInfo.GetSystemTimeZones zurückgegeben werden.
winRM

WinRMConfiguration

Gibt die Windows-Remoteverwaltungslistener an. Dadurch wird die Remoteverwendung von Windows PowerShell ermöglicht.

WindowsPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte:

ImageDefault : Sie steuern den Zeitpunkt von Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform : Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.

Name Typ Beschreibung
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

Name Typ Beschreibung
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform in VM-Gastpatches unter Windows an.

Name Typ Beschreibung
bypassPlatformSafetyChecksOnUserSchedule

boolean

Ermöglicht dem Kunden das Planen von Patches ohne versehentliche Upgrades.
rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

WindowsVMGuestPatchMode

Gibt den Modus des VM-Gastpatches auf virtuelle IaaS-Computer oder virtuelle Computer an, die einer VM-Skalierungsgruppe zugeordnet sind, mit OrchestrationMode als Flexible.

Mögliche Werte:

Manuell : Sie steuern die Anwendung von Patches auf einem virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss false sein.

AutomaticByOS : Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft WindowsConfiguration.enableAutomaticUpdates muss true sein.

AutomaticByPlatform : Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.

Name Typ Beschreibung
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

Gibt die Windows-Remoteverwaltungslistener an. Dadurch wird die Remoteverwendung von Windows PowerShell ermöglicht.

Name Typ Beschreibung
listeners

WinRMListener[]

Die Liste der Windows-Remoteverwaltungslistener

WinRMListener

Die Liste der Windows-Remoteverwaltungslistener

Name Typ Beschreibung
certificateUrl

string

Dies ist die URL eines Zertifikats, das als Geheimnis in Key Vault hochgeladen wurde. Informationen zum Hinzufügen eines Geheimnisses zum Key Vault finden Sie unter Hinzufügen eines Schlüssels oder Geheimnisses zum Schlüsseltresor. In diesem Fall muss ihr Zertifikat die Base64-Codierung des folgenden JSON-Objekts sein, das in UTF-8 codiert ist:

{
"data":"",
"dataType":"pfx",
"password":""
}
Zum Installieren von Zertifikaten auf einem virtuellen Computer wird empfohlen, die Azure Key Vault-VM-Erweiterung für Linux oder die Azure Key Vault-VM-Erweiterung für Windows zu verwenden.
protocol

ProtocolTypes

Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.