Virtual Machines - Create Or Update

Operación para crear o actualizar una máquina virtual. Tenga en cuenta que algunas propiedades solo se pueden establecer durante la creación de máquinas virtuales.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

Nombre del grupo de recursos.

subscriptionId
path True

string

Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.

vmName
path True

string

El nombre de la máquina virtual.

api-version
query True

string

Versión de api de cliente.

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-Match

string

ETag de la transformación. Omita este valor para sobrescribir siempre el recurso actual. Especifique el último valor de ETag visto para evitar que se sobrescriba accidentalmente los cambios simultáneos.

If-None-Match

string

Establézcalo en "*" para permitir la creación de un nuevo conjunto de registros, pero para evitar la actualización de un conjunto de registros existente. Otros valores producirán un error del servidor, ya que no se admiten.

Cuerpo de la solicitud

Nombre Tipo Description
parameters

VirtualMachine

Parámetros proporcionados a la operación Crear máquina virtual.

Respuestas

Nombre Tipo Description
200 OK

VirtualMachine

Aceptar

201 Created

VirtualMachine

Creado

Other Status Codes

CloudError

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Sample Request

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

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

Sample Response

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

Create a vm from a custom image.

Sample Request

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

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

Sample Response

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

Create a vm from a generalized shared image.

Sample Request

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

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

Sample Response

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

Sample Request

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

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

Sample Response

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

Create a vm from a specialized shared image.

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create a vm in an availability set.

Sample Request

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

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

Sample Response

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

Create a vm with a marketplace image plan.

Sample Request

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

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

Sample Response

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

Create a vm with an extensions time budget.

Sample Request

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

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

Sample Response

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

Create a vm with Application Profile.

Sample Request

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

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

Sample Response

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

Create a vm with boot diagnostics.

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create a VM with Disk Controller Type

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create a vm with empty data disks.

Sample Request

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

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

Sample Response

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

Create a VM with encryption identity

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create a vm with ephemeral os disk.

Sample Request

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

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

Sample Response

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

Create a VM with HibernationEnabled

Sample Request

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

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

Sample Response

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

Create a vm with Host Encryption using encryptionAtHost property.

Sample Request

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

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

Sample Response

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

Create a vm with managed boot diagnostics.

Sample Request

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

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

Sample Response

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

Create a VM with network interface configuration

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create a vm with password authentication.

Sample Request

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

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

Sample Response

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

Create a vm with premium storage.

Sample Request

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

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

Sample Response

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

Create a VM with ProxyAgent Settings of enabled and mode.

Sample Request

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

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

Sample Response

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

Create a vm with Scheduled Events Profile

Sample Request

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

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

Sample Response

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

Create a VM with securityType ConfidentialVM with Customer Managed Keys

Sample Request

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

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

Sample Response

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

Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType

Sample Request

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

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

Sample Response

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

Create a VM with securityType ConfidentialVM with Platform Managed Keys

Sample Request

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

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

Sample Response

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

Create a vm with ssh authentication.

Sample Request

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

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

Sample Response

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

Create a VM with Uefi Settings of secureBoot and vTPM.

Sample Request

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

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

Sample Response

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

Create a VM with UserData

Sample Request

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

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

Sample Response

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

Create a VM with VM Size Properties

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

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

Sample Request

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

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

Sample Response

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

Create or update a VM with capacity reservation

Sample Request

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

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

Sample Response

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

Definiciones

Nombre Description
AdditionalCapabilities

Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual.

AdditionalUnattendContent

Especifica información adicional con formato XML codificado en base 64 que se puede incluir en el archivo Unattend.xml, usado por el programa de instalación de Windows.

ApiEntityReference

Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.

ApiError

Error de api.

ApiErrorBase

Base de errores de API.

ApplicationProfile

Especifica las aplicaciones de la galería que deben estar disponibles para la máquina virtual o VMSS.

AvailablePatchSummary

El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.

BillingProfile

Especifica los detalles relacionados con la facturación de una máquina virtual de Acceso puntual de Azure. Versión mínima de api: 2019-03-01.

BootDiagnostics

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: Si se especifica storageUri, asegúrese de que la cuenta de almacenamiento se encuentra en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

BootDiagnosticsInstanceView

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

CapacityReservationProfile

Especifica información sobre la reserva de capacidad que se usa para asignar la máquina virtual. Versión mínima de api: 2021-04-01.

CloudError

Respuesta de error del servicio Compute.

ComponentNames

Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.

DataDisk

Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

DeleteOptions

Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual

DiagnosticsProfile

Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.

DiffDiskOptions

Especifica la configuración del disco efímero para el disco del sistema operativo.

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual; de lo contrario, se usa ResourceDisk o NvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y la máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar en qué tamaños de máquina virtual se expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo usado por la máquina virtual.

DiskControllerTypes

Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se ha especificado que la máquina virtual proporcionada se cree con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual a partir de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco, a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna y reasigna implícitamente la máquina virtual. Versión mínima de api: 2022-08-01.

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de la máquina virtual. Los valores posibles son Attach: este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.

DiskDeleteOptionTypes

Especifica si el disco del sistema operativo debe eliminarse o desasociarse tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. En el caso de un disco del sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco del sistema operativo efímero.

DiskDetachOptionTypes

Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo es aplicable para discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción para separar el disco forzosamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco administrado.

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.

DiskInstanceView

Información del disco de la máquina virtual.

DomainNameLabelScopeTypes

Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio con hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.

EncryptionIdentity

Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones de keyvault.

EventGridAndResourceGraph

Parámetros de configuración usados al crear el valor eventGridAndResourceGraph Scheduled Event.

ExtendedLocation

Ubicación extendida de la máquina virtual.

ExtendedLocationTypes

Tipo de la ubicación extendida.

HardwareProfile

Especifica la configuración de hardware de la máquina virtual.

HyperVGenerationType

Especifica el tipo de hyperVGeneration asociado a un recurso.

ImageReference

Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.

InnerError

Detalles del error interno.

InstanceViewStatus

Estado de la vista de instancia.

IPVersions

Disponible desde Api-Version 2019-07-01 en adelante, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" y "IPv6".

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

KeyVaultSecretReference

La configuración protegida de extensiones que se pasa por referencia y se consume desde el almacén de claves.

LastPatchInstallationSummary

El resumen de instalación de la operación de instalación más reciente para la máquina virtual.

LinuxConfiguration

Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux en distribuciones de Azure-Endorsed.

LinuxPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

LinuxPatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.

LinuxVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

ImageDefault: se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual.

AutomaticByPlatform : la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true.

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

ManagedDiskParameters

Parámetros de disco administrado.

Mode

Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión de host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es El modo Aplicar.

NetworkApiVersion

especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.

NetworkInterfaceAuxiliaryMode

Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.

NetworkInterfaceAuxiliarySku

Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.

NetworkInterfaceReference

Especifica la lista de identificadores de recursos para las interfaces de red asociadas a la máquina virtual.

NetworkProfile

Especifica las interfaces de red de la máquina virtual.

OperatingSystemTypes

Tipo de sistema operativo.

OSDisk

Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

OSImageNotificationProfile

Especifica configuraciones relacionadas con eventos relacionados con la imagen del sistema operativo.

OSProfile

Especifica la configuración del sistema operativo utilizada al crear la máquina virtual. Algunas de las opciones de configuración no se pueden cambiar una vez que se aprovisiona la máquina virtual.

PassNames

Nombre de paso. Actualmente, el único valor permitido es OobeSystem.

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Desconocido", "Failed", "Succeeded" o "CompletedWithWarnings".

PatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.

Plan

Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para las imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En el Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción-> . Escriba cualquier información necesaria y, a continuación, haga clic en Guardar.

ProtocolTypes

Especifica el protocolo del agente de escucha de WinRM. Los valores posibles son: http,https.

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2024-03-01.

PublicIPAddressSku

Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

PublicIPAddressSkuName

Especificación del nombre de SKU de ip pública

PublicIPAddressSkuTier

Especificación del nivel de SKU de ip pública

PublicIPAllocationMethod

Especificación del tipo de asignación de IP pública

ResourceIdentityType

Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.

ScheduledEventsAdditionalPublishingTargets

Los parámetros de configuración usados al publicar scheduledEventsAdditionalPublishingTargets.

ScheduledEventsPolicy

