Virtual Machines - Create Or Update

Esta página é útil?

Algum comentário adicional?

Os comentários serão enviados para a Microsoft: ao premir o botão de submissão, os seus comentários serão utilizados para melhorar os produtos e serviços da Microsoft. Política de privacidade.

Service:

Compute

API Version:

2022-03-01

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
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	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.
vmName	path	True	string	O nome da máquina virtual.
api-version	query	True	string	Versão Api do cliente.

Corpo do Pedido

Name	Required	Type	Description
location	True	string	Localização do recurso
extendedLocation		ExtendedLocation	A localização alargada da Máquina Virtual.
identity		VirtualMachineIdentity	A identidade da máquina virtual, se configurada.
plan		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 "Quero implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar.
properties.additionalCapabilities		AdditionalCapabilities	Especifica capacidades adicionais ativadas ou desativadas na máquina virtual.
properties.applicationProfile		ApplicationProfile	Especifica as aplicações de galeria que devem ser disponibilizadas ao VM/VMSS
properties.availabilitySet		SubResource	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. Para obter mais informações sobre a manutenção planeada da Azure, consulte Manutenção e atualizações para Máquinas Virtuais em Azure Atualmente, um VM só pode ser adicionado à disponibilidade definida no momento da criação. O conjunto de disponibilidade a que o VM está a ser adicionado deve estar no mesmo grupo de recursos que o recurso definido pela disponibilidade. Um VM existente não pode ser adicionado a um conjunto de disponibilidade. Esta propriedade não pode existir juntamente com uma referência não nulo.virtualMachineScaleSet.
properties.billingProfile		BillingProfile	Especifica os detalhes relacionados com a faturação de uma máquina virtual Azure Spot. Versão mínima da API: 2019-03-01.
properties.capacityReservation		CapacityReservationProfile	Especifica informações sobre a reserva de capacidade que é usada para alocar máquina virtual. Versão mínima da API: 2021-04-01.
properties.diagnosticsProfile		DiagnosticsProfile	Especifica o estado das definições de diagnóstico da bota. Versão mínima api: 2015-06-15.
properties.evictionPolicy		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.
properties.extensionsTimeBudget		string	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). Versão mínima da API: 2020-06-01
properties.hardwareProfile		HardwareProfile	Especifica as definições de hardware para a máquina virtual.
properties.host		SubResource	Especifica informações sobre o hospedeiro dedicado em que a máquina virtual reside. Versão mínima da API: 2018-10-01.
properties.hostGroup		SubResource	Especifica informações sobre o grupo de anfitriões dedicado em que a máquina virtual reside. Versão mínima da API: 2020-06-01. NOTA: O utilizador não pode especificar as propriedades do host e do HostGroup.
properties.licenseType		string	Especifica que a imagem ou disco que está a ser utilizado foi licenciado no local. Os valores possíveis para Windows sistema operativo do Servidor são: Windows_Client Windows_Server Os valores possíveis para o sistema operativo Linux Server são: RHEL_BYOS (para RHEL) SLES_BYOS (para SUSE) Para mais informações, consulte O Benefício de Utilização Híbrida Azure para Windows Servidor Benefício de utilização híbrida Azure para o servidor Linux Versão api mínima: 2015-06-15
properties.networkProfile		NetworkProfile	Especifica as interfaces de rede da máquina virtual.
properties.osProfile		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		integer	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. Isto só é aplicável se a propriedade 'virtualMachineScaleSet' desta Máquina Virtual estiver definida. O Conjunto de Escala de Máquina Virtual que é referenciado, deve ter 'platformFaultDomainCount' > 1. Esta propriedade não pode ser atualizada uma vez que a Máquina Virtual é criada. A atribuição de domínio de avaria pode ser visualizada na Visualização de Instância da Máquina Virtual. Versão mínima api‐‐12‐01
properties.priority		VirtualMachinePriorityTypes	Especifica a prioridade para a máquina virtual. Versão mínima da API: 2019-03-01
properties.proximityPlacementGroup		SubResource	Especifica informações sobre o grupo de colocação de proximidade a que a máquina virtual deve ser atribuída. Versão mínima da API: 2018-04-01.
properties.scheduledEventsProfile		ScheduledEventsProfile	Especifica configurações relacionadas com eventos programados.
properties.securityProfile		SecurityProfile	Especifica as definições de perfil relacionados com a Segurança para a máquina virtual.
properties.storageProfile		StorageProfile	Especifica as definições de armazenamento dos discos de máquinas virtuais.
properties.userData		string	UserData para o VM, que deve ser codificado base-64. O cliente não deve passar segredos aqui. Versão mínima da API: 2021-03-01
properties.virtualMachineScaleSet		SubResource	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. Esta propriedade não pode existir juntamente com uma referência de não nulo.availabilitySet. Versão mínima api‐‐01: 2019‐03‐01
tags		object	Etiquetas de recursos
zones		string[]	As zonas de máquinas virtuais.

Respostas

Name	Type	Description
200 OK	VirtualMachine	OK
201 Created	VirtualMachine	Criado
Other Status Codes	CloudError	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.

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

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

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

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

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

Create a VM from a community gallery image

Create a vm from a custom image.

Create a vm from a generalized shared image.

Create a VM from a shared gallery image

Create a vm from a specialized shared image.

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

Create a vm in an availability set.

Create a vm with a marketplace image plan.

Create a vm with an extensions time budget.

Create a vm with Application Profile.

Create a vm with boot diagnostics.

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

Create a vm with empty data disks.

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

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

Create a vm with ephemeral os disk.

Create a VM with HibernationEnabled

Create a vm with Host Encryption using encryptionAtHost property.

Create a vm with managed boot diagnostics.

Create a VM with network interface configuration

Create a vm with password authentication.

Create a vm with premium storage.

Create a vm with Scheduled Events Profile

Create a VM with securityType ConfidentialVM with Customer Managed Keys

Create a VM with securityType ConfidentialVM with Platform Managed Keys

Create a vm with ssh authentication.

Create a VM with Uefi Settings of secureBoot and vTPM.

Create a VM with UserData

Create a VM with VM Size Properties

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

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

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

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

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

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

Create or update a VM with capacity reservation

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

