Virtual Machines - Create Or Update
A operação para criar ou atualizar uma máquina virtual. Por favor, note que algumas propriedades só podem ser definidas durante a criação de máquinas virtuais.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?api-version=2022-03-01
Parâmetros do URI
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
|
O nome do grupo de recursos. |
subscription
|
path | True |
|
Credenciais de subscrição que identificam exclusivamente Microsoft Azure subscrição. O ID de subscrição faz parte do URI para cada chamada de serviço. |
vm
|
path | True |
|
O nome da máquina virtual. |
api-version
|
query | True |
|
Versão Api do cliente. |
Corpo do Pedido
Name | Required | Type | Description |
---|---|---|---|
location | True |
|
Localização do recurso |
extendedLocation |
A localização alargada da Máquina Virtual. |
||
identity |
A identidade da máquina virtual, se configurada. |
||
plan |
Especifica informações sobre a imagem do mercado utilizada para criar a máquina virtual. Este elemento é utilizado apenas para imagens de mercado. Antes de utilizar uma imagem de mercado a partir de uma API, tem de ativar a imagem para uso programático. No portal do Azure, encontre a imagem de mercado que pretende utilizar e, em seguida, clique em "Querer implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar. |
||
properties.additionalCapabilities |
Especifica capacidades adicionais ativadas ou desativadas na máquina virtual. |
||
properties.applicationProfile |
Especifica as aplicações de galeria que devem ser disponibilizadas ao VM/VMSS |
||
properties.availabilitySet |
Especifica informações sobre o conjunto de disponibilidade a que a máquina virtual deve ser atribuída. As máquinas virtuais especificadas no mesmo conjunto de disponibilidade são atribuídas a diferentes nós para maximizar a disponibilidade. Para obter mais informações sobre os conjuntos de disponibilidade, consulte a visão geral dos conjuntos de disponibilidade. |
||
properties.billingProfile |
Especifica os detalhes relacionados com a faturação de uma máquina virtual Azure Spot. |
||
properties.capacityReservation |
Especifica informações sobre a reserva de capacidade que é usada para alocar máquina virtual. |
||
properties.diagnosticsProfile |
Especifica o estado das definições de diagnóstico da bota. |
||
properties.evictionPolicy |
Especifica a política de despejo para a máquina virtual Azure Spot e o conjunto de escala Azure Spot. |
||
properties.extensionsTimeBudget |
|
Especifica o tempo atribuído para todas as extensões começarem. A duração do tempo deve ser entre 15 minutos e 120 minutos (inclusive) e deve ser especificada no formato ISO 8601. O valor predefinido é de 90 minutos (PT1H30M). |
|
properties.hardwareProfile |
Especifica as definições de hardware para a máquina virtual. |
||
properties.host |
Especifica informações sobre o hospedeiro dedicado em que a máquina virtual reside. |
||
properties.hostGroup |
Especifica informações sobre o grupo de anfitriões dedicado em que a máquina virtual reside. |
||
properties.licenseType |
|
Especifica que a imagem ou disco que está a ser utilizado foi licenciado no local. |
|
properties.networkProfile |
Especifica as interfaces de rede da máquina virtual. |
||
properties.osProfile |
Especifica as definições do sistema operativo utilizadas durante a criação da máquina virtual. Algumas das definições não podem ser alteradas uma vez que o VM é a provisionado. |
||
properties.platformFaultDomain |
|
Especifica o domínio de falha lógica definido na escala em que a Máquina Virtual será criada. Por predefinição, a Máquina Virtual irá atribuir automaticamente a um domínio de avaria que melhor mantenha o equilíbrio entre domínios de avaria disponíveis. Versão mínima api‐‐12‐01 |
|
properties.priority |
Especifica a prioridade para a máquina virtual. |
||
properties.proximityPlacementGroup |
Especifica informações sobre o grupo de colocação de proximidade a que a máquina virtual deve ser atribuída. |
||
properties.scheduledEventsProfile |
Especifica configurações relacionadas com eventos programados. |
||
properties.securityProfile |
Especifica as definições de perfil relacionados com a Segurança para a máquina virtual. |
||
properties.storageProfile |
Especifica as definições de armazenamento dos discos de máquinas virtuais. |
||
properties.userData |
|
UserData para o VM, que deve ser codificado base-64. O cliente não deve passar segredos aqui. |
|
properties.virtualMachineScaleSet |
Especifica informações sobre o conjunto de escala de máquina virtual a que a máquina virtual deve ser atribuída. As máquinas virtuais especificadas no mesmo conjunto de escala de máquina virtual são atribuídas a diferentes nós para maximizar a disponibilidade. Atualmente, um VM só pode ser adicionado à escala de máquina virtual definida no tempo de criação. Um VM existente não pode ser adicionado a um conjunto de escala de máquina virtual. |
||
tags |
|
Etiquetas de recursos |
|
zones |
|
As zonas de máquinas virtuais. |
Respostas
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
201 Created |
Criado |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Segurança
azure_auth
Flow de Azure Ative Directory OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personificar a sua conta de utilizador |
Exemplos
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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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"
}
}
}
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
"properties": {
"primary": true
}
}
]
}
}
}
Sample Response
{
"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"
}
}
}
},
"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"
}
{
"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"
}
}
}
},
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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"
}
Create a VM from a community gallery image
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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"
}
Create a VM from a shared gallery image
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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 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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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 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=2022-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
{
"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"
}
{
"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 Resource disk using placement property.
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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 Scheduled Events Profile
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2022-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
}
},
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
}
}
}
}
Sample Response
{
"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"
},
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
}
},
"provisioningState": "Creating"
},
"name": "myVM",
"location": "westus"
}
{
"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"
},
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"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=2022-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
{
"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"
}
{
"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 Platform Managed Keys
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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"
}
}
}
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
"properties": {
"primary": true
}
}
]
}
}
}
Sample Response
{
"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"
}
}
}
},
"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"
}
{
"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"
}
}
}
},
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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=2022-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
{
"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"
}
{
"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"
}
Definições
Additional |
Ativa ou desativa uma capacidade na máquina virtual ou no conjunto de escala de máquina virtual. |
Additional |
Especifica informações adicionais formatadas com XML que podem ser incluídas no ficheiro Unattend.xml, que é usado por Windows Configuração. Os conteúdos são definidos pela definição do nome, nome do componente e do passe em que o conteúdo é aplicado. |
Api |
Erro da Api. |
Api |
Base de erro da Api. |
Application |
Contém a lista de aplicações de galeria que devem ser disponibilizadas ao VM/VMSS |
Available |
Descreve as propriedades de uma visualização de instância de máquina virtual para o resumo do patch disponível. |
Billing |
Especifica os detalhes relacionados com a faturação de um VM ou VMSS Azure Spot. |
Boot |
Boot Diagnostics é uma funcionalidade de depuragem que lhe permite visualizar a saída da consola e o Screenshot para diagnosticar o estado de VM. |
Boot |
A visão de um diagnóstico virtual de arranque de máquina. |
Caching |
Especifica os requisitos de caching. |
Capacity |
Os parâmetros de um perfil de reserva de capacidade. |
Cloud |
Uma resposta de erro do serviço Compute. |
Component |
O nome do componente. Atualmente, o único valor permitido é o Microsoft-Windows-Shell-Setup. |
Data |
Descreve um disco de dados. |
Delete |
Especificar o que acontece ao endereço IP público quando o VM é eliminado |
Diagnostics |
Especifica o estado das definições de diagnóstico da bota. |
Diff |
Especifica as definições do disco efémero para o disco do sistema operativo. |
Diff |
Especifica a colocação do disco efémero para o disco do sistema operativo. Esta propriedade pode ser utilizada pelo utilizador no pedido de escolha da localização, isto é, disco de cache ou espaço de disco de recursos para provisão de disco Efeméride. Para obter mais informações sobre os requisitos de tamanho do disco Ephemeral OS, consulte os requisitos de tamanho do disco Ephemeral PARA Windows VM em https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux VM emhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements |
Diff |
Descreve os parâmetros das definições efémeras do disco que podem ser especificados para o disco do sistema operativo. |
Disk |
Especifica como a máquina virtual deve ser criada. |
Disk |
Especifica se o disco de OS deve ser eliminado ou desconectado após a eliminação de VM. |
Disk |
Especifica o comportamento de desprendimento a ser utilizado durante a desprender um disco ou que já está em processo de desprendimento da máquina virtual. Valores suportados: ForceDetach. |
Disk |
Descreve o parâmetro do id de conjunto de encriptação de disco gerido pelo cliente que pode ser especificado para o disco. |
Disk |
Descreve um Definições de encriptação para um disco |
Disk |
A visão do disco. |
Extended |
O tipo complexo da localização estendida. |
Extended |
O tipo de localização estendida. |
Hardware |
Especifica as definições de hardware para a máquina virtual. |
Hyper |
Especifica o Tipo de HiperVGeneração associado a um recurso |
Image |
Especifica informações sobre a imagem a utilizar. Pode especificar informações sobre imagens da plataforma, imagens de marketplace ou imagens de máquinas virtuais. Este elemento é necessário quando pretender utilizar uma imagem de plataforma, imagem de marketplace ou imagem de máquina virtual, mas não é utilizado em outras operações de criação. NOTA: O editor de referência de imagem e a oferta só podem ser definidos quando se cria o conjunto de escala. |
Inner |
Detalhes de erro internos. |
Instance |
Estado da visualização de instância. |
IPVersions |
Disponível a partir de Api-Version 2019-07-01, representa se a configuração específica é IPv4 ou IPv6. O padrão é tomado como IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'. |
Key |
Descreve uma referência a Key Vault Chave |
Key |
Descreve uma referência a Key Vault Segredo |
Last |
Descreve as propriedades do último resumo do patch instalado. |
Linux |
Especifica as definições do sistema operativo Linux na máquina virtual. |
Linux |
Especifica o modo de Avaliação do Patch de Hóspedes VM para a máquina virtual IaaS. |
Linux |
Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux. |
Linux |
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform. |
Linux |
Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições de patch do Linux. |
Linux |
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível. |
Maintenance |
O último código de resultados da operação de manutenção. |
Maintenance |
Estado da Operação de Manutenção. |
Managed |
Os parâmetros de um disco gerido. |
Network |
especifica a versão API da Microsoft.Network utilizada na criação de recursos de rede nas Configurações de Interface de Rede |
Network |
Descreve uma referência de interface de rede. |
Network |
Especifica as interfaces de rede ou a configuração de rede da máquina virtual. |
Operating |
Esta propriedade permite especificar o tipo de SO que está incluído no disco se criar um VM a partir da imagem do utilizador ou de um VHD especializado. |
OSDisk |
Especifica informações sobre o disco do sistema operativo utilizado pela máquina virtual. |
OSProfile |
Especifica as definições do sistema operativo para a máquina virtual. Algumas das definições não podem ser alteradas uma vez que o VM é a provisionado. |
Pass |
O nome do passe. Atualmente, o único valor admissível é o OobeSystem. |
Patch |
O sucesso geral ou o estado de insucesso da operação. Permanece "InProgress" até que a operação esteja concluída. Nessa altura, tornar-se-á "Desconhecido", "Falhado", "Bem Sucedido", ou "Concluídos". |
Patch |
Especifica as definições relacionadas com o Patching de Hóspedes VM no Windows. |
Plan |
Especifica informações sobre a imagem do mercado utilizada para criar a máquina virtual. Este elemento é utilizado apenas para imagens de mercado. Antes de utilizar uma imagem de mercado a partir de uma API, tem de ativar a imagem para uso programático. No portal do Azure, encontre a imagem de mercado que pretende utilizar e, em seguida, clique em "Querer implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar. |
Protocol |
Especifica o protocolo do ouvinte winRM. |
Public |
Descreve o IP Sku público. Só pode ser definido com OrchestrationMode como Flexível. |
Public |
Especificar o nome de sku IP público |
Public |
Especificar o nível de sku IP público |
Public |
Especificar o tipo de atribuição de IP público |
Resource |
O tipo de identidade usada para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades da máquina virtual. |
Scheduled |
|
security |
Especifica oType de Encriptação do disco gerido. |
Security |
Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de escala de máquina virtual. |
Security |
Especifica o Dispositivo de Segurança da máquina virtual. Tem de ser definido para qualquer valor especificado para permitir a uefiSettings. |
Setting |
Especifica o nome da definição a que o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon. |
Ssh |
Configuração SSH para VMs baseados em Linux em execução em Azure |
Ssh |
Contém informações sobre a chave pública do certificado SSH e sobre o caminho no Linux VM onde a chave pública é colocada. |
Status |
O código de nível. |
Storage |
Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizados com discos de dados, não podem ser utilizados com disco OS. |
Storage |
Especifica as definições de armazenamento dos discos de máquinas virtuais. |
Sub |
|
Terminate |
|
Uefi |
Especifica as definições de segurança como arranque seguro e vTPM utilizados durante a criação da máquina virtual. |
User |
A lista de identidades de utilizador associadas à Máquina Virtual. As referências-chave do dicionário de identidade do utilizador serão ids de recursos ARM no formulário: '/subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Vault |
Descreve uma única referência de certificado num Key Vault e onde o certificado deve residir no VM. |
Vault |
Descreve um conjunto de certificados que estão todos na mesma Key Vault. |
Virtual |
Descreve o uri de um disco. |
Virtual |
Descreve uma máquina virtual. |
Virtual |
A visão do agente VM a funcionar na máquina virtual. |
Virtual |
Especifica a política de despejo para a máquina virtual Azure Spot e o conjunto de escala Azure Spot. |
Virtual |
Descreve uma extensão virtual da máquina. |
Virtual |
A visão de um manipulador de extensão de máquina virtual. |
Virtual |
A visão de uma extensão de máquina virtual. |
Virtual |
O estado de saúde do VM. |
Virtual |
Identidade para a máquina virtual. |
Virtual |
A visão de uma máquina virtual. |
Virtual |
Contém a etiqueta IP associada ao endereço IP público. |
Virtual |
Descreve configurações de interface de rede de máquinas virtuais. |
Virtual |
Descreve as definições de DNS de configuração de rede de máquinas virtuais. |
Virtual |
Descreve a configuração IP de um perfil de rede de máquina virtual. |
Virtual |
O estado das operações de correção de máquinas virtuais. |
Virtual |
Especifica a prioridade para a máquina virtual. |
Virtual |
Descreve uma configuração de endereço publicipad de configuração de máquinas virtuais ip |
Virtual |
Descreve as definições de DNS de configuração de rede de máquinas virtuais. |
Virtual |
Especifica o tamanho da máquina virtual. |
VMDisk |
Especifica as definições de perfil de segurança para o disco gerido. |
VMGallery |
Especifica as informações necessárias para fazer referência a uma versão de aplicação de galeria de computação |
VMSize |
Especifica as definições de propriedade do tamanho VM na máquina virtual. |
Windows |
Especifica Windows definições do sistema operativo na máquina virtual. |
Windows |
Especifica o modo de avaliação do patch do VM Guest para a máquina virtual IaaS. |
Windows |
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform. |
Windows |
Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições Windows patch. |
Windows |
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível. |
Win |
Descreve Windows configuração de Gestão Remota do VM |
Win |
Descreve o Protocolo e a impressão digital do ouvinte de gestão remota Windows |
AdditionalCapabilities
Ativa ou desativa uma capacidade na máquina virtual ou no conjunto de escala de máquina virtual.
Name | Type | Description |
---|---|---|
hibernationEnabled |
|
A bandeira que permite ou desativa a capacidade de hibernação no VM. |
ultraSSDEnabled |
|
A bandeira que permite ou desativa a capacidade de ter um ou mais discos de dados geridos com UltraSSD_LRS tipo de conta de armazenamento no VM ou VMSS. Os discos geridos com o tipo de conta de armazenamento UltraSSD_LRS só podem ser adicionados a uma máquina virtual ou à balança de máquinas virtuais se esta propriedade estiver ativada. |
AdditionalUnattendContent
Especifica informações adicionais formatadas com XML que podem ser incluídas no ficheiro Unattend.xml, que é usado por Windows Configuração. Os conteúdos são definidos pela definição do nome, nome do componente e do passe em que o conteúdo é aplicado.
Name | Type | Description |
---|---|---|
componentName |
O nome do componente. Atualmente, o único valor permitido é o Microsoft-Windows-Shell-Setup. |
|
content |
|
Especifica o conteúdo formatado XML que é adicionado ao ficheiro unattend.xml para o caminho e componente especificados. O XML deve ser inferior a 4KB e deve incluir o elemento de raiz para a definição ou característica que está a ser inserida. |
passName |
O nome do passe. Atualmente, o único valor admissível é o OobeSystem. |
|
settingName |
Especifica o nome da definição a que o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon. |
ApiError
Erro da Api.
Name | Type | Description |
---|---|---|
code |
|
O código de erro. |
details |
Os detalhes do erro da Api |
|
innererror |
O erro interno da Api |
|
message |
|
A mensagem de erro. |
target |
|
O alvo do erro particular. |
ApiErrorBase
Base de erro da Api.
Name | Type | Description |
---|---|---|
code |
|
O código de erro. |
message |
|
A mensagem de erro. |
target |
|
O alvo do erro particular. |
ApplicationProfile
Contém a lista de aplicações de galeria que devem ser disponibilizadas ao VM/VMSS
Name | Type | Description |
---|---|---|
galleryApplications |
Especifica as aplicações de galeria que devem ser disponibilizadas ao VM/VMSS |
AvailablePatchSummary
Descreve as propriedades de uma visualização de instância de máquina virtual para o resumo do patch disponível.
Name | Type | Description |
---|---|---|
assessmentActivityId |
|
O ID de atividade da operação que produziu este resultado. É usado para correlacionar através de CRP e registos de extensão. |
criticalAndSecurityPatchCount |
|
O número de patches críticos ou de segurança que tenham sido detetados como disponíveis e ainda não instalados. |
error |
Os erros que foram encontrados durante a execução da operação. A matriz de detalhes contém a lista deles. |
|
lastModifiedTime |
|
O calendário utc quando a operação começou. |
otherPatchCount |
|
O número de todos os patches disponíveis, excluindo crítico e de segurança. |
rebootPending |
|
O estado geral de reinício do VM. Será verdade quando patches parcialmente instalados exigirem um reboot para completar a instalação, mas o reboot ainda não ocorreu. |
startTime |
|
O calendário utc quando a operação começou. |
status |
O sucesso geral ou o estado de insucesso da operação. Permanece "InProgress" até que a operação esteja concluída. Nessa altura, tornar-se-á "Desconhecido", "Falhado", "Bem Sucedido", ou "Concluídos". |
BillingProfile
Especifica os detalhes relacionados com a faturação de um VM ou VMSS Azure Spot.
Versão mínima da API: 2019-03-01.
Name | Type | Description |
---|---|---|
maxPrice |
|
Especifica o preço máximo que está disposto a pagar por um VM/VMSS Azure Spot. Este preço está em dólares americanos. |
BootDiagnostics
Boot Diagnostics é uma funcionalidade de depuragem que lhe permite visualizar a saída da consola e o Screenshot para diagnosticar o estado de VM.
Pode facilmente visualizar a saída do seu registo de consola.
O Azure também lhe permite ver uma imagem do VM a partir do hipervisor.
Name | Type | Description |
---|---|---|
enabled |
|
Se os diagnósticos de arranque devem ser ativados na Máquina Virtual. |
storageUri |
|
Uri da conta de armazenamento para usar para colocar a saída da consola e a imagem. |
BootDiagnosticsInstanceView
A visão de um diagnóstico virtual de arranque de máquina.
Name | Type | Description |
---|---|---|
consoleScreenshotBlobUri |
|
A imagem da consola blob URI. |
serialConsoleLogBlobUri |
|
O registo de consola em série blob Uri. |
status |
A informação do estado do diagnóstico da bota para o VM. |
CachingTypes
Especifica os requisitos de caching.
Os valores possíveis são:
Nenhuma
ReadOnly
LerWrite
Padrão: Nenhum para armazenamento standard. Leia Em breve para Premium armazenamento.
Name | Type | Description |
---|---|---|
None |
|
|
ReadOnly |
|
|
ReadWrite |
|
CapacityReservationProfile
Os parâmetros de um perfil de reserva de capacidade.
Name | Type | Description |
---|---|---|
capacityReservationGroup |
Especifica o id de recursos do grupo de reserva de capacidade que deve ser usado para alocar a máquina virtual ou as instâncias vm de conjunto de escala, desde que a capacidade suficiente tenha sido reservada. Por favor, consulte para https://aka.ms/CapacityReservation mais detalhes. |
CloudError
Uma resposta de erro do serviço Compute.
Name | Type | Description |
---|---|---|
error |
Erro da Api. |
ComponentNames
O nome do componente. Atualmente, o único valor permitido é o Microsoft-Windows-Shell-Setup.
Name | Type | Description |
---|---|---|
Microsoft-Windows-Shell-Setup |
|
DataDisk
Descreve um disco de dados.
Name | Type | Description |
---|---|---|
caching |
Especifica os requisitos de caching. |
|
createOption |
Especifica como a máquina virtual deve ser criada. |
|
deleteOption |
Especifica se o disco de dados deve ser eliminado ou desapegado após a eliminação de VM. |
|
detachOption |
Especifica o comportamento de desprendimento a ser utilizado durante a desprender um disco ou que já está em processo de desprendimento da máquina virtual. Valores suportados: ForceDetach. |
|
diskIOPSReadWrite |
|
Especifica o Read-Write IOPS para o disco gerido quando o StorageAccountType é UltraSSD_LRS. Devolvido apenas para discos VM do VirtualMachine ScaleSet. Só pode ser atualizado através de atualizações para o Conjunto de Escala VirtualMachine. |
diskMBpsReadWrite |
|
Especifica a largura de banda em MB por segundo para o disco gerido quando o StorageAccountType é UltraSSD_LRS. Devolvido apenas para discos VM do VirtualMachine ScaleSet. Só pode ser atualizado através de atualizações para o Conjunto de Escala VirtualMachine. |
diskSizeGB |
|
Especifica o tamanho de um disco de dados vazio em gigabytes. Este elemento pode ser usado para substituir o tamanho do disco numa imagem de máquina virtual. |
image |
O disco rígido virtual de imagem do utilizador de origem. O disco rígido virtual será copiado antes de ser ligado à máquina virtual. Se a SourceImage for fornecida, o disco rígido virtual de destino não deve existir. |
|
lun |
|
Especifica o número de unidade lógica do disco de dados. Este valor é utilizado para identificar discos de dados dentro do VM e, portanto, deve ser único para cada disco de dados ligado a um VM. |
managedDisk |
Os parâmetros do disco geridos. |
|
name |
|
O nome do disco. |
toBeDetached |
|
Especifica se o disco de dados está em processo de desprendimento a partir do VirtualMachine/VirtualMachineScaleset |
vhd |
O disco rígido virtual. |
|
writeAcceleratorEnabled |
|
Especifica se o programaAccelerator deve ser ativado ou desativado no disco. |
DeleteOptions
Especificar o que acontece ao endereço IP público quando o VM é eliminado
Name | Type | Description |
---|---|---|
Delete |
|
|
Detach |
|
DiagnosticsProfile
Especifica o estado das definições de diagnóstico da bota.
Versão mínima api: 2015-06-15.
Name | Type | Description |
---|---|---|
bootDiagnostics |
Boot Diagnostics é uma funcionalidade de depuragem que lhe permite visualizar a saída da consola e o Screenshot para diagnosticar o estado de VM. |
DiffDiskOptions
Especifica as definições do disco efémero para o disco do sistema operativo.
Name | Type | Description |
---|---|---|
Local |
|
DiffDiskPlacement
Especifica a colocação do disco efémero para o disco do sistema operativo. Esta propriedade pode ser utilizada pelo utilizador no pedido de escolha da localização, isto é, disco de cache ou espaço de disco de recursos para provisão de disco Efeméride. Para obter mais informações sobre os requisitos de tamanho do disco Ephemeral OS, consulte os requisitos de tamanho do disco Ephemeral PARA Windows VM em https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux VM emhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
Name | Type | Description |
---|---|---|
CacheDisk |
|
|
ResourceDisk |
|
DiffDiskSettings
Descreve os parâmetros das definições efémeras do disco que podem ser especificados para o disco do sistema operativo.
NOTA: As definições do disco efémero só podem ser especificadas para o disco gerido.
Name | Type | Description |
---|---|---|
option |
Especifica as definições do disco efémero para o disco do sistema operativo. |
|
placement |
Especifica a colocação do disco efémero para o disco do sistema operativo. |
DiskCreateOptionTypes
Especifica como a máquina virtual deve ser criada.
Os valores possíveis são:
Anexar \u2013 Este valor é utilizado quando se utiliza um disco especializado para criar a máquina virtual.
A partir de \u2013 Este valor é utilizado quando está a utilizar uma imagem para criar a máquina virtual. Se estiver a utilizar uma imagem de plataforma, também utiliza o elemento de referência de imagem acima descrito. Se estiver a utilizar uma imagem de mercado, também utiliza o elemento de plano previamente descrito.
Name | Type | Description |
---|---|---|
Attach |
|
|
Empty |
|
|
FromImage |
|
DiskDeleteOptionTypes
Especifica se o disco de OS deve ser eliminado ou desconectado após a eliminação de VM.
Valores possíveis:
Excluir Se este valor for utilizado, o disco DE É eliminado quando o VM é eliminado.
Separar Se este valor for utilizado, o disco de oss é mantido após a eliminar do VM.
O valor predefinido está definido para se desprender. Para um disco EFÉMER OS, o valor predefinido é definido para Eliminar. O utilizador não pode alterar a opção de eliminação para o disco efémero DESE.
Name | Type | Description |
---|---|---|
Delete |
|
|
Detach |
|
DiskDetachOptionTypes
Especifica o comportamento de desprendimento a ser utilizado durante a desprender um disco ou que já está em processo de desprendimento da máquina virtual. Valores suportados: ForceDetach.
destacçãoOpis: O ForceDetach é aplicável apenas para discos de dados geridos. Se uma tentativa anterior de desprendimento do disco de dados não tiver sido concluída devido a uma falha inesperada da máquina virtual e o disco ainda não for lançado, utilize a retirada de força como opção de último recurso para retirar o disco à força do VM. Todas as escritas podem não ter sido lavadas quando se usa este comportamento de desprendimento.
Esta funcionalidade ainda se encontra no modo de pré-visualização e não é suportada para VirtualMachineScaleSet. Para separar uma atualização do disco de dados para 'True' juntamente com a definição de destacheOption: 'ForceDetach'.
Name | Type | Description |
---|---|---|
ForceDetach |
|
DiskEncryptionSetParameters
Descreve o parâmetro do id de conjunto de encriptação de disco gerido pelo cliente que pode ser especificado para o disco.
NOTA: O id de configuração do conjunto de encriptação do disco só pode ser especificado para o disco gerido. Por favor, consulte https://aka.ms/mdssewithcmkoverview mais detalhes.
Name | Type | Description |
---|---|---|
id |
|
ID de recursos |
DiskEncryptionSettings
Descreve um Definições de encriptação para um disco
Name | Type | Description |
---|---|---|
diskEncryptionKey |
Especifica a localização da chave de encriptação do disco, que é uma Key Vault Secret. |
|
enabled |
|
Especifica se a encriptação do disco deve ser ativada na máquina virtual. |
keyEncryptionKey |
Especifica a localização da chave de encriptação em Key Vault. |
DiskInstanceView
A visão do disco.
Name | Type | Description |
---|---|---|
encryptionSettings |
Especifica as definições de encriptação para o disco OS. |
|
name |
|
O nome do disco. |
statuses |
A informação sobre o estado dos recursos. |
ExtendedLocation
O tipo complexo da localização estendida.
Name | Type | Description |
---|---|---|
name |
|
O nome da localização estendida. |
type |
O tipo de localização estendida. |
ExtendedLocationTypes
O tipo de localização estendida.
Name | Type | Description |
---|---|---|
EdgeZone |
|
HardwareProfile
Especifica as definições de hardware para a máquina virtual.
Name | Type | Description |
---|---|---|
vmSize |
Especifica o tamanho da máquina virtual. |
|
vmSizeProperties |
Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima da API: 2021-07-01. |
HyperVGenerationType
Especifica o Tipo de HiperVGeneração associado a um recurso
Name | Type | Description |
---|---|---|
V1 |
|
|
V2 |
|
ImageReference
Especifica informações sobre a imagem a utilizar. Pode especificar informações sobre imagens da plataforma, imagens de marketplace ou imagens de máquinas virtuais. Este elemento é necessário quando pretender utilizar uma imagem de plataforma, imagem de marketplace ou imagem de máquina virtual, mas não é utilizado em outras operações de criação. NOTA: O editor de referência de imagem e a oferta só podem ser definidos quando se cria o conjunto de escala.
Name | Type | Description |
---|---|---|
communityGalleryImageId |
|
Especificou a imagem da galeria comunitária de identificação única para a implantação de VM. Isto pode ser recolhido a partir da imagem da galeria comunitária GET call. |
exactVersion |
|
Especifica em números decimais, a versão da imagem da plataforma ou imagem de mercado usada para criar a máquina virtual. Este campo de leitura difere apenas da 'versão', apenas se o valor especificado no campo 'versão' for 'mais recente'. |
id |
|
ID de recursos |
offer |
|
Especifica a oferta da imagem da plataforma ou imagem de mercado usada para criar a máquina virtual. |
publisher |
|
O editor de imagem. |
sharedGalleryImageId |
|
Especificou a imagem de galeria partilhada id única para implantação de Vm. Isto pode ser recolhido a partir da imagem partilhada da galeria GET call. |
sku |
|
A imagem SKU. |
version |
|
Especifica a versão da imagem da plataforma ou imagem de mercado usada para criar a máquina virtual. Os formatos permitidos são Major.Minor.Build ou 'mais recente'. Major, Minor e Build são números decimais. Especifique as 'últimas' para utilizar a versão mais recente de uma imagem disponível no momento de implementação. Mesmo que utilize as 'mais recentes', a imagem VM não atualizará automaticamente após o tempo de implantação, mesmo que uma nova versão esteja disponível. Por favor, não utilize a 'versão' de campo para implantação de imagem de galeria, a imagem da galeria deve sempre usar o campo 'id' para implantação, para utilizar a versão 'mais recente' da imagem da galeria, basta definir '/subscrições/{subscriçõesD}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' no campo 'id' sem entrada de versão. |
InnerError
Detalhes de erro internos.
Name | Type | Description |
---|---|---|
errordetail |
|
A mensagem de erro interna ou o despejo de exceções. |
exceptiontype |
|
O tipo de exceção. |
InstanceViewStatus
Estado da visualização de instância.
Name | Type | Description |
---|---|---|
code |
|
O código de estado. |
displayStatus |
|
A etiqueta loisável curta para o estado. |
level |
O código de nível. |
|
message |
|
A mensagem de estado detalhada, incluindo para alertas e mensagens de erro. |
time |
|
A hora do estado. |
IPVersions
Disponível a partir de Api-Version 2019-07-01, representa se a configuração específica é IPv4 ou IPv6. O padrão é tomado como IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.
Name | Type | Description |
---|---|---|
IPv4 |
|
|
IPv6 |
|
KeyVaultKeyReference
Descreve uma referência a Key Vault Chave
Name | Type | Description |
---|---|---|
keyUrl |
|
O URL refere uma chave de encriptação chave em Key Vault. |
sourceVault |
O URL relativo do Key Vault que contém a chave. |
KeyVaultSecretReference
Descreve uma referência a Key Vault Segredo
Name | Type | Description |
---|---|---|
secretUrl |
|
A URL refere-se a um segredo numa Key Vault. |
sourceVault |
A URL relativa do Key Vault contendo o segredo. |
LastPatchInstallationSummary
Descreve as propriedades do último resumo do patch instalado.
Name | Type | Description |
---|---|---|
error |
Os erros que foram encontrados durante a execução da operação. A matriz de detalhes contém a lista deles. |
|
excludedPatchCount |
|
O número de todos os patches disponíveis, mas excluído explicitamente por uma correspondência de lista de exclusão especificada pelo cliente. |
failedPatchCount |
|
A contagem de remendos que falharam na instalação. |
installationActivityId |
|
O ID de atividade da operação que produziu este resultado. É usado para correlacionar através de CRP e registos de extensão. |
installedPatchCount |
|
A contagem de remendos que instalaram com sucesso. |
lastModifiedTime |
|
O calendário utc quando a operação começou. |
maintenanceWindowExceeded |
|
Descreve se a operação esgotou o tempo antes de concluir todas as suas ações pretendidas |
notSelectedPatchCount |
|
O número de todos os patches disponíveis mas não vai ser instalado porque não corresponde a uma classificação ou entrada na lista de inclusão. |
pendingPatchCount |
|
Espera-se que o número de remendos disponíveis seja instalado durante a operação de instalação do patch. |
startTime |
|
O calendário utc quando a operação começou. |
status |
O sucesso geral ou o estado de insucesso da operação. Permanece "InProgress" até que a operação esteja concluída. Nessa altura, tornar-se-á "Desconhecido", "Falhado", "Bem Sucedido", ou "Concluídos". |
LinuxConfiguration
Especifica as definições do sistema operativo Linux na máquina virtual.
Para obter uma lista de distribuições apoiadas do Linux, consulte o Linux na Azure-Endorsed Distributions.
Name | Type | Description |
---|---|---|
disablePasswordAuthentication |
|
Especifica se a autenticação de palavra-passe deve ser desativada. |
patchSettings |
[Recurso de pré-visualização] Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux. |
|
provisionVMAgent |
|
Indica se o agente de máquinas virtuais deve ser a provisionado na máquina virtual. |
ssh |
Especifica a configuração da chave ssh para um Sistema Operativo Linux. |
LinuxPatchAssessmentMode
Especifica o modo de Avaliação do Patch de Hóspedes VM para a máquina virtual IaaS.
Os valores possíveis são:
ImageDefault - Controla o tempo das avaliações de patchs numa máquina virtual.
AutomaticByPlatform - A plataforma irá desencadear avaliações periódicas de correção. O fornecimento de propriedadeVMAgent deve ser verdade.
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
|
|
ImageDefault |
|
LinuxPatchSettings
Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux.
Name | Type | Description |
---|---|---|
assessmentMode |
Especifica o modo de Avaliação do Patch de Hóspedes VM para a máquina virtual IaaS. |
|
automaticByPlatformSettings |
Especifica definições adicionais para o modo de correção AutomaticByPlatform em VM Guest Patching em Linux. |
|
patchMode |
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.
Name | Type | Description |
---|---|---|
Always |
|
|
IfRequired |
|
|
Never |
|
|
Unknown |
|
LinuxVMGuestPatchAutomaticByPlatformSettings
Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições de patch do Linux.
Name | Type | Description |
---|---|---|
rebootSetting |
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform. |
LinuxVMGuestPatchMode
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível.
Os valores possíveis são:
ImageDefault - É utilizada a configuração de remendos padrão da máquina virtual.
AutomaticamenteByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser verdade
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
|
|
ImageDefault |
|
MaintenanceOperationResultCodeTypes
O último código de resultados da operação de manutenção.
Name | Type | Description |
---|---|---|
MaintenanceAborted |
|
|
MaintenanceCompleted |
|
|
None |
|
|
RetryLater |
|
MaintenanceRedeployStatus
Estado da Operação de Manutenção.
Name | Type | Description |
---|---|---|
isCustomerInitiatedMaintenanceAllowed |
|
É verdade, se o cliente estiver autorizado a realizar a Manutenção. |
lastOperationMessage |
|
Mensagem devolvida para a última Operação de Manutenção. |
lastOperationResultCode |
O último código de resultados da operação de manutenção. |
|
maintenanceWindowEndTime |
|
Fim do tempo para a janela de manutenção. |
maintenanceWindowStartTime |
|
Hora de início para a janela de manutenção. |
preMaintenanceWindowEndTime |
|
Fim do tempo para a janela de pré manutenção. |
preMaintenanceWindowStartTime |
|
Hora de início para a janela de pré manutenção. |
ManagedDiskParameters
Os parâmetros de um disco gerido.
Name | Type | Description |
---|---|---|
diskEncryptionSet |
Especifica o id de conjunto de encriptação do disco gerido pelo cliente para o disco gerido. |
|
id |
|
ID de recursos |
securityProfile |
Especifica o perfil de segurança para o disco gerido. |
|
storageAccountType |
Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizados com discos de dados, não podem ser utilizados com disco OS. |
NetworkApiVersion
especifica a versão API da Microsoft.Network utilizada na criação de recursos de rede nas Configurações de Interface de Rede
Name | Type | Description |
---|---|---|
2020-11-01 |
|
NetworkInterfaceReference
Descreve uma referência de interface de rede.
Name | Type | Description |
---|---|---|
id |
|
ID de recursos |
properties.deleteOption |
Especificar o que acontece à interface de rede quando o VM é eliminado |
|
properties.primary |
|
Especifica a interface de rede primária no caso de a máquina virtual ter mais de 1 interface de rede. |
NetworkProfile
Especifica as interfaces de rede ou a configuração de rede da máquina virtual.
Name | Type | Description |
---|---|---|
networkApiVersion |
especifica a versão API da Microsoft.Network utilizada na criação de recursos de rede nas Configurações de Interface de Rede |
|
networkInterfaceConfigurations |
Especifica as configurações de rede que serão usadas para criar os recursos de rede de máquinas virtuais. |
|
networkInterfaces |
Especifica a lista de identificações de recursos para as interfaces de rede associadas à máquina virtual. |
OperatingSystemTypes
Esta propriedade permite especificar o tipo de SO que está incluído no disco se criar um VM a partir da imagem do utilizador ou de um VHD especializado.
Os valores possíveis são:
Windows
Linux
Name | Type | Description |
---|---|---|
Linux |
|
|
Windows |
|
OSDisk
Especifica informações sobre o disco do sistema operativo utilizado pela máquina virtual.
Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais Azure.
Name | Type | Description |
---|---|---|
caching |
Especifica os requisitos de caching. |
|
createOption |
Especifica como a máquina virtual deve ser criada. |
|
deleteOption |
Especifica se o disco de OS deve ser eliminado ou desconectado após a eliminação de VM. |
|
diffDiskSettings |
Especifica o disco efémero Definições para o disco do sistema operativo utilizado pela máquina virtual. |
|
diskSizeGB |
|
Especifica o tamanho de um disco de dados vazio em gigabytes. Este elemento pode ser usado para substituir o tamanho do disco numa imagem de máquina virtual. |
encryptionSettings |
Especifica as definições de encriptação para o disco OS. |
|
image |
O disco rígido virtual de imagem do utilizador de origem. O disco rígido virtual será copiado antes de ser ligado à máquina virtual. Se a SourceImage for fornecida, o disco rígido virtual de destino não deve existir. |
|
managedDisk |
Os parâmetros do disco geridos. |
|
name |
|
O nome do disco. |
osType |
Esta propriedade permite especificar o tipo de SO que está incluído no disco se criar um VM a partir da imagem do utilizador ou de um VHD especializado. |
|
vhd |
O disco rígido virtual. |
|
writeAcceleratorEnabled |
|
Especifica se o programaAccelerator deve ser ativado ou desativado no disco. |
OSProfile
Especifica as definições do sistema operativo para a máquina virtual. Algumas das definições não podem ser alteradas uma vez que o VM é a provisionado.
Name | Type | Description |
---|---|---|
adminPassword |
|
Especifica a palavra-passe da conta do administrador. |
adminUsername |
|
Especifica o nome da conta do administrador. |
allowExtensionOperations |
|
Especifica se as operações de extensão devem ser permitidas na máquina virtual. |
computerName |
|
Especifica o nome de hospedeiro da máquina virtual. |
customData |
|
Especifica uma sequência codificada base-64 de dados personalizados. A cadeia codificada base-64 é descodificado para uma matriz binária que é guardada como um ficheiro na Máquina Virtual. O comprimento máximo da matriz binária é de 65535 bytes. |
linuxConfiguration |
Especifica as definições do sistema operativo Linux na máquina virtual. |
|
requireGuestProvisionSignal |
|
Propriedade opcional que deve ser definida para Verdadeiro ou omitida. |
secrets |
Especifica um conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados numa máquina virtual, recomenda-se a utilização da extensão virtual da máquina Azure Key Vault para o Linux ou para a extensão virtual da máquina Azure Key Vault para Windows. |
|
windowsConfiguration |
Especifica Windows definições do sistema operativo na máquina virtual. |
PassNames
O nome do passe. Atualmente, o único valor admissível é o OobeSystem.
Name | Type | Description |
---|---|---|
OobeSystem |
|
PatchOperationStatus
O sucesso geral ou o estado de insucesso da operação. Permanece "InProgress" até que a operação esteja concluída. Nessa altura, tornar-se-á "Desconhecido", "Falhado", "Bem Sucedido", ou "Concluídos".
Name | Type | Description |
---|---|---|
CompletedWithWarnings |
|
|
Failed |
|
|
InProgress |
|
|
Succeeded |
|
|
Unknown |
|
PatchSettings
Especifica as definições relacionadas com o Patching de Hóspedes VM no Windows.
Name | Type | Description |
---|---|---|
assessmentMode |
Especifica o modo de avaliação do patch do VM Guest para a máquina virtual IaaS. |
|
automaticByPlatformSettings |
Especifica definições adicionais para o modo de correção AutomaticByPlatform em VM Guest Patching em Windows. |
|
enableHotpatching |
|
Permite que os clientes remendem os seus VMs Azure sem necessitar de um reboot. Para permitir a instalação, o "provisionVMAgent" deve ser definido como verdadeiro e o 'patchMode' deve ser definido como "AutomaticByPlatform". |
patchMode |
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível. |
Plan
Especifica informações sobre a imagem do mercado utilizada para criar a máquina virtual. Este elemento é utilizado apenas para imagens de mercado. Antes de utilizar uma imagem de mercado a partir de uma API, tem de ativar a imagem para uso programático. No portal do Azure, encontre a imagem de mercado que pretende utilizar e, em seguida, clique em "Querer implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar.
Name | Type | Description |
---|---|---|
name |
|
A identificação do plano. |
product |
|
Especifica o produto da imagem do mercado. Este é o mesmo valor que a Oferta sob o elemento imageReference. |
promotionCode |
|
O código de promoção. |
publisher |
|
A identificação da editora. |
ProtocolTypes
Especifica o protocolo do ouvinte winRM.
Os valores possíveis são:
http
https
Name | Type | Description |
---|---|---|
Http |
|
|
Https |
|
PublicIPAddressSku
Descreve o IP Sku público. Só pode ser definido com OrchestrationMode como Flexível.
Name | Type | Description |
---|---|---|
name |
Especificar o nome de sku IP público |
|
tier |
Especificar o nível de sku IP público |
PublicIPAddressSkuName
Especificar o nome de sku IP público
Name | Type | Description |
---|---|---|
Basic |
|
|
Standard |
|
PublicIPAddressSkuTier
Especificar o nível de sku IP público
Name | Type | Description |
---|---|---|
Global |
|
|
Regional |
|
PublicIPAllocationMethod
Especificar o tipo de atribuição de IP público
Name | Type | Description |
---|---|---|
Dynamic |
|
|
Static |
|
ResourceIdentityType
O tipo de identidade usada para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades da máquina virtual.
Name | Type | Description |
---|---|---|
None |
|
|
SystemAssigned |
|
|
SystemAssigned, UserAssigned |
|
|
UserAssigned |
|
ScheduledEventsProfile
Name | Type | Description |
---|---|---|
terminateNotificationProfile |
Especifica configurações relacionadas com o Evento Programado. |
securityEncryptionTypes
Especifica oType de Encriptação do disco gerido.
Está definido para DiskWithVMGuestState para encriptação do disco gerido juntamente com a bolha VMGuestState, e VMGuestStateOnly para encriptação apenas da bolha VMGuestState.
NOTA: Pode ser definido apenas para VMs confidenciais.
Name | Type | Description |
---|---|---|
DiskWithVMGuestState |
|
|
VMGuestStateOnly |
|
SecurityProfile
Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de escala de máquina virtual.
Name | Type | Description |
---|---|---|
encryptionAtHost |
|
Esta propriedade pode ser usada pelo utilizador no pedido para ativar ou desativar a Encriptação do Anfitrião para a máquina virtual ou conjunto de escala de máquina virtual. Isto permitirá a encriptação de todos os discos, incluindo o disco De recurso/Temperatura no próprio anfitrião. |
securityType |
Especifica o Dispositivo de Segurança da máquina virtual. Tem de ser definido para qualquer valor especificado para permitir a uefiSettings. |
|
uefiSettings |
Especifica as definições de segurança como arranque seguro e vTPM utilizados durante a criação da máquina virtual. |
SecurityTypes
Especifica o Dispositivo de Segurança da máquina virtual. Tem de ser definido para qualquer valor especificado para permitir a uefiSettings.
Predefinição: As configurações da UefiSettings não serão ativadas a menos que esta propriedade esteja definida.
Name | Type | Description |
---|---|---|
ConfidentialVM |
|
|
TrustedLaunch |
|
SettingNames
Especifica o nome da definição a que o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.
Name | Type | Description |
---|---|---|
AutoLogon |
|
|
FirstLogonCommands |
|
SshConfiguration
Configuração SSH para VMs baseados em Linux em execução em Azure
Name | Type | Description |
---|---|---|
publicKeys |
A lista de chaves públicas SSH usadas para autenticar com VMs à base de linux. |
SshPublicKey
Contém informações sobre a chave pública do certificado SSH e sobre o caminho no Linux VM onde a chave pública é colocada.
Name | Type | Description |
---|---|---|
keyData |
|
Certificado de chave pública SSH usado para autenticar com o VM através de ssh. A chave tem de ser pelo menos 2048 bit e em formato ssh-rsa. |
path |
|
Especifica o caminho completo no VM criado onde a chave pública ssh está armazenada. Se o ficheiro já existir, a chave especificada é anexada ao ficheiro. Exemplo: /home/user/.ssh/authorized_keys |
StatusLevelTypes
O código de nível.
Name | Type | Description |
---|---|---|
Error |
|
|
Info |
|
|
Warning |
|
StorageAccountTypes
Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizados com discos de dados, não podem ser utilizados com disco OS.
Name | Type | Description |
---|---|---|
PremiumV2_LRS |
|
|
Premium_LRS |
|
|
Premium_ZRS |
|
|
StandardSSD_LRS |
|
|
StandardSSD_ZRS |
|
|
Standard_LRS |
|
|
UltraSSD_LRS |
|
StorageProfile
Especifica as definições de armazenamento dos discos de máquinas virtuais.
Name | Type | Description |
---|---|---|
dataDisks |
|
Especifica os parâmetros utilizados para adicionar um disco de dados a uma máquina virtual. |
imageReference |
Especifica informações sobre a imagem a utilizar. Pode especificar informações sobre imagens da plataforma, imagens de marketplace ou imagens de máquinas virtuais. Este elemento é necessário quando pretender utilizar uma imagem de plataforma, imagem de marketplace ou imagem de máquina virtual, mas não é utilizado em outras operações de criação. |
|
osDisk |
Especifica informações sobre o disco do sistema operativo utilizado pela máquina virtual. |
SubResource
Name | Type | Description |
---|---|---|
id |
|
ID de recursos |
TerminateNotificationProfile
Name | Type | Description |
---|---|---|
enable |
|
Especifica se o evento programado de rescisão está ativado ou desativado. |
notBeforeTimeout |
|
O tempo configurável de tempo que uma Máquina Virtual a ser eliminada terá de potencialmente aprovar o Evento Agendado para Terminação antes de o evento ser aprovado automaticamente (cronometrado). A configuração deve ser especificada no formato ISO 8601, o valor predefinido é de 5 minutos (PT5M) |
UefiSettings
Especifica as definições de segurança como arranque seguro e vTPM utilizados durante a criação da máquina virtual.
Versão mínima da API: 2020-12-01
Name | Type | Description |
---|---|---|
secureBootEnabled |
|
Especifica se o arranque seguro deve ser ativado na máquina virtual. |
vTpmEnabled |
|
Especifica se vTPM deve ser ativado na máquina virtual. |
UserAssignedIdentities
A lista de identidades de utilizador associadas à Máquina Virtual. As referências-chave do dicionário de identidade do utilizador serão ids de recursos ARM no formulário: '/subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Name | Type | Description |
---|---|---|
|
VaultCertificate
Descreve uma única referência de certificado num Key Vault e onde o certificado deve residir no VM.
Name | Type | Description |
---|---|---|
certificateStore |
|
Para Windows VMs, especifica a loja de certificados na Máquina Virtual à qual o certificado deve ser adicionado. A loja de certificados especificada está implicitamente na conta LocalMachine. |
certificateUrl |
|
Esta é a URL de um certificado que foi enviado para Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre da chave. Neste caso, o seu certificado tem de ser a codificação Base64 do seguinte Objeto JSON que está codificado em UTF-8: |
VaultSecretGroup
Descreve um conjunto de certificados que estão todos na mesma Key Vault.
Name | Type | Description |
---|---|---|
sourceVault |
O URL relativo do Key Vault contendo todos os certificados em Certificados de Abóbada. |
|
vaultCertificates |
A lista de referências chave do cofre em SourceVault que contêm certificados. |
VirtualHardDisk
Descreve o uri de um disco.
Name | Type | Description |
---|---|---|
uri |
|
Especifica o uri do disco rígido virtual. |
VirtualMachine
Descreve uma máquina virtual.
Name | Type | Description |
---|---|---|
extendedLocation |
A localização alargada da Máquina Virtual. |
|
id |
|
ID de recursos |
identity |
A identidade da máquina virtual, se configurada. |
|
location |
|
Localização do recurso |
name |
|
Nome do recurso |
plan |
Especifica informações sobre a imagem do mercado utilizada para criar a máquina virtual. Este elemento é utilizado apenas para imagens de mercado. Antes de utilizar uma imagem de mercado a partir de uma API, tem de ativar a imagem para uso programático. No portal do Azure, encontre a imagem de mercado que pretende utilizar e, em seguida, clique em "Querer implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar. |
|
properties.additionalCapabilities |
Especifica capacidades adicionais ativadas ou desativadas na máquina virtual. |
|
properties.applicationProfile |
Especifica as aplicações de galeria que devem ser disponibilizadas ao VM/VMSS |
|
properties.availabilitySet |
Especifica informações sobre o conjunto de disponibilidade a que a máquina virtual deve ser atribuída. As máquinas virtuais especificadas no mesmo conjunto de disponibilidade são atribuídas a diferentes nós para maximizar a disponibilidade. Para obter mais informações sobre os conjuntos de disponibilidade, consulte a visão geral dos conjuntos de disponibilidade. |
|
properties.billingProfile |
Especifica os detalhes relacionados com a faturação de uma máquina virtual Azure Spot. |
|
properties.capacityReservation |
Especifica informações sobre a reserva de capacidade que é usada para alocar máquina virtual. |
|
properties.diagnosticsProfile |
Especifica o estado das definições de diagnóstico da bota. |
|
properties.evictionPolicy |
Especifica a política de despejo para a máquina virtual Azure Spot e o conjunto de escala Azure Spot. |
|
properties.extensionsTimeBudget |
|
Especifica o tempo atribuído para todas as extensões começarem. A duração do tempo deve ser entre 15 minutos e 120 minutos (inclusive) e deve ser especificada no formato ISO 8601. O valor predefinido é de 90 minutos (PT1H30M). |
properties.hardwareProfile |
Especifica as definições de hardware para a máquina virtual. |
|
properties.host |
Especifica informações sobre o hospedeiro dedicado em que a máquina virtual reside. |
|
properties.hostGroup |
Especifica informações sobre o grupo de anfitriões dedicado em que a máquina virtual reside. |
|
properties.instanceView |
A visão de exemplo de máquina virtual. |
|
properties.licenseType |
|
Especifica que a imagem ou disco que está a ser utilizado foi licenciado no local. |
properties.networkProfile |
Especifica as interfaces de rede da máquina virtual. |
|
properties.osProfile |
Especifica as definições do sistema operativo utilizadas durante a criação da máquina virtual. Algumas das definições não podem ser alteradas uma vez que o VM é a provisionado. |
|
properties.platformFaultDomain |
|
Especifica o domínio de falha lógica definido na escala em que a Máquina Virtual será criada. Por predefinição, a Máquina Virtual irá atribuir automaticamente a um domínio de avaria que melhor mantenha o equilíbrio entre domínios de avaria disponíveis. Versão mínima api‐‐12‐01 |
properties.priority |
Especifica a prioridade para a máquina virtual. |
|
properties.provisioningState |
|
O estado de provisionamento, que só aparece na resposta. |
properties.proximityPlacementGroup |
Especifica informações sobre o grupo de colocação de proximidade a que a máquina virtual deve ser atribuída. |
|
properties.scheduledEventsProfile |
Especifica configurações relacionadas com eventos programados. |
|
properties.securityProfile |
Especifica as definições de perfil relacionados com a Segurança para a máquina virtual. |
|
properties.storageProfile |
Especifica as definições de armazenamento dos discos de máquinas virtuais. |
|
properties.timeCreated |
|
Especifica o momento em que o recurso Máquina Virtual foi criado. |
properties.userData |
|
UserData para o VM, que deve ser codificado base-64. O cliente não deve passar segredos aqui. |
properties.virtualMachineScaleSet |
Especifica informações sobre o conjunto de escala de máquina virtual a que a máquina virtual deve ser atribuída. As máquinas virtuais especificadas no mesmo conjunto de escala de máquina virtual são atribuídas a diferentes nós para maximizar a disponibilidade. Atualmente, um VM só pode ser adicionado à escala de máquina virtual definida no tempo de criação. Um VM existente não pode ser adicionado a um conjunto de escala de máquina virtual. |
|
properties.vmId |
|
Especifica o ID exclusivo VM que é um identificador de 128 bits que é codificado e armazenado em todos os Azure IaaS VMs SMBIOS e pode ser lido usando comandos BIOS da plataforma. |
resources |
Os recursos de extensão de crianças da máquina virtual. |
|
tags |
|
Etiquetas de recursos |
type |
|
Tipo de recurso |
zones |
|
As zonas de máquinas virtuais. |
VirtualMachineAgentInstanceView
A visão do agente VM a funcionar na máquina virtual.
Name | Type | Description |
---|---|---|
extensionHandlers |
A vista de instância do manipulador de extensão da máquina virtual. |
|
statuses |
A informação sobre o estado dos recursos. |
|
vmAgentVersion |
|
A versão completa do Agente VM. |
VirtualMachineEvictionPolicyTypes
Especifica a política de despejo para a máquina virtual Azure Spot e o conjunto de escala Azure Spot.
Para as máquinas virtuais Azure Spot, tanto 'Deallocate' como 'Delete' são suportados e a versão api mínima é 2019-03-01.
Para os conjuntos de escala Azure Spot, tanto 'Deallocate' como 'Delete' são suportados e a versão api mínima é 2017-10-30-preview.
Name | Type | Description |
---|---|---|
Deallocate |
|
|
Delete |
|
VirtualMachineExtension
Descreve uma extensão virtual da máquina.
Name | Type | Description |
---|---|---|
id |
|
ID de recursos |
location |
|
Localização do recurso |
name |
|
Nome do recurso |
properties.autoUpgradeMinorVersion |
|
Indica se a extensão deve utilizar uma versão menor mais recente se uma estiver disponível no momento de implementação. Uma vez implementada, no entanto, a extensão não irá atualizar versões menores a menos que seja redistribuída, mesmo com esta propriedade definida como verdadeira. |
properties.enableAutomaticUpgrade |
|
Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir uma versão mais recente da extensão disponível. |
properties.forceUpdateTag |
|
Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha mudado. |
properties.instanceView |
A vista de instância de extensão da máquina virtual. |
|
properties.protectedSettings |
|
A extensão pode conter instalações protegidas ou ocultações protegidasFromKeyVault ou nenhuma definição protegida. |
properties.protectedSettingsFromKeyVault |
|
As extensões configurações protegidas que são passadas por referência, e consumidas a partir do cofre chave |
properties.provisioningState |
|
O estado de provisionamento, que só aparece na resposta. |
properties.publisher |
|
O nome do editor manipulador de extensões. |
properties.settings |
|
Json formau configurações públicas para a extensão. |
properties.suppressFailures |
|
Indica se as falhas decorrentes da extensão serão suprimidas (falhas operacionais como a não ligação ao VM não serão suprimidas independentemente deste valor). O padrão é falso. |
properties.type |
|
Especifica o tipo de extensão; um exemplo é "CustomScriptExtension". |
properties.typeHandlerVersion |
|
Especifica a versão do manipulador de scripts. |
tags |
|
Etiquetas de recursos |
type |
|
Tipo de recurso |
VirtualMachineExtensionHandlerInstanceView
A visão de um manipulador de extensão de máquina virtual.
Name | Type | Description |
---|---|---|
status |
O estado do manipulador de extensão. |
|
type |
|
Especifica o tipo de extensão; um exemplo é "CustomScriptExtension". |
typeHandlerVersion |
|
Especifica a versão do manipulador de scripts. |
VirtualMachineExtensionInstanceView
A visão de uma extensão de máquina virtual.
Name | Type | Description |
---|---|---|
name |
|
O nome de extensão da máquina virtual. |
statuses |
A informação sobre o estado dos recursos. |
|
substatuses |
A informação sobre o estado dos recursos. |
|
type |
|
Especifica o tipo de extensão; um exemplo é "CustomScriptExtension". |
typeHandlerVersion |
|
Especifica a versão do manipulador de scripts. |
VirtualMachineHealthStatus
O estado de saúde do VM.
Name | Type | Description |
---|---|---|
status |
A informação sobre o estado de saúde do VM. |
VirtualMachineIdentity
Identidade para a máquina virtual.
Name | Type | Description |
---|---|---|
principalId |
|
A identificação principal da identidade da máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema. |
tenantId |
|
O inquilino está associado à máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema. |
type |
O tipo de identidade usada para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades da máquina virtual. |
|
userAssignedIdentities |
A lista de identidades de utilizador associadas à Máquina Virtual. As referências-chave do dicionário de identidade do utilizador serão ids de recursos ARM no formulário: '/subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
VirtualMachineInstanceView
A visão de uma máquina virtual.
Name | Type | Description |
---|---|---|
assignedHost |
|
Id de recursos do hospedeiro dedicado, no qual a máquina virtual é alocada através da colocação automática, quando a máquina virtual está associada a um grupo de anfitriões dedicado que tem colocação automática ativada. |
bootDiagnostics |
Boot Diagnostics é uma funcionalidade de depuragem que lhe permite visualizar a saída da consola e o Screenshot para diagnosticar o estado de VM. |
|
computerName |
|
O nome do computador atribuído à máquina virtual. |
disks |
A informação virtual do disco de máquina. |
|
extensions |
A informação sobre extensões. |
|
hyperVGeneration |
Especifica o Tipo de HiperVGeneração associado a um recurso |
|
maintenanceRedeployStatus |
O estado da Operação de Manutenção na máquina virtual. |
|
osName |
|
O Sistema Operativo está a funcionar na máquina virtual. |
osVersion |
|
A versão do Sistema Operativo a funcionar na máquina virtual. |
patchStatus |
[Recurso de pré-visualização] O estado das operações de correção de máquinas virtuais. |
|
platformFaultDomain |
|
Especifica o domínio da falha da máquina virtual. |
platformUpdateDomain |
|
Especifica o domínio de atualização da máquina virtual. |
rdpThumbPrint |
|
A impressão digital do certificado de ambiente de trabalho remoto. |
statuses |
A informação sobre o estado dos recursos. |
|
vmAgent |
O agente VM a funcionar na máquina virtual. |
|
vmHealth |
O estado de saúde do VM. |
VirtualMachineIpTag
Contém a etiqueta IP associada ao endereço IP público.
Name | Type | Description |
---|---|---|
ipTagType |
|
Tipo de etiqueta IP. Exemplo: FirstPartyUsage. |
tag |
|
Marca IP associada ao IP público. Exemplo: SQL, Armazenamento etc. |
VirtualMachineNetworkInterfaceConfiguration
Descreve configurações de interface de rede de máquinas virtuais.
Name | Type | Description |
---|---|---|
name |
|
O nome de configuração da interface de rede. |
properties.deleteOption |
Especificar o que acontece à interface de rede quando o VM é eliminado |
|
properties.dnsSettings |
As definições dns a aplicar nas interfaces de rede. |
|
properties.dscpConfiguration | ||
properties.enableAcceleratedNetworking |
|
Especifica se a interface de rede está ativada em rede acelerada. |
properties.enableFpga |
|
Especifica se a interface de rede está ativada em rede FPGA. |
properties.enableIPForwarding |
|
Se o encaminhamento IP ativou neste NIC. |
properties.ipConfigurations |
Especifica as configurações IP da interface de rede. |
|
properties.networkSecurityGroup |
O grupo de segurança da rede. |
|
properties.primary |
|
Especifica a interface de rede primária no caso de a máquina virtual ter mais de 1 interface de rede. |
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
Descreve as definições de DNS de configuração de rede de máquinas virtuais.
Name | Type | Description |
---|---|---|
dnsServers |
|
Lista de endereços IP dos servidores DNS |
VirtualMachineNetworkInterfaceIPConfiguration
Descreve a configuração IP de um perfil de rede de máquina virtual.
Name | Type | Description |
---|---|---|
name |
|
O nome de configuração IP. |
properties.applicationGatewayBackendAddressPools |
Especifica uma série de referências para backend pools de endereços de gateways de aplicações. Uma máquina virtual pode referenciar piscinas de endereços de backend de vários gateways de aplicações. Várias máquinas virtuais não podem usar o mesmo gateway de aplicação. |
|
properties.applicationSecurityGroups |
Especifica uma série de referências ao grupo de segurança de aplicações. |
|
properties.loadBalancerBackendAddressPools |
Especifica uma série de referências para conjuntos de endereços de backend de equilibradores de carga. Uma máquina virtual pode referenciar piscinas de endereços de backend de um público e um equilibrador de carga interno. [Várias máquinas virtuais não podem usar o mesmo balanceador básico de carga de sku]. |
|
properties.primary |
|
Especifica a interface de rede primária no caso de a máquina virtual ter mais de 1 interface de rede. |
properties.privateIPAddressVersion |
Disponível a partir de Api-Version 2017-03-30 em diante, representa se a configuração específica é IPv4 ou IPv6. O padrão é tomado como IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'. |
|
properties.publicIPAddressConfiguration |
O publicIPAddressConfiguration. |
|
properties.subnet |
Especifica o identificador da sub-rede. |
VirtualMachinePatchStatus
O estado das operações de correção de máquinas virtuais.
Name | Type | Description |
---|---|---|
availablePatchSummary |
O resumo do patch disponível da última operação de avaliação para a máquina virtual. |
|
configurationStatuses |
O estado de habilitação do patchMode especificado |
|
lastPatchInstallationSummary |
O resumo de instalação da última operação de instalação da máquina virtual. |
VirtualMachinePriorityTypes
Especifica a prioridade para a máquina virtual.
Versão mínima da API: 2019-03-01
Name | Type | Description |
---|---|---|
Low |
|
|
Regular |
|
|
Spot |
|
VirtualMachinePublicIPAddressConfiguration
Descreve uma configuração de endereço publicipad de configuração de máquinas virtuais ip
Name | Type | Description |
---|---|---|
name |
|
O nome de configuração de endereço publicIP. |
properties.deleteOption |
Especificar o que acontece ao endereço IP público quando o VM é eliminado |
|
properties.dnsSettings |
As definições dns a aplicar nos endereços publicIP . |
|
properties.idleTimeoutInMinutes |
|
O tempo de inatividade do endereço IP público. |
properties.ipTags |
A lista de etiquetas IP associadas ao endereço IP público. |
|
properties.publicIPAddressVersion |
Disponível a partir de Api-Version 2019-07-01, representa se a configuração específica é IPv4 ou IPv6. O padrão é tomado como IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'. |
|
properties.publicIPAllocationMethod |
Especificar o tipo de atribuição de IP público |
|
properties.publicIPPrefix |
O PublicIPPrefix a partir do qual atribuir endereços publicip. |
|
sku |
Descreve o IP Sku público. Só pode ser definido com OrchestrationMode como Flexível. |
VirtualMachinePublicIPAddressDnsSettingsConfiguration
Descreve as definições de DNS de configuração de rede de máquinas virtuais.
Name | Type | Description |
---|---|---|
domainNameLabel |
|
O prefixo da etiqueta de nome de domínio dos recursos PublicIPAddress que serão criados. O rótulo de nome gerado é a concatenação do rótulo de nome de domínio e iD exclusivo do perfil de rede VM. |
VirtualMachineSizeTypes
Especifica o tamanho da máquina virtual.
O tipo de dados enum está atualmente precotado e será removido até 23 de dezembro de 2023.
A forma recomendada de obter a lista de tamanhos disponíveis é usar estes APIs:
Listar todos os tamanhos de máquinas virtuais disponíveis num conjunto de disponibilidade
Listar todos os tamanhos de máquinas virtuais disponíveis numa região
Lista todos os tamanhos de máquinas virtuais disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais.
Os tamanhos VM disponíveis dependem da região e do conjunto de disponibilidade.
Name | Type | Description |
---|---|---|
Basic_A0 |
|
|
Basic_A1 |
|
|
Basic_A2 |
|
|
Basic_A3 |
|
|
Basic_A4 |
|
|
Standard_A0 |
|
|
Standard_A1 |
|
|
Standard_A10 |
|
|
Standard_A11 |
|
|
Standard_A1_v2 |
|
|
Standard_A2 |
|
|
Standard_A2_v2 |
|
|
Standard_A2m_v2 |
|
|
Standard_A3 |
|
|
Standard_A4 |
|
|
Standard_A4_v2 |
|
|
Standard_A4m_v2 |
|
|
Standard_A5 |
|
|
Standard_A6 |
|
|
Standard_A7 |
|
|
Standard_A8 |
|
|
Standard_A8_v2 |
|
|
Standard_A8m_v2 |
|
|
Standard_A9 |
|
|
Standard_B1ms |
|
|
Standard_B1s |
|
|
Standard_B2ms |
|
|
Standard_B2s |
|
|
Standard_B4ms |
|
|
Standard_B8ms |
|
|
Standard_D1 |
|
|
Standard_D11 |
|
|
Standard_D11_v2 |
|
|
Standard_D12 |
|
|
Standard_D12_v2 |
|
|
Standard_D13 |
|
|
Standard_D13_v2 |
|
|
Standard_D14 |
|
|
Standard_D14_v2 |
|
|
Standard_D15_v2 |
|
|
Standard_D16_v3 |
|
|
Standard_D16s_v3 |
|
|
Standard_D1_v2 |
|
|
Standard_D2 |
|
|
Standard_D2_v2 |
|
|
Standard_D2_v3 |
|
|
Standard_D2s_v3 |
|
|
Standard_D3 |
|
|
Standard_D32_v3 |
|
|
Standard_D32s_v3 |
|
|
Standard_D3_v2 |
|
|
Standard_D4 |
|
|
Standard_D4_v2 |
|
|
Standard_D4_v3 |
|
|
Standard_D4s_v3 |
|
|
Standard_D5_v2 |
|
|
Standard_D64_v3 |
|
|
Standard_D64s_v3 |
|
|
Standard_D8_v3 |
|
|
Standard_D8s_v3 |
|
|
Standard_DS1 |
|
|
Standard_DS11 |
|
|
Standard_DS11_v2 |
|
|
Standard_DS12 |
|
|
Standard_DS12_v2 |
|
|
Standard_DS13 |
|
|
Standard_DS13-2_v2 |
|
|
Standard_DS13-4_v2 |
|
|
Standard_DS13_v2 |
|
|
Standard_DS14 |
|
|
Standard_DS14-4_v2 |
|
|
Standard_DS14-8_v2 |
|
|
Standard_DS14_v2 |
|
|
Standard_DS15_v2 |
|
|
Standard_DS1_v2 |
|
|
Standard_DS2 |
|
|
Standard_DS2_v2 |
|
|
Standard_DS3 |
|
|
Standard_DS3_v2 |
|
|
Standard_DS4 |
|
|
Standard_DS4_v2 |
|
|
Standard_DS5_v2 |
|
|
Standard_E16_v3 |
|
|
Standard_E16s_v3 |
|
|
Standard_E2_v3 |
|
|
Standard_E2s_v3 |
|
|
Standard_E32-16_v3 |
|
|
Standard_E32-8s_v3 |
|
|
Standard_E32_v3 |
|
|
Standard_E32s_v3 |
|
|
Standard_E4_v3 |
|
|
Standard_E4s_v3 |
|
|
Standard_E64-16s_v3 |
|
|
Standard_E64-32s_v3 |
|
|
Standard_E64_v3 |
|
|
Standard_E64s_v3 |
|
|
Standard_E8_v3 |
|
|
Standard_E8s_v3 |
|
|
Standard_F1 |
|
|
Standard_F16 |
|
|
Standard_F16s |
|
|
Standard_F16s_v2 |
|
|
Standard_F1s |
|
|
Standard_F2 |
|
|
Standard_F2s |
|
|
Standard_F2s_v2 |
|
|
Standard_F32s_v2 |
|
|
Standard_F4 |
|
|
Standard_F4s |
|
|
Standard_F4s_v2 |
|
|
Standard_F64s_v2 |
|
|
Standard_F72s_v2 |
|
|
Standard_F8 |
|
|
Standard_F8s |
|
|
Standard_F8s_v2 |
|
|
Standard_G1 |
|
|
Standard_G2 |
|
|
Standard_G3 |
|
|
Standard_G4 |
|
|
Standard_G5 |
|
|
Standard_GS1 |
|
|
Standard_GS2 |
|
|
Standard_GS3 |
|
|
Standard_GS4 |
|
|
Standard_GS4-4 |
|
|
Standard_GS4-8 |
|
|
Standard_GS5 |
|
|
Standard_GS5-16 |
|
|
Standard_GS5-8 |
|
|
Standard_H16 |
|
|
Standard_H16m |
|
|
Standard_H16mr |
|
|
Standard_H16r |
|
|
Standard_H8 |
|
|
Standard_H8m |
|
|
Standard_L16s |
|
|
Standard_L32s |
|
|
Standard_L4s |
|
|
Standard_L8s |
|
|
Standard_M128-32ms |
|
|
Standard_M128-64ms |
|
|
Standard_M128ms |
|
|
Standard_M128s |
|
|
Standard_M64-16ms |
|
|
Standard_M64-32ms |
|
|
Standard_M64ms |
|
|
Standard_M64s |
|
|
Standard_NC12 |
|
|
Standard_NC12s_v2 |
|
|
Standard_NC12s_v3 |
|
|
Standard_NC24 |
|
|
Standard_NC24r |
|
|
Standard_NC24rs_v2 |
|
|
Standard_NC24rs_v3 |
|
|
Standard_NC24s_v2 |
|
|
Standard_NC24s_v3 |
|
|
Standard_NC6 |
|
|
Standard_NC6s_v2 |
|
|
Standard_NC6s_v3 |
|
|
Standard_ND12s |
|
|
Standard_ND24rs |
|
|
Standard_ND24s |
|
|
Standard_ND6s |
|
|
Standard_NV12 |
|
|
Standard_NV24 |
|
|
Standard_NV6 |
|
VMDiskSecurityProfile
Especifica as definições de perfil de segurança para o disco gerido.
NOTA: Só pode ser definido para VMs confidenciais
Name | Type | Description |
---|---|---|
diskEncryptionSet |
Especifica o id de conjunto de encriptação de disco gerido pelo cliente para o disco gerido que é utilizado para a chave gerida pelo cliente confidencialVM OS Disco e vMGuest blob. |
|
securityEncryptionType |
Especifica oType de Encriptação do disco gerido. |
VMGalleryApplication
Especifica as informações necessárias para fazer referência a uma versão de aplicação de galeria de computação
Name | Type | Description |
---|---|---|
configurationReference |
|
Opcional, especifica o uri a uma bolha azul que substituirá a configuração padrão para o pacote se fornecido |
enableAutomaticUpgrade |
|
Se for definido como verdadeiro, quando uma nova versão da Aplicação da Galeria estiver disponível em PIR/SIG, será automaticamente atualizado para o VM/VMSS |
order |
|
Opcional, especifica a ordem em que os pacotes têm de ser instalados |
packageReferenceId |
|
Especifica o id de recurso GalleryApplicationVersion sob a forma de /subscrições/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} |
tags |
|
Opcional, especifica um valor de passagem para um contexto mais genérico. |
treatFailureAsDeploymentFailure |
|
Opcional, se for verdade, qualquer falha para qualquer operação no VmApplication falhará na implementação |
VMSizeProperties
Especifica as definições de propriedade do tamanho VM na máquina virtual.
Name | Type | Description |
---|---|---|
vCPUsAvailable |
|
Especifica o número de vCPUs disponíveis para o VM. |
vCPUsPerCore |
|
Especifica a relação vCPU com o núcleo físico. |
WindowsConfiguration
Especifica Windows definições do sistema operativo na máquina virtual.
Name | Type | Description |
---|---|---|
additionalUnattendContent |
Especifica informações adicionais codificadas de XML codificadas que podem ser incluídas no ficheiro Unattend.xml, que é usado por Windows Configuração. |
|
enableAutomaticUpdates |
|
Indica se as atualizações automáticas estão ativadas para a Windows máquina virtual. O valor predefinido é verdadeiro. |
patchSettings |
[Recurso de pré-visualização] Especifica as definições relacionadas com o Patching de Hóspedes VM no Windows. |
|
provisionVMAgent |
|
Indica se o agente de máquinas virtuais deve ser a provisionado na máquina virtual. |
timeZone |
|
Especifica o fuso horário da máquina virtual. por exemplo, "Tempo Padrão do Pacífico". |
winRM |
Especifica os ouvintes de Gestão Remota Windows. Isto permite Windows PowerShell remotos. |
WindowsPatchAssessmentMode
Especifica o modo de avaliação do patch do VM Guest para a máquina virtual IaaS.
Os valores possíveis são:
ImageDefault - Controla o tempo das avaliações de patchs numa máquina virtual.
AutomaticByPlatform - A plataforma irá desencadear avaliações periódicas de correção. O fornecimento de propriedadeVMAgent deve ser verdade.
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
|
|
ImageDefault |
|
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.
Name | Type | Description |
---|---|---|
Always |
|
|
IfRequired |
|
|
Never |
|
|
Unknown |
|
WindowsVMGuestPatchAutomaticByPlatformSettings
Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições Windows patch.
Name | Type | Description |
---|---|---|
rebootSetting |
Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform. |
WindowsVMGuestPatchMode
Especifica o modo de Remendar convidados VM para máquina virtual IaaS ou máquinas virtuais associadas à escala de máquina virtual definida com OrchestrationMode como Flexível.
Os valores possíveis são:
Manual - Controla a aplicação de patches numa máquina virtual. Fá-lo aplicando remendos manualmente dentro do VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falso
AutomaticamenteByOS - A máquina virtual será automaticamente atualizada pelo SISTEMA. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdade.
AutomaticByPlatform - a máquina virtual será automaticamente atualizada pela plataforma. O fornecimento de propriedadesVMAgent e WindowsConfiguration.enableAutomaticUpdates deve ser verdadeiro
Name | Type | Description |
---|---|---|
AutomaticByOS |
|
|
AutomaticByPlatform |
|
|
Manual |
|
WinRMConfiguration
Descreve Windows configuração de Gestão Remota do VM
Name | Type | Description |
---|---|---|
listeners |
A lista de ouvintes de Windows De Gestão Remota |
WinRMListener
Descreve o Protocolo e a impressão digital do ouvinte de gestão remota Windows
Name | Type | Description |
---|---|---|
certificateUrl |
|
Esta é a URL de um certificado que foi enviado para Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre da chave. Neste caso, o seu certificado tem de ser a codificação Base64 do seguinte Objeto JSON que está codificado em UTF-8: |
protocol |
Especifica o protocolo do ouvinte winRM. |