Especifica las configuraciones relacionadas con el evento programado Redeploy, Reboot y ScheduledEventsAdditionalPublishingTargets para la máquina virtual.

ScheduledEventsProfile

Especifica configuraciones relacionadas con eventos programados.

securityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado solo del blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

SecurityProfile

Especifica la configuración de perfil relacionada con la seguridad de la máquina virtual.

SecurityTypes

Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.

SettingNames

Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.

SshConfiguration

Especifica la configuración de la clave SSH para un sistema operativo Linux.

SshPublicKey

Lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.

StatusLevelTypes

El código de nivel.

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con el disco del sistema operativo.

StorageProfile

Especifica la configuración de almacenamiento de los discos de máquina virtual.

SubResource

Dirección URL relativa del Key Vault que contiene el secreto.

TerminateNotificationProfile

Especifica las configuraciones relacionadas con el evento programado de finalización.

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.

UserAssignedIdentities

Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

UserInitiatedReboot

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedReboot.

UserInitiatedRedeploy

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedRedeploy.

VaultCertificate

Lista de referencias del almacén de claves en SourceVault que contienen certificados.

VaultSecretGroup

Especifica el conjunto de certificados que debe instalarse en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault para Linux o la extensión de máquina virtual de Azure Key Vault para Windows.

VirtualHardDisk

Disco duro virtual.

VirtualMachine

Describe una máquina virtual.

VirtualMachineAgentInstanceView

Agente de máquina virtual que se ejecuta en la máquina virtual.

VirtualMachineEvictionPolicyTypes

Especifica la directiva de expulsión para la máquina virtual de Azure Spot y el conjunto de escalado de acceso puntual de Azure. En el caso de las máquinas virtuales de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2019-03-01. En el caso de los conjuntos de escalado de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2017-10-30-preview.

VirtualMachineExtension

Recursos de extensión secundaria de máquina virtual.

VirtualMachineExtensionHandlerInstanceView

Vista de instancia del controlador de extensión de máquina virtual.

VirtualMachineExtensionInstanceView

Vista de instancia de extensión de máquina virtual.

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

VirtualMachineIdentity

Identidad de la máquina virtual, si está configurada.

VirtualMachineInstanceView

Vista de instancia de máquina virtual.

VirtualMachineIpTag

Lista de etiquetas IP asociadas a la dirección IP pública.

VirtualMachineNetworkInterfaceConfiguration

Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

La configuración dns que se va a aplicar en las interfaces de red.

VirtualMachineNetworkInterfaceIPConfiguration

Especifica las configuraciones IP de la interfaz de red.

VirtualMachinePatchStatus

[Característica de vista previa] Estado de las operaciones de revisión de máquina virtual.

VirtualMachinePriorityTypes

Especifica la prioridad de la máquina virtual. Versión mínima de api: 2019-03-01

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Configuración dns que se va a aplicar en las direcciones publicIP.

VirtualMachineSizeTypes

Especifica el tamaño de la máquina virtual. El tipo de datos enum está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para más información sobre los tamaños de máquina virtual, consulte Tamaños para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.

VMDiskSecurityProfile

Especifica el perfil de seguridad del disco administrado.

VMGalleryApplication

Especifica las aplicaciones de la galería que se deben poner a disposición de la máquina virtual o VMSS.

VMSizeProperties

Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de Personalización de máquina virtual para obtener más detalles.

WindowsConfiguration

Especifica la configuración del sistema operativo de Windows en la máquina virtual.

WindowsPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica una configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.

WindowsVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

Manual : controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false

AutomaticByOS : el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true.

AutomaticByPlatform : la máquina virtual se actualizará automáticamente por la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.

WinRMConfiguration

Especifica los agentes de escucha de administración remota de Windows. De este modo se habilita Windows PowerShell.

WinRMListener

Lista de agentes de escucha de administración remota de Windows

AdditionalCapabilities

Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual.

Nombre Tipo Description
hibernationEnabled

boolean

Marca que habilita o deshabilita la funcionalidad de hibernación en la máquina virtual.

ultraSSDEnabled

boolean

Marca que habilita o deshabilita una funcionalidad para tener uno o varios discos de datos administrados con UltraSSD_LRS tipo de cuenta de almacenamiento en la máquina virtual o VMSS. Los discos administrados con el tipo de cuenta de almacenamiento UltraSSD_LRS se pueden agregar a una máquina virtual o un conjunto de escalado de máquinas virtuales solo si esta propiedad está habilitada.

AdditionalUnattendContent

Especifica información adicional con formato XML codificado en base 64 que se puede incluir en el archivo Unattend.xml, usado por el programa de instalación de Windows.

Nombre Tipo Description
componentName

ComponentNames

Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.

content

string

Especifica el contenido con formato XML que se agrega al archivo unattend.xml para la ruta de acceso y el componente especificados. El XML debe ser inferior a 4 KB y debe incluir el elemento raíz para la configuración o característica que se va a insertar.

passName

PassNames

Nombre del pase. Actualmente, el único valor permitido es OobeSystem.

settingName

SettingNames

Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.

ApiEntityReference

Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.

Nombre Tipo Description
id

string

Identificador de recurso de ARM en forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Error de api.

Nombre Tipo Description
code

string

Código de error.

details

ApiErrorBase[]

Detalles del error de api

innererror

InnerError

Error interno de api

message

string

El mensaje de error.

target

string

Destino del error determinado.

ApiErrorBase

Base de errores de API.

Nombre Tipo Description
code

string

Código de error.

message

string

El mensaje de error.

target

string

Destino del error concreto.

ApplicationProfile

Especifica las aplicaciones de la galería que deben estar disponibles para la máquina virtual o VMSS.

Nombre Tipo Description
galleryApplications

VMGalleryApplication[]

Especifica las aplicaciones de la galería que deben estar disponibles para la máquina virtual o VMSS.

AvailablePatchSummary

El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.

Nombre Tipo Description
assessmentActivityId

string

Identificador de actividad de la operación que generó este resultado. Se usa para correlacionar entre los registros de CRP y de extensión.

criticalAndSecurityPatchCount

integer

Número de revisiones críticas o de seguridad que se han detectado como disponibles y que aún no están instaladas.

error

ApiError

Errores que se encontraron durante la ejecución de la operación. La matriz de detalles contiene la lista de ellos.

lastModifiedTime

string

Marca de tiempo UTC cuando se inició la operación.

otherPatchCount

integer

El número de todas las revisiones disponibles, excepto las críticas y la seguridad.

rebootPending

boolean

Estado de reinicio general de la máquina virtual. Será true cuando las revisiones instaladas parcialmente requieran un reinicio para completar la instalación, pero el reinicio aún no se ha producido.

startTime

string

Marca de tiempo UTC cuando se inició la operación.

status

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Unknown", "Failed", "Succeeded" o "CompletedWithWarnings".

BillingProfile

Especifica los detalles relacionados con la facturación de una máquina virtual de Acceso puntual de Azure. Versión mínima de api: 2019-03-01.

Nombre Tipo Description
maxPrice

number

Especifica el precio máximo que está dispuesto a pagar por una máquina virtual o VMSS de Acceso puntual de Azure. Este precio está en dólares estadounidenses.

Este precio se comparará con el precio actual de Azure Spot para el tamaño de la máquina virtual. Además, los precios se comparan en el momento de crear o actualizar la máquina virtual o VMSS de Azure Spot y la operación solo se realizará correctamente si maxPrice es mayor que el precio actual de Azure Spot.

El valor maxPrice también se usará para expulsar una máquina virtual o VMSS de Acceso puntual de Azure si el precio actual de Azure Spot va más allá del maxPrice después de la creación de VM/VMSS.

Los valores posibles son:

: cualquier valor decimal mayor que cero. Ejemplo: 0.01538

-1: indica que el precio predeterminado es de hasta la demanda.

Puede establecer maxPrice en -1 para indicar que la máquina virtual o VMSS de Acceso puntual de Azure no se debe expulsar por motivos de precio. Además, el precio máximo predeterminado es -1 si no lo proporciona usted.

Versión mínima de api: 2019-03-01.

BootDiagnostics

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: Si se especifica storageUri, asegúrese de que la cuenta de almacenamiento se encuentra en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre Tipo Description
enabled

boolean