{
  "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

Status code:

200

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

Status code:

201

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "linuxConfiguration": {
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never"
          }
        }
      }
    },
    "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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm from a custom image.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm from a generalized shared image.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm from a specialized shared image.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm in an availability set.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with a marketplace image plan.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with an extensions time budget.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with Application Profile.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with boot diagnostics.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with 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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with empty data disks.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with 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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with ephemeral os disk provisioning in 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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with ephemeral os disk.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with HibernationEnabled

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with Host Encryption using encryptionAtHost property.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with managed boot diagnostics.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with network interface configuration

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with password authentication.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with premium storage.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with 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

Request Body

{
  "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

Status code:

200

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

Status code:

201

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with securityType ConfidentialVM with 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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a vm with ssh authentication.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with Uefi Settings of secureBoot and vTPM.

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with UserData

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create a VM with VM Size Properties

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

{
  "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

Status code:

200

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

Status code:

201

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "properties": {
    "osProfile": {
      "adminUsername": "{your-username}",
      "secrets": [],
      "computerName": "myVM",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true,
        "patchSettings": {
          "patchMode": "AutomaticByPlatform",
          "assessmentMode": "AutomaticByPlatform",
          "automaticByPlatformSettings": {
            "rebootSetting": "Never"
          }
        }
      }
    },
    "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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

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

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Create or update a VM with capacity reservation

Sample Request

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

Request Body

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

Sample Response

Status code:

200

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

Status code:

201

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

Definições

AdditionalCapabilities	Ativa ou desativa uma capacidade na máquina virtual ou no conjunto de escala de máquina virtual.
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.
ApiError	Erro da Api.
ApiErrorBase	Base de erro da Api.
ApplicationProfile	Contém a lista de 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.
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.
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.
BootDiagnosticsInstanceView	A visão de um diagnóstico virtual de arranque de máquina.
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.
CapacityReservationProfile	Os parâmetros de um perfil de reserva de capacidade.
CloudError	Uma resposta de erro do serviço Compute.
ComponentNames	O nome do componente. Atualmente, o único valor permitido é o Microsoft-Windows-Shell-Setup.
DataDisk	Descreve um disco de dados.
DeleteOptions	Especificar o que acontece ao endereço IP público quando o VM é eliminado
DiagnosticsProfile	Especifica o estado das definições de diagnóstico da bota. Versão mínima api: 2015-06-15.
DiffDiskOptions	Especifica as definições do disco efémero para o disco do sistema operativo.
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
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.
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.
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.
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'.
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.
DiskEncryptionSettings	Descreve um Definições de encriptação para um disco
DiskInstanceView	A visão do disco.
ExtendedLocation	O tipo complexo da localização estendida.
ExtendedLocationTypes	O tipo de localização estendida.
HardwareProfile	Especifica as definições de hardware para a máquina virtual.
HyperVGenerationType	Especifica o Tipo de HiperVGeneração associado a um recurso
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.
InnerError	Detalhes de erro internos.
InstanceViewStatus	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'.
KeyVaultKeyReference	Descreve uma referência a Key Vault Chave
KeyVaultSecretReference	Descreve uma referência a Key Vault Segredo
LastPatchInstallationSummary	Descreve as propriedades do último resumo do patch instalado.
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.
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.
LinuxPatchSettings	Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições de patch do Linux.
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
MaintenanceOperationResultCodeTypes	O último código de resultados da operação de manutenção.
MaintenanceRedeployStatus	Estado da Operação de Manutenção.
ManagedDiskParameters	Os parâmetros de um disco gerido.
NetworkApiVersion	especifica a versão API da Microsoft.Network utilizada na criação de recursos de rede nas Configurações de Interface de Rede
NetworkInterfaceReference	Descreve uma referência de interface de rede.
NetworkProfile	Especifica as interfaces de rede ou a configuração de rede da 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
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.
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.
PassNames	O nome do passe. Atualmente, o único valor admissível é o 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".
PatchSettings	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 "Quero implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar.
ProtocolTypes	Especifica o protocolo do ouvinte winRM. Os valores possíveis são: http https
PublicIPAddressSku	Descreve o IP Sku público. Só pode ser definido com OrchestrationMode como Flexível.
PublicIPAddressSkuName	Especificar o nome de sku IP público
PublicIPAddressSkuTier	Especificar o nível de sku IP público
PublicIPAllocationMethod	Especificar o tipo de atribuição de IP público
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.
ScheduledEventsProfile
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.
SecurityProfile	Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de escala de 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.
SettingNames	Especifica o nome da definição a que o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.
SshConfiguration	Configuração SSH para VMs baseados em Linux em execução em Azure
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.
StatusLevelTypes	O código de nível.
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.
StorageProfile	Especifica as definições de armazenamento dos discos de máquinas virtuais.
SubResource
TerminateNotificationProfile
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
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}'.
VaultCertificate	Descreve uma única referência de certificado num Key Vault e onde o certificado deve residir no VM.
VaultSecretGroup	Descreve um conjunto de certificados que estão todos na mesma Key Vault.
VirtualHardDisk	Descreve o uri de um disco.
VirtualMachine	Descreve uma máquina virtual.
VirtualMachineAgentInstanceView	A visão do agente VM a funcionar na máquina virtual.
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.
VirtualMachineExtension	Descreve uma extensão virtual da máquina.
VirtualMachineExtensionHandlerInstanceView	A visão de um manipulador de extensão de máquina virtual.
VirtualMachineExtensionInstanceView	A visão de uma extensão de máquina virtual.
VirtualMachineHealthStatus	O estado de saúde do VM.
VirtualMachineIdentity	Identidade para a máquina virtual.
VirtualMachineInstanceView	A visão de uma máquina virtual.
VirtualMachineIpTag	Contém a etiqueta IP associada ao endereço IP público.
VirtualMachineNetworkInterfaceConfiguration	Descreve configurações de interface de rede de máquinas virtuais.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Descreve as definições de DNS de configuração de rede de máquinas virtuais.
VirtualMachineNetworkInterfaceIPConfiguration	Descreve a configuração IP de um perfil de rede de máquina virtual.
VirtualMachinePatchStatus	O estado das operações de correção de máquinas virtuais.
VirtualMachinePriorityTypes	Especifica a prioridade para a máquina virtual. Versão mínima da API: 2019-03-01
VirtualMachinePublicIPAddressConfiguration	Descreve uma configuração de endereço publicipad de configuração de máquinas virtuais ip
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Descreve as definições de DNS de configuração de rede de máquinas virtuais.
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.
VMDiskSecurityProfile	Especifica as definições de perfil de segurança para o disco gerido. NOTA: Só pode ser definido para VMs confidenciais
VMGalleryApplication	Especifica as informações necessárias para fazer referência a uma versão de aplicação de galeria de computação
VMSizeProperties	Especifica as definições de propriedade do tamanho VM na máquina virtual.
WindowsConfiguration	Especifica Windows definições do sistema operativo na máquina virtual.
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.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições Windows patch.
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
WinRMConfiguration	Descreve Windows configuração de Gestão Remota do VM
WinRMListener	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	boolean	A bandeira que permite ou desativa a capacidade de hibernação no VM.
ultraSSDEnabled	boolean	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	ComponentNames	O nome do componente. Atualmente, o único valor permitido é o Microsoft-Windows-Shell-Setup.
content	string	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	PassNames	O nome do passe. Atualmente, o único valor admissível é o OobeSystem.
settingName	SettingNames	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	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro particular.

ApiErrorBase

Base de erro da Api.

Name	Type	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	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	VMGalleryApplication[]	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	string	O ID de atividade da operação que produziu este resultado. É usado para correlacionar através de CRP e registos de extensão.
criticalAndSecurityPatchCount	integer	O número de patches críticos ou de segurança que tenham sido detetados como disponíveis e ainda não instalados.
error	ApiError	Os erros que foram encontrados durante a execução da operação. A matriz de detalhes contém a lista deles.
lastModifiedTime	string	O calendário utc quando a operação começou.
otherPatchCount	integer	O número de todos os patches disponíveis, excluindo crítico e de segurança.
rebootPending	boolean	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	string	O calendário utc quando a operação começou.
status	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".

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	number	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. Este preço será comparado com o preço atual do Azure Spot para o tamanho VM. Além disso, os preços são comparados no momento da criação/atualização do Azure Spot VM/VMSS e a operação só terá sucesso se o maxPrice for maior do que o preço atual do Azure Spot. O maxPrice também será utilizado para despejar um VM/VMSS Azure Spot se o preço atual do Azure Spot for além do máximo de preço após a criação de VM/VMSS. Os valores possíveis são: - Qualquer valor decimal superior a zero. Exemplo: 0.01538 -1 - indica que o preço por defeito está a subir para a procura. Pode definir o maxPrice para -1 para indicar que o VM/VMSS Azure Spot não deve ser despejado por razões de preço. Além disso, o preço máximo predefinido é de -1 se não for fornecido por si. Versão mínima da API: 2019-03-01.

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	boolean	Se os diagnósticos de arranque devem ser ativados na Máquina Virtual.
storageUri	string	Uri da conta de armazenamento para usar para colocar a saída da consola e a imagem. Se o armazenamentoUri não for especificado enquanto permite diagnósticos de arranque, será utilizado um armazenamento gerido.

BootDiagnosticsInstanceView

A visão de um diagnóstico virtual de arranque de máquina.

Name	Type	Description
consoleScreenshotBlobUri	string	A imagem da consola blob URI. NOTA: Isto não será definido se os diagnósticos de arranque estiverem atualmente ativados com armazenamento gerido.
serialConsoleLogBlobUri	string	O registo de consola em série blob Uri. NOTA: Isto não será definido se os diagnósticos de arranque estiverem atualmente ativados com armazenamento gerido.
status	InstanceViewStatus	A informação do estado do diagnóstico da bota para o VM. NOTA: Só será definido se houver erros na ativação do diagnóstico da bota.

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	string
ReadOnly	string
ReadWrite	string

CapacityReservationProfile

Os parâmetros de um perfil de reserva de capacidade.

Name	Type	Description
capacityReservationGroup	SubResource	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	ApiError	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	string

DataDisk

Descreve um disco de dados.

Name	Type	Description
caching	CachingTypes	Especifica os requisitos de caching. Os valores possíveis são: Nenhuma ReadOnly LerWrite Padrão: Nenhum para armazenamento standard. ReadOnly para armazenamento Premium
createOption	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.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco de dados deve ser eliminado ou desapegado após a eliminação de VM. Valores possíveis: Excluir Se este valor for utilizado, o disco de dados é eliminado quando o VM é eliminado. Separar Se este valor for utilizado, o disco de dados é retido após a eliminar do VM. O valor predefinido é definido para separar
detachOption	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'.
diskIOPSReadWrite	integer	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	integer	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	integer	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. Este valor não pode ser maior que 1023 GB
image	VirtualHardDisk	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	integer	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	ManagedDiskParameters	Os parâmetros do disco geridos.
name	string	O nome do disco.
toBeDetached	boolean	Especifica se o disco de dados está em processo de desprendimento a partir do VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	O disco rígido virtual.
writeAcceleratorEnabled	boolean	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	string
Detach	string

DiagnosticsProfile

Especifica o estado das definições de diagnóstico da bota.

Versão mínima api: 2015-06-15.

Name	Type	Description
bootDiagnostics	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. NOTA: Se o armazenamentoUri estiver a ser especificado, certifique-se de que a conta de armazenamento está na mesma região e subscrição que o 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.

DiffDiskOptions

Especifica as definições do disco efémero para o disco do sistema operativo.

Name	Type	Description
Local	string

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	string
ResourceDisk	string

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	DiffDiskOptions	Especifica as definições do disco efémero para o disco do sistema operativo.
placement	DiffDiskPlacement	Especifica a colocação do disco efémero para o disco do sistema operativo. Os valores possíveis são: CacheDisk Disco de recursos Predefinição: CacheDisk se um estiver configurado para o tamanho VM, caso contrário o ResourceDisk é utilizado. Consulte a documentação do tamanho de VM para Windows VM https://docs.microsoft.com/azure/virtual-machines/windows/sizes e Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais os tamanhos VM que expõem um disco de cache.

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	string
Empty	string
FromImage	string

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	string
Detach	string

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	string

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	string	ID de recursos

DiskEncryptionSettings

Descreve um Definições de encriptação para um disco

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica a localização da chave de encriptação do disco, que é uma Key Vault Secret.
enabled	boolean	Especifica se a encriptação do disco deve ser ativada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica a localização da chave de encriptação em Key Vault.

DiskInstanceView

A visão do disco.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica as definições de encriptação para o disco OS. Versão api mínima: 2015-06-15
name	string	O nome do disco.
statuses	InstanceViewStatus[]	A informação sobre o estado dos recursos.

ExtendedLocation

O tipo complexo da localização estendida.

Name	Type	Description
name	string	O nome da localização estendida.
type	ExtendedLocationTypes	O tipo de localização estendida.

ExtendedLocationTypes

O tipo de localização estendida.

Name	Type	Description
EdgeZone	string

HardwareProfile

Especifica as definições de hardware para a máquina virtual.

Name	Type	Description
vmSize	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.
vmSizeProperties	VMSizeProperties	Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima da API: 2021-07-01. Esta funcionalidade ainda se encontra no modo de pré-visualização e não é suportada para VirtualMachineScaleSet. Siga as instruções na Personalização VM para mais detalhes.

HyperVGenerationType

Especifica o Tipo de HiperVGeneração associado a um recurso

Name	Type	Description
V1	string
V2	string

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	string	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	string	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	string	ID de recursos
offer	string	Especifica a oferta da imagem da plataforma ou imagem de mercado usada para criar a máquina virtual.
publisher	string	O editor de imagem.
sharedGalleryImageId	string	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	string	A imagem SKU.
version	string	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	string	A mensagem de erro interna ou o despejo de exceções.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Estado da visualização de instância.

Name	Type	Description
code	string	O código de estado.
displayStatus	string	A etiqueta loisável curta para o estado.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.
time	string	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	string
IPv6	string

KeyVaultKeyReference

Descreve uma referência a Key Vault Chave

Name	Type	Description
keyUrl	string	O URL refere uma chave de encriptação chave em Key Vault.
sourceVault	SubResource	O URL relativo do Key Vault que contém a chave.

KeyVaultSecretReference

Descreve uma referência a Key Vault Segredo

Name	Type	Description
secretUrl	string	A URL refere-se a um segredo numa Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault contendo o segredo.

LastPatchInstallationSummary

Descreve as propriedades do último resumo do patch instalado.

Name	Type	Description
error	ApiError	Os erros que foram encontrados durante a execução da operação. A matriz de detalhes contém a lista deles.
excludedPatchCount	integer	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	integer	A contagem de remendos que falharam na instalação.
installationActivityId	string	O ID de atividade da operação que produziu este resultado. É usado para correlacionar através de CRP e registos de extensão.
installedPatchCount	integer	A contagem de remendos que instalaram com sucesso.
lastModifiedTime	string	O calendário utc quando a operação começou.
maintenanceWindowExceeded	boolean	Descreve se a operação esgotou o tempo antes de concluir todas as suas ações pretendidas
notSelectedPatchCount	integer	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	integer	Espera-se que o número de remendos disponíveis seja instalado durante a operação de instalação do patch.
startTime	string	O calendário utc quando a operação começou.
status	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".

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	boolean	Especifica se a autenticação de palavra-passe deve ser desativada.
patchSettings	LinuxPatchSettings	[Recurso de pré-visualização] Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux.
provisionVMAgent	boolean	Indica se o agente de máquinas virtuais deve ser a provisionado na máquina virtual. Quando esta propriedade não é especificada no corpo de pedido, o comportamento padrão é defini-lo como verdadeiro. Isto garantirá a instalação do Agente VM no VM para que as extensões possam ser adicionadas mais tarde ao VM.
ssh	SshConfiguration	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	string
ImageDefault	string

LinuxPatchSettings

Especifica as definições relacionadas com o Patching de Hóspedes VM no Linux.

Name	Type	Description
assessmentMode	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.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais para o modo de correção AutomaticByPlatform em VM Guest Patching em Linux.
patchMode	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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.

Name	Type	Description
Always	string
IfRequired	string
Never	string
Unknown	string

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	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	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	string
ImageDefault	string

MaintenanceOperationResultCodeTypes

O último código de resultados da operação de manutenção.

Name	Type	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Estado da Operação de Manutenção.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	É verdade, se o cliente estiver autorizado a realizar a Manutenção.
lastOperationMessage	string	Mensagem devolvida para a última Operação de Manutenção.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	O último código de resultados da operação de manutenção.
maintenanceWindowEndTime	string	Fim do tempo para a janela de manutenção.
maintenanceWindowStartTime	string	Hora de início para a janela de manutenção.
preMaintenanceWindowEndTime	string	Fim do tempo para a janela de pré manutenção.
preMaintenanceWindowStartTime	string	Hora de início para a janela de pré manutenção.

ManagedDiskParameters

Os parâmetros de um disco gerido.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica o id de conjunto de encriptação do disco gerido pelo cliente para o disco gerido.
id	string	ID de recursos
securityProfile	VMDiskSecurityProfile	Especifica o perfil de segurança para o disco gerido.
storageAccountType	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.

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	string

NetworkInterfaceReference

Descreve uma referência de interface de rede.

Name	Type	Description
id	string	ID de recursos
properties.deleteOption	DeleteOptions	Especificar o que acontece à interface de rede quando o VM é eliminado
properties.primary	boolean	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	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	VirtualMachineNetworkInterfaceConfiguration[]	Especifica as configurações de rede que serão usadas para criar os recursos de rede de máquinas virtuais.
networkInterfaces	NetworkInterfaceReference[]	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	string
Windows	string

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	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.
createOption	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.
deleteOption	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.
diffDiskSettings	DiffDiskSettings	Especifica o disco efémero Definições para o disco do sistema operativo utilizado pela máquina virtual.
diskSizeGB	integer	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. Este valor não pode ser maior que 1023 GB
encryptionSettings	DiskEncryptionSettings	Especifica as definições de encriptação para o disco OS. Versão api mínima: 2015-06-15
image	VirtualHardDisk	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	ManagedDiskParameters	Os parâmetros do disco geridos.
name	string	O nome do disco.
osType	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
vhd	VirtualHardDisk	O disco rígido virtual.
writeAcceleratorEnabled	boolean	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	string	Especifica a palavra-passe da conta do administrador. Comprimento mínimo (Windows): 8 caracteres Comprimento mínimo (Linux): 6 caracteres Comprimento máximo (Windows): 123 caracteres Comprimento máximo (Linux): 72 caracteres Requisitos de complexidade: 3 em 4 condições abaixo precisam de ser preenchidos Tem caracteres mais baixos Tem caracteres superiores Tem um dígito Tem um caráter especial (Regex match [\W_]) Valores não permitidos: "abc@123P@$$w 0rd", "", "P@ssw0rdP@ssword123Pa$$word", "pass@word1Password!", "Password1", "Password22", "iloveyou!" Para redefinir a palavra-passe, consulte como redefinir o serviço de ambiente de trabalho remoto ou a sua palavra-passe de login num VM Windows Para redefinir a palavra-passe de raiz, consulte Gerir utilizadores, SSH e verificar ou reparar discos em VMs Azure Linux utilizando a Extensão VMAccess
adminUsername	string	Especifica o nome da conta do administrador. Esta propriedade não pode ser atualizada após a criação do VM. Windows restrição: Não pode terminar em "" Valores não permitidos: "Administrador", "administrador", "utilizador", "utilizador1", "teste", "utilizador2", "teste1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "consola", "david", "guest", "john", "proprietário", "root", "servidor", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Comprimento mínimo (Linux): 1 caracteres Comprimento máximo (Linux): 64 caracteres Comprimento máximo (Windows): 20 caracteres.
allowExtensionOperations	boolean	Especifica se as operações de extensão devem ser permitidas na máquina virtual. Isto só pode ser definido como Falso quando não houver extensões na máquina virtual.
computerName	string	Especifica o nome de hospedeiro da máquina virtual. Este nome não pode ser atualizado após a criação do VM. Comprimento máximo (Windows): 15 caracteres Comprimento máximo (Linux): 64 caracteres. Para nomear convenções e restrições consulte as diretrizes de implementação dos serviços de infraestrutura Azure.
customData	string	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. Nota: Não passe segredos ou senhas na propriedade customData Esta propriedade não pode ser atualizada após a criação do VM. customData é passado para o VM para ser guardado como um ficheiro, para mais informações ver Dados Personalizados em VMs Azure Para utilizar o cloud-init para o seu Linux VM, consulte utilizar o cloud-init para personalizar um Linux VM durante a criação
linuxConfiguration	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.
requireGuestProvisionSignal	boolean	Propriedade opcional que deve ser definida para Verdadeiro ou omitida.
secrets	VaultSecretGroup[]	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	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	string

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	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

PatchSettings

Especifica as definições relacionadas com o Patching de Hóspedes VM no Windows.

Name	Type	Description
assessmentMode	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.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais para o modo de correção AutomaticByPlatform em VM Guest Patching em Windows.
enableHotpatching	boolean	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	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

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 "Quero implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar.

Name	Type	Description
name	string	A identificação do plano.
product	string	Especifica o produto da imagem do mercado. Este é o mesmo valor que a Oferta sob o elemento imageReference.
promotionCode	string	O código de promoção.
publisher	string	A identificação da editora.

ProtocolTypes

Especifica o protocolo do ouvinte winRM.

Os valores possíveis são:
http

https

Name	Type	Description
Http	string
Https	string

PublicIPAddressSku

Descreve o IP Sku público. Só pode ser definido com OrchestrationMode como Flexível.

Name	Type	Description
name	PublicIPAddressSkuName	Especificar o nome de sku IP público
tier	PublicIPAddressSkuTier	Especificar o nível de sku IP público

PublicIPAddressSkuName

Especificar o nome de sku IP público

Name	Type	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

Especificar o nível de sku IP público

Name	Type	Description
Global	string
Regional	string

PublicIPAllocationMethod

Especificar o tipo de atribuição de IP público

Name	Type	Description
Dynamic	string
Static	string

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	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ScheduledEventsProfile

Name	Type	Description
terminateNotificationProfile	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	string
VMGuestStateOnly	string

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	boolean	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. Predefinição: A Encriptação no anfitrião será desativada a menos que esta propriedade seja definida como verdadeira para o recurso.
securityType	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.
uefiSettings	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

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	string
TrustedLaunch	string

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	string
FirstLogonCommands	string

SshConfiguration

Configuração SSH para VMs baseados em Linux em execução em Azure

Name	Type	Description
publicKeys	SshPublicKey[]	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	string	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. Para criar teclas ssh, consulte [Criar teclas SSH em Linux e Mac para Linux VMs em Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	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	string
Info	string
Warning	string

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	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Especifica as definições de armazenamento dos discos de máquinas virtuais.

Name	Type	Description
dataDisks	DataDisk[]	Especifica os parâmetros utilizados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais Azure.
imageReference	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	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.

SubResource

Name	Type	Description
id	string	ID de recursos

TerminateNotificationProfile

Name	Type	Description
enable	boolean	Especifica se o evento programado de rescisão está ativado ou desativado.
notBeforeTimeout	string	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	boolean	Especifica se o arranque seguro deve ser ativado na máquina virtual. Versão mínima da API: 2020-12-01
vTpmEnabled	boolean	Especifica se vTPM deve ser ativado na máquina virtual. Versão mínima da API: 2020-12-01

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	string	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. Para os VMs Linux, o ficheiro de certificado é colocado sob o diretório /var/lib/waagent, com o nome <de ficheiro UppercaseThumbprint.crt> para o ficheiro de certificado X509 e <UppercaseThumbprint.prv> para chave privada. Ambos os ficheiros são formatados .pem.
certificateUrl	string	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: { "dados":"<> de certificado codificado base64", "dataType":"pfx", "password":"<> de senha de ficheiro pfx" } 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.

VaultSecretGroup

Descreve um conjunto de certificados que estão todos na mesma Key Vault.

Name	Type	Description
sourceVault	SubResource	O URL relativo do Key Vault contendo todos os certificados em Certificados de Abóbada.
vaultCertificates	VaultCertificate[]	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	string	Especifica o uri do disco rígido virtual.

VirtualMachine

Descreve uma máquina virtual.

Name	Type	Description
extendedLocation	ExtendedLocation	A localização alargada da Máquina Virtual.
id	string	ID de recursos
identity	VirtualMachineIdentity	A identidade da máquina virtual, se configurada.
location	string	Localização do recurso
name	string	Nome do recurso
plan	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 "Quero implementar programáticamente, Introdução ->. Introduza todas as informações necessárias e clique em Guardar.
properties.additionalCapabilities	AdditionalCapabilities	Especifica capacidades adicionais ativadas ou desativadas na máquina virtual.
properties.applicationProfile	ApplicationProfile	Especifica as aplicações de galeria que devem ser disponibilizadas ao VM/VMSS
properties.availabilitySet	SubResource	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. Para obter mais informações sobre a manutenção planeada da Azure, consulte Manutenção e atualizações para Máquinas Virtuais em Azure Atualmente, um VM só pode ser adicionado à disponibilidade definida no momento da criação. O conjunto de disponibilidade a que o VM está a ser adicionado deve estar no mesmo grupo de recursos que o recurso definido pela disponibilidade. Um VM existente não pode ser adicionado a um conjunto de disponibilidade. Esta propriedade não pode existir juntamente com uma referência não nulo.virtualMachineScaleSet.
properties.billingProfile	BillingProfile	Especifica os detalhes relacionados com a faturação de uma máquina virtual Azure Spot. Versão mínima da API: 2019-03-01.
properties.capacityReservation	CapacityReservationProfile	Especifica informações sobre a reserva de capacidade que é usada para alocar máquina virtual. Versão mínima da API: 2021-04-01.
properties.diagnosticsProfile	DiagnosticsProfile	Especifica o estado das definições de diagnóstico da bota. Versão mínima api: 2015-06-15.
properties.evictionPolicy	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.
properties.extensionsTimeBudget	string	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). Versão mínima da API: 2020-06-01
properties.hardwareProfile	HardwareProfile	Especifica as definições de hardware para a máquina virtual.
properties.host	SubResource	Especifica informações sobre o hospedeiro dedicado em que a máquina virtual reside. Versão mínima da API: 2018-10-01.
properties.hostGroup	SubResource	Especifica informações sobre o grupo de anfitriões dedicado em que a máquina virtual reside. Versão mínima da API: 2020-06-01. NOTA: O utilizador não pode especificar as propriedades do host e do HostGroup.
properties.instanceView	VirtualMachineInstanceView	A visão de exemplo de máquina virtual.
properties.licenseType	string	Especifica que a imagem ou disco que está a ser utilizado foi licenciado no local. Os valores possíveis para Windows sistema operativo do Servidor são: Windows_Client Windows_Server Os valores possíveis para o sistema operativo Linux Server são: RHEL_BYOS (para RHEL) SLES_BYOS (para SUSE) Para mais informações, consulte O Benefício de Utilização Híbrida Azure para Windows Servidor Benefício de utilização híbrida Azure para o servidor Linux Versão api mínima: 2015-06-15
properties.networkProfile	NetworkProfile	Especifica as interfaces de rede da máquina virtual.
properties.osProfile	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	integer	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. Isto só é aplicável se a propriedade 'virtualMachineScaleSet' desta Máquina Virtual estiver definida. O Conjunto de Escala de Máquina Virtual que é referenciado, deve ter 'platformFaultDomainCount' > 1. Esta propriedade não pode ser atualizada uma vez que a Máquina Virtual é criada. A atribuição de domínio de avaria pode ser visualizada na Visualização de Instância da Máquina Virtual. Versão mínima api‐‐12‐01
properties.priority	VirtualMachinePriorityTypes	Especifica a prioridade para a máquina virtual. Versão mínima da API: 2019-03-01
properties.provisioningState	string	O estado de provisionamento, que só aparece na resposta.
properties.proximityPlacementGroup	SubResource	Especifica informações sobre o grupo de colocação de proximidade a que a máquina virtual deve ser atribuída. Versão mínima da API: 2018-04-01.
properties.scheduledEventsProfile	ScheduledEventsProfile	Especifica configurações relacionadas com eventos programados.
properties.securityProfile	SecurityProfile	Especifica as definições de perfil relacionados com a Segurança para a máquina virtual.
properties.storageProfile	StorageProfile	Especifica as definições de armazenamento dos discos de máquinas virtuais.
properties.timeCreated	string	Especifica o momento em que o recurso Máquina Virtual foi criado. Versão mínima da API: 2022-03-01.
properties.userData	string	UserData para o VM, que deve ser codificado base-64. O cliente não deve passar segredos aqui. Versão mínima da API: 2021-03-01
properties.virtualMachineScaleSet	SubResource	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. Esta propriedade não pode existir juntamente com uma referência de não nulo.availabilitySet. Versão mínima api‐‐01: 2019‐03‐01
properties.vmId	string	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	VirtualMachineExtension[]	Os recursos de extensão de crianças da máquina virtual.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso
zones	string[]	As zonas de máquinas virtuais.

VirtualMachineAgentInstanceView

A visão do agente VM a funcionar na máquina virtual.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	A vista de instância do manipulador de extensão da máquina virtual.
statuses	InstanceViewStatus[]	A informação sobre o estado dos recursos.
vmAgentVersion	string	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	string
Delete	string

VirtualMachineExtension

Descreve uma extensão virtual da máquina.

Name	Type	Description
id	string	ID de recursos
location	string	Localização do recurso
name	string	Nome do recurso
properties.autoUpgradeMinorVersion	boolean	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	boolean	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	string	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	VirtualMachineExtensionInstanceView	A vista de instância de extensão da máquina virtual.
properties.protectedSettings	object	A extensão pode conter instalações protegidas ou ocultações protegidasFromKeyVault ou nenhuma definição protegida.
properties.protectedSettingsFromKeyVault	object	As extensões configurações protegidas que são passadas por referência, e consumidas a partir do cofre chave
properties.provisioningState	string	O estado de provisionamento, que só aparece na resposta.
properties.publisher	string	O nome do editor manipulador de extensões.
properties.settings	object	Json formau configurações públicas para a extensão.
properties.suppressFailures	boolean	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	string	Especifica o tipo de extensão; um exemplo é "CustomScriptExtension".
properties.typeHandlerVersion	string	Especifica a versão do manipulador de scripts.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

VirtualMachineExtensionHandlerInstanceView

A visão de um manipulador de extensão de máquina virtual.

Name	Type	Description
status	InstanceViewStatus	O estado do manipulador de extensão.
type	string	Especifica o tipo de extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de scripts.

VirtualMachineExtensionInstanceView

A visão de uma extensão de máquina virtual.

Name	Type	Description
name	string	O nome de extensão da máquina virtual.
statuses	InstanceViewStatus[]	A informação sobre o estado dos recursos.
substatuses	InstanceViewStatus[]	A informação sobre o estado dos recursos.
type	string	Especifica o tipo de extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de scripts.

VirtualMachineHealthStatus

O estado de saúde do VM.

Name	Type	Description
status	InstanceViewStatus	A informação sobre o estado de saúde do VM.

VirtualMachineIdentity

Identidade para a máquina virtual.

Name	Type	Description
principalId	string	A identificação principal da identidade da máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	O inquilino está associado à máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	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.
userAssignedIdentities	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	string	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. Versão mínima da API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	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.
computerName	string	O nome do computador atribuído à máquina virtual.
disks	DiskInstanceView[]	A informação virtual do disco de máquina.
extensions	VirtualMachineExtensionInstanceView[]	A informação sobre extensões.
hyperVGeneration	HyperVGenerationType	Especifica o Tipo de HiperVGeneração associado a um recurso
maintenanceRedeployStatus	MaintenanceRedeployStatus	O estado da Operação de Manutenção na máquina virtual.
osName	string	O Sistema Operativo está a funcionar na máquina virtual.
osVersion	string	A versão do Sistema Operativo a funcionar na máquina virtual.
patchStatus	VirtualMachinePatchStatus	[Recurso de pré-visualização] O estado das operações de correção de máquinas virtuais.
platformFaultDomain	integer	Especifica o domínio da falha da máquina virtual.
platformUpdateDomain	integer	Especifica o domínio de atualização da máquina virtual.
rdpThumbPrint	string	A impressão digital do certificado de ambiente de trabalho remoto.
statuses	InstanceViewStatus[]	A informação sobre o estado dos recursos.
vmAgent	VirtualMachineAgentInstanceView	O agente VM a funcionar na máquina virtual.
vmHealth	VirtualMachineHealthStatus	O estado de saúde do VM.

VirtualMachineIpTag

Contém a etiqueta IP associada ao endereço IP público.

Name	Type	Description
ipTagType	string	Tipo de etiqueta IP. Exemplo: FirstPartyUsage.
tag	string	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	string	O nome de configuração da interface de rede.
properties.deleteOption	DeleteOptions	Especificar o que acontece à interface de rede quando o VM é eliminado
properties.dnsSettings	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	As definições dns a aplicar nas interfaces de rede.
properties.dscpConfiguration	SubResource
properties.enableAcceleratedNetworking	boolean	Especifica se a interface de rede está ativada em rede acelerada.
properties.enableFpga	boolean	Especifica se a interface de rede está ativada em rede FPGA.
properties.enableIPForwarding	boolean	Se o encaminhamento IP ativou neste NIC.
properties.ipConfigurations	VirtualMachineNetworkInterfaceIPConfiguration[]	Especifica as configurações IP da interface de rede.
properties.networkSecurityGroup	SubResource	O grupo de segurança da rede.
properties.primary	boolean	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	string[]	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	string	O nome de configuração IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	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	SubResource[]	Especifica uma série de referências ao grupo de segurança de aplicações.
properties.loadBalancerBackendAddressPools	SubResource[]	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	boolean	Especifica a interface de rede primária no caso de a máquina virtual ter mais de 1 interface de rede.
properties.privateIPAddressVersion	IPVersions	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	VirtualMachinePublicIPAddressConfiguration	O publicIPAddressConfiguration.
properties.subnet	SubResource	Especifica o identificador da sub-rede.

VirtualMachinePatchStatus

O estado das operações de correção de máquinas virtuais.

Name	Type	Description
availablePatchSummary	AvailablePatchSummary	O resumo do patch disponível da última operação de avaliação para a máquina virtual.
configurationStatuses	InstanceViewStatus[]	O estado de habilitação do patchMode especificado
lastPatchInstallationSummary	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	string
Regular	string
Spot	string

VirtualMachinePublicIPAddressConfiguration

Descreve uma configuração de endereço publicipad de configuração de máquinas virtuais ip

Name	Type	Description
name	string	O nome de configuração de endereço publicIP.
properties.deleteOption	DeleteOptions	Especificar o que acontece ao endereço IP público quando o VM é eliminado
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	As definições dns a aplicar nos endereços publicIP .
properties.idleTimeoutInMinutes	integer	O tempo de inatividade do endereço IP público.
properties.ipTags	VirtualMachineIpTag[]	A lista de etiquetas IP associadas ao endereço IP público.
properties.publicIPAddressVersion	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'.
properties.publicIPAllocationMethod	PublicIPAllocationMethod	Especificar o tipo de atribuição de IP público
properties.publicIPPrefix	SubResource	O PublicIPPrefix a partir do qual atribuir endereços publicip.
sku	PublicIPAddressSku	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	string	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	string
Basic_A1	string
Basic_A2	string
Basic_A3	string
Basic_A4	string
Standard_A0	string
Standard_A1	string
Standard_A10	string
Standard_A11	string
Standard_A1_v2	string
Standard_A2	string
Standard_A2_v2	string
Standard_A2m_v2	string
Standard_A3	string
Standard_A4	string
Standard_A4_v2	string
Standard_A4m_v2	string
Standard_A5	string
Standard_A6	string
Standard_A7	string
Standard_A8	string
Standard_A8_v2	string
Standard_A8m_v2	string
Standard_A9	string
Standard_B1ms	string
Standard_B1s	string
Standard_B2ms	string
Standard_B2s	string
Standard_B4ms	string
Standard_B8ms	string
Standard_D1	string
Standard_D11	string
Standard_D11_v2	string
Standard_D12	string
Standard_D12_v2	string
Standard_D13	string
Standard_D13_v2	string
Standard_D14	string
Standard_D14_v2	string
Standard_D15_v2	string
Standard_D16_v3	string
Standard_D16s_v3	string
Standard_D1_v2	string
Standard_D2	string
Standard_D2_v2	string
Standard_D2_v3	string
Standard_D2s_v3	string
Standard_D3	string
Standard_D32_v3	string
Standard_D32s_v3	string
Standard_D3_v2	string
Standard_D4	string
Standard_D4_v2	string
Standard_D4_v3	string
Standard_D4s_v3	string
Standard_D5_v2	string
Standard_D64_v3	string
Standard_D64s_v3	string
Standard_D8_v3	string
Standard_D8s_v3	string
Standard_DS1	string
Standard_DS11	string
Standard_DS11_v2	string
Standard_DS12	string
Standard_DS12_v2	string
Standard_DS13	string
Standard_DS13-2_v2	string
Standard_DS13-4_v2	string
Standard_DS13_v2	string
Standard_DS14	string
Standard_DS14-4_v2	string
Standard_DS14-8_v2	string
Standard_DS14_v2	string
Standard_DS15_v2	string
Standard_DS1_v2	string
Standard_DS2	string
Standard_DS2_v2	string
Standard_DS3	string
Standard_DS3_v2	string
Standard_DS4	string
Standard_DS4_v2	string
Standard_DS5_v2	string
Standard_E16_v3	string
Standard_E16s_v3	string
Standard_E2_v3	string
Standard_E2s_v3	string
Standard_E32-16_v3	string
Standard_E32-8s_v3	string
Standard_E32_v3	string
Standard_E32s_v3	string
Standard_E4_v3	string
Standard_E4s_v3	string
Standard_E64-16s_v3	string
Standard_E64-32s_v3	string
Standard_E64_v3	string
Standard_E64s_v3	string
Standard_E8_v3	string
Standard_E8s_v3	string
Standard_F1	string
Standard_F16	string
Standard_F16s	string
Standard_F16s_v2	string
Standard_F1s	string
Standard_F2	string
Standard_F2s	string
Standard_F2s_v2	string
Standard_F32s_v2	string
Standard_F4	string
Standard_F4s	string
Standard_F4s_v2	string
Standard_F64s_v2	string
Standard_F72s_v2	string
Standard_F8	string
Standard_F8s	string
Standard_F8s_v2	string
Standard_G1	string
Standard_G2	string
Standard_G3	string
Standard_G4	string
Standard_G5	string
Standard_GS1	string
Standard_GS2	string
Standard_GS3	string
Standard_GS4	string
Standard_GS4-4	string
Standard_GS4-8	string
Standard_GS5	string
Standard_GS5-16	string
Standard_GS5-8	string
Standard_H16	string
Standard_H16m	string
Standard_H16mr	string
Standard_H16r	string
Standard_H8	string
Standard_H8m	string
Standard_L16s	string
Standard_L32s	string
Standard_L4s	string
Standard_L8s	string
Standard_M128-32ms	string
Standard_M128-64ms	string
Standard_M128ms	string
Standard_M128s	string
Standard_M64-16ms	string
Standard_M64-32ms	string
Standard_M64ms	string
Standard_M64s	string
Standard_NC12	string
Standard_NC12s_v2	string
Standard_NC12s_v3	string
Standard_NC24	string
Standard_NC24r	string
Standard_NC24rs_v2	string
Standard_NC24rs_v3	string
Standard_NC24s_v2	string
Standard_NC24s_v3	string
Standard_NC6	string
Standard_NC6s_v2	string
Standard_NC6s_v3	string
Standard_ND12s	string
Standard_ND24rs	string
Standard_ND24s	string
Standard_ND6s	string
Standard_NV12	string
Standard_NV24	string
Standard_NV6	string

VMDiskSecurityProfile

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

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	string	Opcional, especifica o uri a uma bolha azul que substituirá a configuração padrão para o pacote se fornecido
enableAutomaticUpgrade	boolean	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	integer	Opcional, especifica a ordem em que os pacotes têm de ser instalados
packageReferenceId	string	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	string	Opcional, especifica um valor de passagem para um contexto mais genérico.
treatFailureAsDeploymentFailure	boolean	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	integer	Especifica o número de vCPUs disponíveis para o VM. Quando esta propriedade não é especificada no organismo de pedido, o comportamento padrão é defini-lo para o valor dos vCPUs disponíveis para esse tamanho VM exposto na resposta api de Lista de todos os tamanhos de máquina virtual disponíveis numa região .
vCPUsPerCore	integer	Especifica a relação vCPU com o núcleo físico. Quando esta propriedade não é especificada no corpo de pedido, o comportamento padrão é definido para o valor do vCPUsPerCore para o tamanho VM exposto na resposta api de Lista todos os tamanhos de máquinas virtuais disponíveis em uma região Definir esta propriedade para 1 também significa que o hiper-roscado está desativado.

WindowsConfiguration

Especifica Windows definições do sistema operativo na máquina virtual.

Name	Type	Description
additionalUnattendContent	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	boolean	Indica se as atualizações automáticas estão ativadas para a Windows máquina virtual. O valor predefinido é verdadeiro. Para conjuntos de escala de máquinas virtuais, esta propriedade pode ser atualizada e as atualizações entrarão em vigor na reprovisionamento do SO.
patchSettings	PatchSettings	[Recurso de pré-visualização] Especifica as definições relacionadas com o Patching de Hóspedes VM no Windows.
provisionVMAgent	boolean	Indica se o agente de máquinas virtuais deve ser a provisionado na máquina virtual. Quando esta propriedade não é especificada no corpo de pedido, o comportamento padrão é defini-lo como verdadeiro. Isto garantirá a instalação do Agente VM no VM para que as extensões possam ser adicionadas mais tarde ao VM.
timeZone	string	Especifica o fuso horário da máquina virtual. por exemplo, "Tempo Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor dos fusos horários devolvidos pelo TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	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	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a definição de reinicialização para todas as operações automáticas de instalação do patchByPlatform.

Name	Type	Description
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica definições adicionais a aplicar quando o modo de remendos AutomaticByPlatform for selecionado nas definições Windows patch.

Name	Type	Description
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	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	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Descreve Windows configuração de Gestão Remota do VM

Name	Type	Description
listeners	WinRMListener[]	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	string	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: { "dados":"<> de certificado codificado base64", "dataType":"pfx", "password":"<> de senha de ficheiro pfx" } 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.
protocol	ProtocolTypes	Especifica o protocolo do ouvinte winRM. Os valores possíveis são: http https