Si los diagnósticos de arranque deben estar habilitados en la máquina virtual.

storageUri

string

Uri de la cuenta de almacenamiento que se va a usar para colocar la salida y la captura de pantalla de la consola. Si no se especifica storageUri al habilitar los diagnósticos de arranque, se usará el almacenamiento administrado.

BootDiagnosticsInstanceView

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre Tipo Description
consoleScreenshotBlobUri

string

URI del blob de la consola. Nota: Esto no se establecerá si el diagnóstico de arranque está habilitado actualmente con el almacenamiento administrado.

serialConsoleLogBlobUri

string

Uri del blob de registro de la consola serie. Nota: Esto no se establecerá si el diagnóstico de arranque está habilitado actualmente con el almacenamiento administrado.

status

InstanceViewStatus

Información de estado de diagnóstico de arranque de la máquina virtual. Nota: Solo se establecerá si se producen errores en la habilitación de diagnósticos de arranque.

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

Nombre Tipo Description
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

Especifica información sobre la reserva de capacidad que se usa para asignar la máquina virtual. Versión mínima de api: 2021-04-01.

Nombre Tipo Description
capacityReservationGroup

SubResource

Especifica el identificador de recurso del grupo de reserva de capacidad que se debe usar para asignar la máquina virtual o las instancias de máquina virtual del conjunto de escalado siempre que se haya reservado suficiente capacidad. Consulte para https://aka.ms/CapacityReservation obtener más detalles.

CloudError

Respuesta de error del servicio Compute.

Nombre Tipo Description
error

ApiError

Error de API.

ComponentNames

Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.

Nombre Tipo Description
Microsoft-Windows-Shell-Setup

string

DataDisk

Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre Tipo Description
caching

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

createOption

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Attach: este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear el disco de datos de la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente. Vacío: Este valor se usa al crear un disco de datos vacío. Copia: Este valor se usa para crear un disco de datos a partir de una instantánea u otro disco. Restaurar: Este valor se usa para crear un disco de datos a partir de un punto de restauración de disco.

deleteOption

DiskDeleteOptionTypes

Especifica si se debe eliminar o desasociar el disco de datos tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco de datos se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco de datos se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar.

detachOption

DiskDetachOptionTypes

Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a los discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción para desasociar el disco forzosamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".

diskIOPSReadWrite

integer

Especifica el Read-Write IOPS del disco administrado cuando storageAccountType está UltraSSD_LRS. Solo se devuelve para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de actualizaciones del conjunto de escalado VirtualMachine.

diskMBpsReadWrite

integer

Especifica el ancho de banda en MB por segundo para el disco administrado cuando StorageAccountType es UltraSSD_LRS. Solo se devuelve para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de actualizaciones del conjunto de escalado VirtualMachine.

diskSizeGB

integer

Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad "diskSizeGB" es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.

image

VirtualHardDisk

Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.

lun

integer

Especifica el número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a una máquina virtual.

managedDisk

ManagedDiskParameters

Parámetros de disco administrado.

name

string

El nombre del disco.

sourceResource

ApiEntityReference

Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.

toBeDetached

boolean

Especifica si el disco de datos está en proceso de desacoplación de VirtualMachine/VirtualMachineScaleset.

vhd

VirtualHardDisk

Disco duro virtual.

writeAcceleratorEnabled

boolean

Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

DeleteOptions

Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual

Nombre Tipo Description
Delete

string

Detach

string

DiagnosticsProfile

Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.

Nombre Tipo Description
bootDiagnostics

BootDiagnostics

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: Si se especifica storageUri, asegúrese de que la cuenta de almacenamiento se encuentra en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

DiffDiskOptions

Especifica la configuración del disco efímero para el disco del sistema operativo.

Nombre Tipo Description
Local

string

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual; de lo contrario, se usa ResourceDisk o NvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y la máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar en qué tamaños de máquina virtual se expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

Nombre Tipo Description
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo usado por la máquina virtual.

Nombre Tipo Description
option

DiffDiskOptions

Especifica la configuración del disco efímero para el disco del sistema operativo.

placement

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de máquina virtual; de lo contrario, se usa ResourceDisk o NvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y la máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar en qué tamaños de máquina virtual se expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

DiskControllerTypes

Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se ha especificado que la máquina virtual proporcionada se cree con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual a partir de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco, a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna y reasigna implícitamente la máquina virtual. Versión mínima de api: 2022-08-01.

Nombre Tipo Description
NVMe

string

SCSI

string

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de la máquina virtual. Los valores posibles son Attach: este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.

Nombre Tipo Description
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

Especifica si el disco del sistema operativo debe eliminarse o desasociarse tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. En el caso de un disco del sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco del sistema operativo efímero.

Nombre Tipo Description
Delete

string

Detach

string

DiskDetachOptionTypes

Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo es aplicable para discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción para separar el disco forzosamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".

Nombre Tipo Description
ForceDetach

string

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco administrado.

Nombre Tipo Description
id

string

Id. de recurso

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.

Nombre Tipo Description
diskEncryptionKey

KeyVaultSecretReference

Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.

enabled

boolean

Especifica si se debe habilitar el cifrado de disco en la máquina virtual.

keyEncryptionKey

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

DiskInstanceView

Información del disco de la máquina virtual.

Nombre Tipo Description
encryptionSettings

DiskEncryptionSettings[]

Especifica la configuración de cifrado del disco del sistema operativo.

Versión mínima de api: 2015-06-15

name

string

El nombre del disco.

statuses

InstanceViewStatus[]

Información de estado del recurso.

DomainNameLabelScopeTypes

Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio con hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.

Nombre Tipo Description
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones de keyvault.

Nombre Tipo Description
userAssignedIdentityResourceId

string

Especifica el identificador de recurso de ARM de una de las identidades de usuario asociadas a la máquina virtual.

EventGridAndResourceGraph

Parámetros de configuración usados al crear el valor eventGridAndResourceGraph Scheduled Event.

Nombre Tipo Description
enable

boolean

Especifica si event grid y el gráfico de recursos están habilitados para configuraciones relacionadas con eventos programados.

ExtendedLocation

Ubicación extendida de la máquina virtual.

Nombre Tipo Description
name

string

Nombre de la ubicación extendida.

type

ExtendedLocationTypes

Tipo de la ubicación extendida.

ExtendedLocationTypes

Tipo de la ubicación extendida.

Nombre Tipo Description
EdgeZone

string

HardwareProfile

Especifica la configuración de hardware de la máquina virtual.

Nombre Tipo Description
vmSize

VirtualMachineSizeTypes

Especifica el tamaño de la máquina virtual. El tipo de datos enum está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para más información sobre los tamaños de máquina virtual, consulte Tamaños para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.

vmSizeProperties

VMSizeProperties

Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de Personalización de máquina virtual para obtener más detalles.

HyperVGenerationType

Especifica el tipo de hyperVGeneration asociado a un recurso.

Nombre Tipo Description
V1

string

V2

string

ImageReference

Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.

Nombre Tipo Description
communityGalleryImageId

string

Se especificó el identificador único de la imagen de la galería de la comunidad para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería de la comunidad.

exactVersion

string

Especifica en números decimales, la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Este campo de solo lectura difiere de "version", solo si el valor especificado en el campo "version" es "latest".

id

string

Id. de recurso

offer

string

Especifica la oferta de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual.

publisher

string

Publicador de imágenes.

sharedGalleryImageId

string

Se especificó el identificador único de la imagen de la galería compartida para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería compartida.

sku

string

SKU de imagen.

version

string

Especifica la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Los formatos permitidos son Major.Minor.Build o "latest". Major, Minor y Build son números decimales. Especifique "más reciente" para usar la versión más reciente de una imagen disponible en el momento de la implementación. Incluso si usa "latest", la imagen de máquina virtual no se actualizará automáticamente después del tiempo de implementación, incluso si hay disponible una nueva versión. No use el campo "version" para la implementación de imágenes de la galería, la imagen de la galería siempre debe usar el campo "id" para la implementación, para usar la versión "latest" de la imagen de la galería, simplemente establezca "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}" en el campo "id" sin entrada de versión.

InnerError

Detalles del error interno.

Nombre Tipo Description
errordetail

string

Mensaje de error interno o volcado de memoria de excepciones.

exceptiontype

string

Tipo de la excepción.

InstanceViewStatus

Estado de la vista de instancia.

Nombre Tipo Description
code

string

Código de estado.

displayStatus

string

Etiqueta localizable corta para el estado.

level

StatusLevelTypes

El código de nivel.

message

string

Mensaje de estado detallado, incluidas las alertas y los mensajes de error.

time

string

Hora del estado.

IPVersions

Disponible desde Api-Version 2019-07-01 en adelante, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" y "IPv6".

Nombre Tipo Description
IPv4

string

IPv6

string

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

Nombre Tipo Description
keyUrl

string

Dirección URL que hace referencia a una clave de cifrado de claves en Key Vault.

sourceVault

SubResource

Dirección URL relativa del Key Vault que contiene la clave.

KeyVaultSecretReference

La configuración protegida de extensiones que se pasa por referencia y se consume desde el almacén de claves.

Nombre Tipo Description
secretUrl

string

Dirección URL que hace referencia a un secreto en un Key Vault.

sourceVault

SubResource

Dirección URL relativa del Key Vault que contiene el secreto.

LastPatchInstallationSummary

El resumen de instalación de la operación de instalación más reciente para la máquina virtual.

Nombre Tipo Description
error

ApiError

Errores que se encontraron durante la ejecución de la operación. La matriz de detalles contiene la lista de ellos.

excludedPatchCount

integer

Número de todas las revisiones disponibles pero excluidas explícitamente por una coincidencia de lista de exclusión especificada por el cliente.

failedPatchCount

integer

Recuento de revisiones que no se pudieron instalar.

installationActivityId

string

Identificador de actividad de la operación que generó este resultado. Se usa para correlacionar entre los registros de CRP y de extensión.

installedPatchCount

integer

Recuento de revisiones que se instalaron correctamente.

lastModifiedTime

string

Marca de tiempo UTC cuando se inició la operación.

maintenanceWindowExceeded

boolean

Describe si la operación se agotó el tiempo antes de completar todas sus acciones previstas.

notSelectedPatchCount

integer

Número de todas las revisiones disponibles, pero no se instalarán porque no coincidía con una entrada de lista de clasificación o inclusión.

pendingPatchCount

integer

Número de todas las revisiones disponibles que se espera que se instalen durante la operación de instalación de revisiones.

startTime

string

Marca de tiempo UTC cuando se inició la operación.

status

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Unknown", "Failed", "Succeeded" o "CompletedWithWarnings".

LinuxConfiguration

Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux en distribuciones de Azure-Endorsed.

Nombre Tipo Description
disablePasswordAuthentication

boolean

Especifica si se debe deshabilitar la autenticación de contraseña.

enableVMAgentPlatformUpdates

boolean

Indica si vmAgent Platform Novedades está habilitado para la máquina virtual Linux. El valor predeterminado es False.

patchSettings

LinuxPatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.

provisionVMAgent

boolean

Indica si el agente de máquina virtual debe aprovisionarse en la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado es establecerla en true. Esto garantizará que el agente de máquina virtual esté instalado en la máquina virtual para que las extensiones se puedan agregar a la máquina virtual más adelante.

ssh

SshConfiguration

Especifica la configuración de la clave SSH para un sistema operativo Linux.

LinuxPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

Nombre Tipo Description
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.

Nombre Tipo Description
assessmentMode

LinuxPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica una configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.

patchMode

LinuxVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual en máquinas virtuales IaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

ImageDefault : se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual.

AutomaticByPlatform : la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

Nombre Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.

Nombre Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite al cliente programar la aplicación de revisiones sin actualizaciones accidentales

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

LinuxVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

ImageDefault: se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual.

AutomaticByPlatform : la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true.

Nombre Tipo Description
AutomaticByPlatform

string

ImageDefault

string

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

Nombre Tipo Description
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

Nombre Tipo Description
isCustomerInitiatedMaintenanceAllowed

boolean

True, si el cliente puede realizar mantenimiento.

lastOperationMessage

string

Mensaje devuelto para la última operación de mantenimiento.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

maintenanceWindowEndTime

string

Hora de finalización de la ventana de mantenimiento.

maintenanceWindowStartTime

string

Hora de inicio de la ventana de mantenimiento.

preMaintenanceWindowEndTime

string

Hora de finalización de la ventana de mantenimiento previo.

preMaintenanceWindowStartTime

string

Hora de inicio de la ventana de mantenimiento previo.

ManagedDiskParameters

Parámetros de disco administrado.

Nombre Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco administrado.

id

string

Id. de recurso

securityProfile

VMDiskSecurityProfile

Especifica el perfil de seguridad del disco administrado.

storageAccountType

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

Mode

Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión de host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es El modo Aplicar.

Nombre Tipo Description
Audit

string

Enforce

string

NetworkApiVersion

especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.

Nombre Tipo Description
2020-11-01

string

NetworkInterfaceAuxiliaryMode

Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.

Nombre Tipo Description
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.

Nombre Tipo Description
A1

string

A2

string

A4

string

A8

string

None

string

NetworkInterfaceReference

Especifica la lista de identificadores de recursos para las interfaces de red asociadas a la máquina virtual.

Nombre Tipo Description
id

string

Id. de recurso

properties.deleteOption

DeleteOptions

Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual

properties.primary

boolean

Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

NetworkProfile

Especifica las interfaces de red de la máquina virtual.

Nombre Tipo Description
networkApiVersion

NetworkApiVersion

especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.

networkInterfaceConfigurations

VirtualMachineNetworkInterfaceConfiguration[]

Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.

networkInterfaces

NetworkInterfaceReference[]

Especifica la lista de identificadores de recurso para las interfaces de red asociadas a la máquina virtual.

OperatingSystemTypes

Tipo de sistema operativo.

Nombre Tipo Description
Linux

string

Windows

string

OSDisk

Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre Tipo Description
caching

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

createOption

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Attach: este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.

deleteOption

DiskDeleteOptionTypes

Especifica si el disco del sistema operativo debe eliminarse o desasociarse tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco del sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco del sistema operativo efímero.

diffDiskSettings

DiffDiskSettings

Especifica la configuración de disco efímera para el disco del sistema operativo usado por la máquina virtual.

diskSizeGB

integer

Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad "diskSizeGB" es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.

encryptionSettings

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.

image

VirtualHardDisk

Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.

managedDisk

ManagedDiskParameters

Parámetros de disco administrado.

name

string

El nombre del disco.

osType

OperatingSystemTypes

Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco si crea una máquina virtual a partir de una imagen de usuario o un disco duro virtual especializado. Los valores posibles son: Windows,Linux.

vhd

VirtualHardDisk

Disco duro virtual.

writeAcceleratorEnabled

boolean

Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

OSImageNotificationProfile

Especifica configuraciones relacionadas con eventos relacionados con la imagen del sistema operativo.

Nombre Tipo Description
enable

boolean

Especifica si el evento OS Image Scheduled está habilitado o deshabilitado.

notBeforeTimeout

string

Tiempo durante el que se vuelve a crear una imagen inicial de una máquina virtual o tener actualizado su sistema operativo tendrá que aprobar potencialmente el evento programado de imagen del sistema operativo antes de que el evento se apruebe automáticamente (se agota el tiempo de espera). La configuración se especifica en formato ISO 8601 y el valor debe ser de 15 minutos (PT15M).

OSProfile

Especifica la configuración del sistema operativo utilizada al crear la máquina virtual. Algunas de las opciones de configuración no se pueden cambiar una vez que se aprovisiona la máquina virtual.

Nombre Tipo Description
adminPassword

string

Especifica la contraseña de la cuenta de administrador.

Longitud mínima (Windows): 8 caracteres

Longitud mínima (Linux): 6 caracteres

Longitud máxima (Windows): 123 caracteres

Longitud máxima (Linux): 72 caracteres

Requisitos de complejidad: 3 de cada 4 condiciones siguientes deben cumplirse
Tiene caracteres inferiores
Tiene caracteres superiores
Tiene un dígito
Tiene un carácter especial (Coincidencia de regex [\W_])

Valores no permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

Para restablecer la contraseña, consulte Restablecimiento del servicio Escritorio remoto o su contraseña de inicio de sesión en una máquina virtual Windows.

Para restablecer la contraseña raíz, consulte Administración de usuarios, SSH y comprobación o reparación de discos en máquinas virtuales Linux de Azure mediante la extensión VMAccess.

adminUsername

string

Especifica el nombre de la cuenta de administrador.

Esta propiedad no se puede actualizar después de crear la máquina virtual.

Restricción solo de Windows: No se puede finalizar en "."

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

Longitud mínima (Linux): 1 carácter

Longitud máxima (Linux): 64 caracteres

Longitud máxima (Windows): 20 caracteres.

allowExtensionOperations

boolean

Especifica si se deben permitir operaciones de extensión en la máquina virtual. Esto solo se puede establecer en False cuando no hay extensiones presentes en la máquina virtual.

computerName

string

Especifica el nombre del sistema operativo de host de la máquina virtual. Este nombre no se puede actualizar una vez creada la máquina virtual. Longitud máxima (Windows): 15 caracteres. Longitud máxima (Linux): 64 caracteres. Para conocer las convenciones de nomenclatura y las restricciones, consulte Directrices de implementación de los servicios de infraestructura de Azure.

customData

string

Especifica una cadena codificada en base 64 de datos personalizados. La cadena codificada en base 64 se descodifica en una matriz binaria que se guarda como un archivo en la máquina virtual. La longitud máxima de la matriz binaria es de 65535 bytes. Nota: No pase secretos ni contraseñas en la propiedad customData. Esta propiedad no se puede actualizar después de crear la máquina virtual. La propiedad "customData" se pasa a la máquina virtual que se va a guardar como un archivo. Para obtener más información, consulte Custom Data on Azure VMs (Datos personalizados en máquinas virtuales de Azure). Para usar cloud-init para la máquina virtual Linux, consulte Uso de cloud-init para personalizar una máquina virtual Linux durante la creación.

linuxConfiguration

LinuxConfiguration

Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux en distribuciones de Azure-Endorsed.

requireGuestProvisionSignal

boolean

Propiedad opcional que debe establecerse en True o omitirse.

secrets

VaultSecretGroup[]

Especifica el conjunto de certificados que debe instalarse en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault para Linux o la extensión de máquina virtual de Azure Key Vault para Windows.

windowsConfiguration

WindowsConfiguration

Especifica la configuración del sistema operativo de Windows en la máquina virtual.

PassNames

Nombre de paso. Actualmente, el único valor permitido es OobeSystem.

Nombre Tipo Description
OobeSystem

string

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Desconocido", "Failed", "Succeeded" o "CompletedWithWarnings".

Nombre Tipo Description
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

PatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.

Nombre Tipo Description
assessmentMode

WindowsPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica una configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.

enableHotpatching

boolean

Permite a los clientes aplicar revisiones a sus máquinas virtuales de Azure sin necesidad de reiniciar. Para enableHotpatching, el "provisionVMAgent" debe establecerse en true y "patchMode" debe establecerse en "AutomaticByPlatform".

patchMode

WindowsVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual en máquinas virtuales IaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

Manual : controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false.

AutomaticByOS : el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true.

AutomaticByPlatform : la máquina virtual se actualizará automáticamente por la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.

Plan

Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para las imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En el Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción-> . Escriba cualquier información necesaria y, a continuación, haga clic en Guardar.

Nombre Tipo Description
name

string

Identificador del plan.

product

string

Especifica el producto de la imagen de Marketplace. Este es el mismo valor que Offer en el elemento imageReference.

promotionCode

string

El código de la promoción.

publisher

string

Identificador del publicador.

ProtocolTypes

Especifica el protocolo del agente de escucha de WinRM. Los valores posibles son: http,https.

Nombre Tipo Description
Http

string

Https

string

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2024-03-01.

Nombre Tipo Description
enabled

boolean

Especifica si la característica ProxyAgent debe estar habilitada en la máquina virtual o en el conjunto de escalado de máquinas virtuales.

keyIncarnationId

integer

Aumentar el valor de esta propiedad permite al usuario restablecer la clave utilizada para proteger el canal de comunicación entre el invitado y el host.

mode

Mode

Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión de host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es El modo Aplicar.

PublicIPAddressSku

Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

Nombre Tipo Description
name

PublicIPAddressSkuName

Especificación del nombre de SKU de ip pública

tier

PublicIPAddressSkuTier

Especificación del nivel de SKU de ip pública

PublicIPAddressSkuName

Especificación del nombre de SKU de ip pública

Nombre Tipo Description
Basic

string

Standard

string

PublicIPAddressSkuTier

Especificación del nivel de SKU de ip pública

Nombre Tipo Description
Global

string

Regional

string

PublicIPAllocationMethod

Especificación del tipo de asignación de IP pública

Nombre Tipo Description
Dynamic

string

Static

string

ResourceIdentityType

Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.

Nombre Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ScheduledEventsAdditionalPublishingTargets

Los parámetros de configuración usados al publicar scheduledEventsAdditionalPublishingTargets.

Nombre Tipo Description
eventGridAndResourceGraph

EventGridAndResourceGraph

Los parámetros de configuración usados al crear el valor eventGridAndResourceGraph Scheduled Event.

ScheduledEventsPolicy

Especifica las configuraciones relacionadas con el evento programado Redeploy, Reboot y ScheduledEventsAdditionalPublishingTargets para la máquina virtual.

Nombre Tipo Description
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

Los parámetros de configuración usados al publicar scheduledEventsAdditionalPublishingTargets.

userInitiatedReboot

UserInitiatedReboot

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedReboot.

userInitiatedRedeploy

UserInitiatedRedeploy

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedRedeploy.

ScheduledEventsProfile

Especifica configuraciones relacionadas con eventos programados.

Nombre Tipo Description
osImageNotificationProfile

OSImageNotificationProfile

Especifica las configuraciones relacionadas con eventos programados de imagen del sistema operativo.

terminateNotificationProfile

TerminateNotificationProfile

Especifica las configuraciones relacionadas con el evento programado de finalización.

securityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado solo del blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

Nombre Tipo Description
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Especifica la configuración de perfil relacionada con la seguridad de la máquina virtual.

Nombre Tipo Description
encryptionAtHost

boolean

El usuario puede usar esta propiedad en la solicitud para habilitar o deshabilitar el cifrado de host para la máquina virtual o el conjunto de escalado de máquinas virtuales. Esto habilitará el cifrado para todos los discos, incluido el disco de recurso o temporal en el propio host. El comportamiento predeterminado es: el cifrado en el host se deshabilitará a menos que esta propiedad se establezca en true para el recurso.

encryptionIdentity

EncryptionIdentity

Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones del almacén de claves.

proxyAgentSettings

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2024-03-01.

securityType

SecurityTypes

Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.

uefiSettings

UefiSettings

Especifica la configuración de seguridad como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.

SecurityTypes

Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.

Nombre Tipo Description
ConfidentialVM

string

TrustedLaunch

string

SettingNames

Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.

Nombre Tipo Description
AutoLogon

string

FirstLogonCommands

string

SshConfiguration

Especifica la configuración de la clave SSH para un sistema operativo Linux.

Nombre Tipo Description
publicKeys

SshPublicKey[]

La lista de claves públicas SSH usadas para autenticarse con máquinas virtuales basadas en Linux.

SshPublicKey

Lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.

Nombre Tipo Description
keyData

string

Certificado de clave pública SSH que se usa para autenticarse con la máquina virtual mediante ssh. La clave debe tener al menos 2048 bits y en formato ssh-rsa. Para crear claves SSH, consulte [Creación de claves SSH en máquinas virtuales Linux y Mac para Linux en Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

Especifica la ruta de acceso completa en la máquina virtual creada donde se almacena la clave pública ssh. Si el archivo ya existe, la clave especificada se anexa al archivo. Ejemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

El código de nivel.

Nombre Tipo Description
Error

string

Info

string

Warning

string

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con el disco del sistema operativo.

Nombre Tipo Description
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

StorageProfile

Especifica la configuración de almacenamiento de los discos de máquina virtual.

Nombre Tipo Description
dataDisks

DataDisk[]

Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

diskControllerType

DiskControllerTypes

Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que la máquina virtual proporcionada se cree con "hyperVGeneration" establecida en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual a partir de la versión de API mínima especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco, a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna y reasigna implícitamente la máquina virtual. Versión mínima de api: 2022-08-01.

imageReference

ImageReference

Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.

osDisk

OSDisk

Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de los discos y discos duros virtuales para máquinas virtuales de Azure.

SubResource

Dirección URL relativa del Key Vault que contiene el secreto.

Nombre Tipo Description
id

string

Id. de recurso

TerminateNotificationProfile

Especifica las configuraciones relacionadas con el evento programado de finalización.

Nombre Tipo Description
enable

boolean

Especifica si el evento Terminate Scheduled está habilitado o deshabilitado.

notBeforeTimeout

string

La duración configurable de una máquina virtual que se va a eliminar tendrá que aprobar potencialmente el evento programado de finalización antes de que el evento se apruebe automáticamente (se agota el tiempo de espera). La configuración debe especificarse en formato ISO 8601, el valor predeterminado es de 5 minutos (PT5M).

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.

Nombre Tipo Description
secureBootEnabled

boolean

Especifica si se debe habilitar el arranque seguro en la máquina virtual. Versión mínima de api: 2020-12-01.

vTpmEnabled

boolean

Especifica si vTPM debe habilitarse en la máquina virtual. Versión mínima de api: 2020-12-01.

UserAssignedIdentities

Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nombre Tipo Description

UserInitiatedReboot

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedReboot.

Nombre Tipo Description
automaticallyApprove

boolean

Especifica las configuraciones relacionadas con el evento programado de reinicio.

UserInitiatedRedeploy

Los parámetros de configuración usados al crear la configuración de eventos programados userInitiatedRedeploy.

Nombre Tipo Description
automaticallyApprove

boolean

Especifica las configuraciones relacionadas con el evento programado de reimplementación.

VaultCertificate

Lista de referencias del almacén de claves en SourceVault que contienen certificados.

Nombre Tipo Description
certificateStore

string

En el caso de las máquinas virtuales Windows, especifica el almacén de certificados en la máquina virtual a la que se debe agregar el certificado. El almacén de certificados especificado se encuentra implícitamente en la cuenta localMachine. En el caso de las máquinas virtuales Linux, el archivo de certificado se coloca en el directorio /var/lib/waagent, con el nombre <de archivo UppercaseThumbprint.crt> para el archivo de certificado X509 y <UppercaseThumbprint.prv> para la clave privada. Ambos archivos tienen formato .pem.

certificateUrl

string

Esta es la dirección URL de un certificado que se ha cargado en Key Vault como secreto. Para agregar un secreto a la Key Vault, consulte Incorporación de una clave o un secreto al almacén de claves. En este caso, el certificado debe ser La codificación Base64 del siguiente objeto JSON que está codificado en UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault para Linux o la extensión de máquina virtual de Azure Key Vault para Windows.

VaultSecretGroup

Especifica el conjunto de certificados que debe instalarse en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault para Linux o la extensión de máquina virtual de Azure Key Vault para Windows.

Nombre Tipo Description
sourceVault

SubResource

Dirección URL relativa del Key Vault que contiene todos los certificados de VaultCertificates.

vaultCertificates

VaultCertificate[]

Lista de referencias del almacén de claves en SourceVault que contienen certificados.

VirtualHardDisk

Disco duro virtual.

Nombre Tipo Description
uri

string

Especifica el URI del disco duro virtual.

VirtualMachine

Describe una máquina virtual.

Nombre Tipo Description
etag

string

Etag es la propiedad devuelta en la respuesta Create/Update/Get de la máquina virtual, para que el cliente pueda suministrarla en el encabezado para garantizar actualizaciones optimistas.

extendedLocation

ExtendedLocation

Ubicación extendida de la máquina virtual.

id

string

Id. de recurso

identity

VirtualMachineIdentity

Identidad de la máquina virtual, si está configurada.

location

string

Ubicación de los recursos

managedBy

string

ManagedBy se establece en Virtual Machine Scale Set(VMSS) flex resourceID de ARM, si la máquina virtual forma parte de VMSS. Esta propiedad la usa la plataforma para la optimización de eliminación del grupo de recursos interno.

name

string

Nombre del recurso

plan

Plan

Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para las imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En el Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción-> . Escriba cualquier información necesaria y, a continuación, haga clic en Guardar.

properties.additionalCapabilities

AdditionalCapabilities

Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual.

properties.applicationProfile

ApplicationProfile

Especifica las aplicaciones de la galería que deben estar disponibles para la máquina virtual o VMSS.

properties.availabilitySet

SubResource

Especifica información sobre el conjunto de disponibilidad al que se debe asignar la máquina virtual. Las máquinas virtuales especificadas en el mismo conjunto de disponibilidad establecido se asignan a varios nodos para maximizar la disponibilidad. Para más información sobre los conjuntos de disponibilidad, consulte Introducción a los conjuntos de disponibilidad. Para más información sobre el mantenimiento planeado de Azure, consulte Mantenimiento y actualizaciones de Virtual Machines en Azure. Actualmente, una máquina virtual solo se puede agregar al conjunto de disponibilidad en el momento de la creación. El conjunto de disponibilidad al que se agrega la máquina virtual debe estar en el mismo grupo de recursos que el recurso del conjunto de disponibilidad. No se puede agregar una máquina virtual existente a un conjunto de disponibilidad. Esta propiedad no puede existir junto con una referencia properties.virtualMachineScaleSet que no sea NULL.

properties.billingProfile

BillingProfile

Especifica los detalles relacionados con la facturación de una máquina virtual de Acceso puntual de Azure. Versión mínima de api: 2019-03-01.

properties.capacityReservation

CapacityReservationProfile

Especifica información sobre la reserva de capacidad que se usa para asignar la máquina virtual. Versión mínima de api: 2021-04-01.

properties.diagnosticsProfile

DiagnosticsProfile

Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.

properties.evictionPolicy

VirtualMachineEvictionPolicyTypes

Especifica la directiva de expulsión para la máquina virtual de Acceso puntual de Azure y el conjunto de escalado de Azure Spot. En el caso de las máquinas virtuales de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2019-03-01. En el caso de los conjuntos de escalado de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2017-10-30-preview.

properties.extensionsTimeBudget

string

Especifica el tiempo asignado para que se inicien todas las extensiones. La duración del tiempo debe estar entre 15 minutos y 120 minutos (ambos incluidos) y debe especificarse en formato ISO 8601. El valor predeterminado es 90 minutos (PT1H30M). Versión mínima de api: 2020-06-01.

properties.hardwareProfile

HardwareProfile

Especifica la configuración de hardware de la máquina virtual.

properties.host

SubResource

Especifica información sobre el host dedicado en el que reside la máquina virtual. Versión mínima de api: 2018-10-01.

properties.hostGroup

SubResource

Especifica información sobre el grupo host dedicado en el que reside la máquina virtual. Nota: El usuario no puede especificar las propiedades host y hostGroup. Versión mínima de api: 2020-06-01.

properties.instanceView

VirtualMachineInstanceView

Vista de instancia de máquina virtual.

properties.licenseType

string

Especifica que la imagen o el disco que se usa tenían licencias locales.

Los valores posibles para el sistema operativo Windows Server son:

Windows_Client

Windows_Server

Los valores posibles para el sistema operativo Linux Server son:

RHEL_BYOS (para RHEL)

SLES_BYOS (para SUSE)

Para más información, consulte Ventaja de uso híbrido de Azure para Windows Server.

Ventaja de uso híbrido de Azure para Linux Server

Versión mínima de api: 2015-06-15

properties.networkProfile

NetworkProfile

Especifica las interfaces de red de la máquina virtual.

properties.osProfile

OSProfile

Especifica la configuración del sistema operativo utilizada al crear la máquina virtual. Algunas de las opciones de configuración no se pueden cambiar una vez que se aprovisiona la máquina virtual.

properties.platformFaultDomain

integer

Especifica el dominio de error lógico del conjunto de escalado en el que se creará la máquina virtual. De forma predeterminada, la máquina virtual se asignará automáticamente a un dominio de error que mejor mantenga el equilibrio entre los dominios de error disponibles. Esto solo es aplicable si se establece la propiedad "virtualMachineScaleSet" de esta máquina virtual. El conjunto de escalado de máquinas virtuales al que se hace referencia debe tener "platformFaultDomainCount" mayor que 1. Esta propiedad no se puede actualizar una vez creada la máquina virtual. La asignación de dominio de error se puede ver en la vista Instancia de máquina virtual. Versión mínima de api:2020-12-01.

properties.priority

VirtualMachinePriorityTypes

Especifica la prioridad de la máquina virtual. Versión mínima de api: 2019-03-01

properties.provisioningState

string

El estado de aprovisionamiento, que solo aparece en la respuesta.

properties.proximityPlacementGroup

SubResource

Especifica información sobre el grupo de selección de ubicación de proximidad al que se debe asignar la máquina virtual. Versión mínima de api: 2018-04-01.

properties.scheduledEventsPolicy

ScheduledEventsPolicy

Especifica las configuraciones relacionadas con el evento programado Redeploy, Reboot y ScheduledEventsAdditionalPublishingTargets para la máquina virtual.

properties.scheduledEventsProfile

ScheduledEventsProfile

Especifica configuraciones relacionadas con eventos programados.

properties.securityProfile

SecurityProfile

Especifica la configuración de perfil relacionada con la seguridad de la máquina virtual.

properties.storageProfile

StorageProfile

Especifica la configuración de almacenamiento de los discos de máquina virtual.

properties.timeCreated

string

Especifica la hora en la que se creó el recurso de máquina virtual. Versión mínima de api: 2021-11-01.

properties.userData

string

UserData para la máquina virtual, que debe estar codificada en base 64. El cliente no debe pasar ningún secreto aquí. Versión mínima de api: 2021-03-01.

properties.virtualMachineScaleSet

SubResource

Especifica información sobre el conjunto de escalado de máquinas virtuales al que se debe asignar la máquina virtual. Las máquinas virtuales especificadas en el mismo conjunto de escalado de máquinas virtuales se asignan a nodos diferentes para maximizar la disponibilidad. Actualmente, una máquina virtual solo se puede agregar al conjunto de escalado de máquinas virtuales en el momento de la creación. No se puede agregar una máquina virtual existente a un conjunto de escalado de máquinas virtuales. Esta propiedad no puede existir junto con una referencia properties.availabilitySet que no sea NULL. Versión mínima de api:2019-03-01.

properties.vmId

string

Especifica el identificador único de la máquina virtual, que es un identificador de 128 bits codificado y almacenado en todas las VM de IaaS de Azure SMBIOS y que se puede leer mediante comandos bios de plataforma.

resources

VirtualMachineExtension[]

Recursos de extensión secundaria de máquina virtual.

tags

object

Etiquetas del recurso

type

string

Tipo de recurso

zones

string[]

Zonas de máquina virtual.

VirtualMachineAgentInstanceView

Agente de máquina virtual que se ejecuta en la máquina virtual.

Nombre Tipo Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Vista de instancia del controlador de extensión de máquina virtual.

statuses

InstanceViewStatus[]

Información de estado del recurso.

vmAgentVersion

string

Versión completa del agente de máquina virtual.

VirtualMachineEvictionPolicyTypes

Especifica la directiva de expulsión para la máquina virtual de Azure Spot y el conjunto de escalado de acceso puntual de Azure. En el caso de las máquinas virtuales de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2019-03-01. En el caso de los conjuntos de escalado de Acceso puntual de Azure, se admiten "Deallocate" y "Delete" y la versión mínima de api es 2017-10-30-preview.

Nombre Tipo Description
Deallocate

string

Delete

string

VirtualMachineExtension

Recursos de extensión secundaria de máquina virtual.

Nombre Tipo Description
id

string

Id. de recurso

location

string

Ubicación de los recursos

name

string

Nombre del recurso

properties.autoUpgradeMinorVersion

boolean

Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.

properties.enableAutomaticUpgrade

boolean

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.

properties.forceUpdateTag

string

Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.

properties.instanceView

VirtualMachineExtensionInstanceView

Vista de instancia de extensión de máquina virtual.

properties.protectedSettings

object

La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

La configuración protegida de extensiones que se pasa por referencia y se consume desde el almacén de claves.

properties.provisionAfterExtensions

string[]

Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.

properties.provisioningState

string

El estado de aprovisionamiento, que solo aparece en la respuesta.

properties.publisher

string

Nombre del publicador del controlador de extensiones.

properties.settings

object

Configuración pública con formato JSON para la extensión.

properties.suppressFailures

boolean

Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.

properties.type

string

Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".

properties.typeHandlerVersion

string

Especifica la versión del controlador de script.

tags

object

Etiquetas del recurso

type

string

Tipo de recurso

VirtualMachineExtensionHandlerInstanceView

Vista de instancia del controlador de extensión de máquina virtual.

Nombre Tipo Description
status

InstanceViewStatus

Estado del controlador de extensión.

type

string

Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".

typeHandlerVersion

string

Especifica la versión del controlador de script.

VirtualMachineExtensionInstanceView

Vista de instancia de extensión de máquina virtual.

Nombre Tipo Description
name

string

Nombre de la extensión de máquina virtual.

statuses

InstanceViewStatus[]

Información de estado del recurso.

substatuses

InstanceViewStatus[]

Información de estado del recurso.

type

string

Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".

typeHandlerVersion

string

Especifica la versión del controlador de script.

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

Nombre Tipo Description
status

InstanceViewStatus

Información de estado de mantenimiento de la máquina virtual.

VirtualMachineIdentity

Identidad de la máquina virtual, si está configurada.

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad de la identidad de la máquina virtual. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

tenantId

string

Identificador de inquilino asociado a la máquina virtual. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

type

ResourceIdentityType

Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.

userAssignedIdentities

UserAssignedIdentities

Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineInstanceView

Vista de instancia de máquina virtual.

Nombre Tipo Description
assignedHost

string

Identificador de recurso del host dedicado, en el que se asigna la máquina virtual a través de la selección de ubicación automática, cuando la máquina virtual está asociada a un grupo host dedicado que tiene habilitada la selección de ubicación automática. Versión mínima de api: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

computerName

string

Nombre del equipo asignado a la máquina virtual.

disks

DiskInstanceView[]

Información del disco de la máquina virtual.

extensions

VirtualMachineExtensionInstanceView[]

La información de extensiones.

hyperVGeneration

HyperVGenerationType

Especifica el tipo hyperVGeneration asociado a un recurso.

isVMInStandbyPool

boolean

[Característica en versión preliminar] Especifica si la máquina virtual está actualmente dentro o fuera del grupo en espera.

maintenanceRedeployStatus

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

osName

string

Sistema operativo que se ejecuta en la máquina virtual.

osVersion

string

La versión del sistema operativo que se ejecuta en la máquina virtual.

patchStatus

VirtualMachinePatchStatus

[Característica en versión preliminar] Estado de las operaciones de revisión de máquina virtual.

platformFaultDomain

integer

Especifica el dominio con error de la máquina virtual.

platformUpdateDomain

integer

Especifica el dominio de actualización de la máquina virtual.

rdpThumbPrint

string

Huella digital del certificado de Escritorio remoto.

statuses

InstanceViewStatus[]

Información de estado del recurso.

vmAgent

VirtualMachineAgentInstanceView

El agente de máquina virtual que se ejecuta en la máquina virtual.

vmHealth

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

VirtualMachineIpTag

Lista de etiquetas IP asociadas a la dirección IP pública.

Nombre Tipo Description
ipTagType

string

Tipo de etiqueta IP. Ejemplo: FirstPartyUsage.

tag

string

Etiqueta IP asociada a la dirección IP pública. Ejemplo: SQL, Storage, etc.

VirtualMachineNetworkInterfaceConfiguration

Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.

Nombre Tipo Description
name

string

Nombre de configuración de la interfaz de red.

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.

properties.deleteOption

DeleteOptions

Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual

properties.disableTcpStateTracking

boolean

Especifica si la interfaz de red está deshabilitada para el seguimiento de estado tcp.

properties.dnsSettings

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

La configuración dns que se va a aplicar en las interfaces de red.

properties.dscpConfiguration

SubResource

properties.enableAcceleratedNetworking

boolean

Especifica si la interfaz de red está habilitada para redes aceleradas.

properties.enableFpga

boolean

Especifica si la interfaz de red está habilitada para redes fpGA.

properties.enableIPForwarding

boolean

Si el reenvío IP está habilitado en esta NIC.

properties.ipConfigurations

VirtualMachineNetworkInterfaceIPConfiguration[]

Especifica las configuraciones IP de la interfaz de red.

properties.networkSecurityGroup

SubResource

El grupo de seguridad de red.

properties.primary

boolean

Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

La configuración dns que se va a aplicar en las interfaces de red.

Nombre Tipo Description
dnsServers

string[]

Lista de direcciones IP de servidores DNS

VirtualMachineNetworkInterfaceIPConfiguration

Especifica las configuraciones IP de la interfaz de red.

Nombre Tipo Description
name

string

Nombre de configuración de IP.

properties.applicationGatewayBackendAddressPools

SubResource[]

Especifica una matriz de referencias a grupos de direcciones de back-end de puertas de enlace de aplicaciones. Una máquina virtual puede hacer referencia a grupos de direcciones de back-end de varias puertas de enlace de aplicaciones. Varias máquinas virtuales no pueden usar la misma puerta de enlace de aplicaciones.

properties.applicationSecurityGroups

SubResource[]

Especifica una matriz de referencias al grupo de seguridad de aplicaciones.

properties.loadBalancerBackendAddressPools

SubResource[]

Especifica una matriz de referencias a grupos de direcciones de back-end de equilibradores de carga. Una máquina virtual puede hacer referencia a grupos de direcciones de back-end de un equilibrador de carga público y interno. [Varias máquinas virtuales no pueden usar el mismo equilibrador de carga de SKU básico].

properties.primary

boolean

Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

properties.privateIPAddressVersion

IPVersions

Disponible desde Api-Version 2017-03-30 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" y "IPv6".

properties.publicIPAddressConfiguration

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

properties.subnet

SubResource

Especifica el identificador de la subred.

VirtualMachinePatchStatus

[Característica de vista previa] Estado de las operaciones de revisión de máquina virtual.

Nombre Tipo Description
availablePatchSummary

AvailablePatchSummary

El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.

configurationStatuses

InstanceViewStatus[]

Estado de habilitación del patchMode especificado

lastPatchInstallationSummary

LastPatchInstallationSummary

El resumen de instalación de la operación de instalación más reciente para la máquina virtual.

VirtualMachinePriorityTypes

Especifica la prioridad de la máquina virtual. Versión mínima de api: 2019-03-01

Nombre Tipo Description
Low

string

Regular

string

Spot

string

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

Nombre Tipo Description
name

string

El nombre de configuración de la dirección publicIP.

properties.deleteOption

DeleteOptions

Especificación de lo que sucede con la dirección IP pública cuando se elimina la máquina virtual

properties.dnsSettings

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Configuración dns que se va a aplicar en las direcciones publicIP.

properties.idleTimeoutInMinutes

integer

Tiempo de espera de inactividad de la dirección IP pública.

properties.ipTags

VirtualMachineIpTag[]

Lista de etiquetas IP asociadas a la dirección IP pública.

properties.publicIPAddressVersion

IPVersions

Disponible desde Api-Version 2019-07-01 en adelante, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" y "IPv6".

properties.publicIPAllocationMethod

PublicIPAllocationMethod

Especificación del tipo de asignación de IP pública

properties.publicIPPrefix

SubResource

PublicIPPrefix desde el que se van a asignar direcciones publicIP.

sku

PublicIPAddressSku

Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Configuración dns que se va a aplicar en las direcciones publicIP.

Nombre Tipo Description
domainNameLabel

string

Prefijo de etiqueta de nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio y el identificador único del perfil de red de la máquina virtual.

domainNameLabelScope

DomainNameLabelScopeTypes

Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio con hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.

VirtualMachineSizeTypes

Especifica el tamaño de la máquina virtual. El tipo de datos enum está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para más información sobre los tamaños de máquina virtual, consulte Tamaños para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.

Nombre Tipo 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 el perfil de seguridad del disco administrado.

Nombre Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado por el cliente para el disco administrado que se usa para el disco del sistema operativo ConfidentialVM cifrado de clave administrada por el cliente y el blob VMGuest.

securityEncryptionType

securityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado solo del blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

VMGalleryApplication

Especifica las aplicaciones de la galería que se deben poner a disposición de la máquina virtual o VMSS.

Nombre Tipo Description
configurationReference

string

Opcional, especifica el URI en un blob de Azure que reemplazará la configuración predeterminada del paquete si se proporciona.

enableAutomaticUpgrade

boolean

Si se establece en true, cuando una nueva versión de aplicación de la galería está disponible en PIR/SIG, se actualizará automáticamente para la máquina virtual o VMSS.

order

integer

Opcional, especifica el orden en el que se deben instalar los paquetes.

packageReferenceId

string

Especifica el identificador de recurso GalleryApplicationVersion en forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{version}

tags

string

Opcional, especifica un valor de paso a través para un contexto más genérico.

treatFailureAsDeploymentFailure

boolean

Opcional, si es true, se producirá un error en cualquier operación de VmApplication.

VMSizeProperties

Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de Personalización de máquina virtual para obtener más detalles.

Nombre Tipo Description
vCPUsAvailable

integer

Especifica el número de vCPU disponibles para la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado es establecerlo en el valor de vCPU disponibles para ese tamaño de máquina virtual expuesto en la respuesta de api de Enumerar todos los tamaños de máquina virtual disponibles en una región.

vCPUsPerCore

integer

Especifica la relación de núcleos físicos de vCPU. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado se establece en el valor de vCPUsPerCore para el tamaño de máquina virtual expuesto en la respuesta de api de Enumerar todos los tamaños de máquina virtual disponibles en una región. Establecer esta propiedad en 1 también significa que hyper-threading está deshabilitado.

WindowsConfiguration

Especifica la configuración del sistema operativo de Windows en la máquina virtual.

Nombre Tipo Description
additionalUnattendContent

AdditionalUnattendContent[]

Especifica información adicional con formato XML codificado en base 64 que se puede incluir en el archivo Unattend.xml, usado por el programa de instalación de Windows.

enableAutomaticUpdates

boolean

Indica si la Novedades automática está habilitada para la máquina virtual Windows. El valor predeterminado es true. En el caso de los conjuntos de escalado de máquinas virtuales, esta propiedad se puede actualizar y las actualizaciones surtirán efecto en el reaprovisionamiento del sistema operativo.

enableVMAgentPlatformUpdates

boolean

Indica si vmAgent Platform Novedades está habilitado para la máquina virtual Windows. El valor predeterminado es False.

patchSettings

PatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.

provisionVMAgent

boolean

Indica si el agente de máquina virtual debe aprovisionarse en la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, se establece en true de forma predeterminada. Esto garantizará que el agente de máquina virtual esté instalado en la máquina virtual para que las extensiones se puedan agregar a la máquina virtual más adelante.

timeZone

string

Especifica la zona horaria de la máquina virtual. Por ejemplo, "Hora estándar del Pacífico". Los valores posibles pueden ser TimeZoneInfo.Id valor de las zonas horarias devueltas por TimeZoneInfo.GetSystemTimeZones.

winRM

WinRMConfiguration

Especifica los agentes de escucha de administración remota de Windows. De este modo se habilita Windows PowerShell.

WindowsPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault : controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform : la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

Nombre Tipo Description
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

Nombre Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica una configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.

Nombre Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite al cliente programar la aplicación de revisiones sin actualizaciones accidentales

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

WindowsVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

Manual : controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false

AutomaticByOS : el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true.

AutomaticByPlatform : la máquina virtual se actualizará automáticamente por la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.

Nombre Tipo Description
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

Especifica los agentes de escucha de administración remota de Windows. De este modo se habilita Windows PowerShell.

Nombre Tipo Description
listeners

WinRMListener[]

Lista de agentes de escucha de administración remota de Windows

WinRMListener

Lista de agentes de escucha de administración remota de Windows

Nombre Tipo Description
certificateUrl

string

Esta es la dirección URL de un certificado que se ha cargado en Key Vault como secreto. Para agregar un secreto al Key Vault, consulte Incorporación de una clave o un secreto al almacén de claves. En este caso, el certificado debe ser la codificación Base64 del siguiente objeto JSON que se codifica en UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault para Linux o la extensión de máquina virtual de Azure Key Vault para Windows.

protocol

ProtocolTypes

Especifica el protocolo del agente de escucha de WinRM. Los valores posibles son: http,https.