Virtual Machines - Create Or Update
Create a new virtual machine or update the properties of the existing virtual machine.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}?api-version=2025-09-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
|
virtual
|
path | True |
string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ |
The name of the virtual machine. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| If-Match |
string |
The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. |
|
| If-None-Match |
string |
Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| extendedLocation | True |
The extended location of the resource. This property is required when creating the resource. |
|
| location | True |
string |
The geo-location where the resource lives |
| properties.adminUsername | True |
string minLength: 1maxLength: 32 pattern: ^[a-z_][a-z0-9_]{0,31}$ |
The name of the administrator to which the ssh public keys will be added into the authorized keys. |
| properties.cloudServicesNetworkAttachment | True |
The cloud service network that provides platform-level services for the virtual machine. |
|
| properties.cpuCores | True |
integer (int64) minimum: 2 |
The number of CPU cores in the virtual machine. |
| properties.memorySizeGB | True |
integer (int64) minimum: 1 |
The memory size of the virtual machine. Allocations are measured in gibibytes. |
| properties.storageProfile | True |
The storage profile that specifies size and other parameters about the disks related to the virtual machine. |
|
| properties.vmImage | True |
string |
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. |
| identity |
The managed service identities assigned to this resource. |
||
| properties.bootMethod |
Selects the boot method for the virtual machine. |
||
| properties.consoleExtendedLocation |
The extended location to use for creation of a VM console resource. |
||
| properties.isolateEmulatorThread |
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. |
||
| properties.networkAttachments |
The list of network attachments to the virtual machine. |
||
| properties.networkData |
string |
Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property. |
|
| properties.networkDataContent |
string (password) |
The Base64 encoded cloud-init network data. |
|
| properties.placementHints |
The scheduling hints for the virtual machine. |
||
| properties.sshPublicKeys |
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. |
||
| properties.userData |
string |
Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property. |
|
| properties.userDataContent |
string (password) |
The Base64 encoded cloud-init user data. |
|
| properties.virtioInterface |
Field Deprecated, use virtualizationModel instead. The type of the virtio interface. |
||
| properties.vmDeviceModel |
The type of the device model to use. |
||
| properties.vmImageRepositoryCredentials |
The credentials used to login to the image repository that has access to the specified image. |
||
| tags |
object |
Resource tags. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Resource 'VirtualMachine' update operation succeeded |
|
| 201 Created |
Resource 'VirtualMachine' create operation succeeded Headers Azure-AsyncOperation: string |
|
| Other Status Codes |
An unexpected error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
Create or update virtual machine
Sample request
PUT https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName?api-version=2025-09-01
{
"extendedLocation": {
"name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
"type": "CustomLocation"
},
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {}
}
},
"location": "location",
"properties": {
"adminUsername": "username",
"bootMethod": "UEFI",
"cloudServicesNetworkAttachment": {
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
"ipAllocationMethod": "Dynamic"
},
"cpuCores": 2,
"memorySizeGB": 8,
"networkAttachments": [
{
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
"defaultGateway": "True",
"ipAllocationMethod": "Dynamic",
"ipv4Address": "198.51.100.1",
"ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
"networkAttachmentName": "netAttachName01"
}
],
"networkDataContent": "bmV0d29ya0RhdGVTYW1wbGU=",
"placementHints": [
{
"hintType": "Affinity",
"resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
"schedulingExecution": "Hard",
"scope": ""
}
],
"sshPublicKeys": [
{
"keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
}
],
"storageProfile": {
"osDisk": {
"createOption": "Ephemeral",
"deleteOption": "Delete",
"diskSizeGB": 120
},
"volumeAttachments": [
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
]
},
"userDataContent": "dXNlckRhdGVTYW1wbGU=",
"vmDeviceModel": "T2",
"vmImage": "myacr.azurecr.io/foobar:latest",
"vmImageRepositoryCredentials": {
"password": "{password}",
"registryUrl": "myacr.azurecr.io",
"username": "myuser"
}
},
"tags": {
"key1": "myvalue1",
"key2": "myvalue2"
}
}
Sample response
{
"extendedLocation": {
"name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
"type": "CustomLocation"
},
"id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {}
}
},
"location": "location",
"name": "virtualMachineName",
"properties": {
"adminUsername": "username",
"availabilityZone": "1",
"bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
"bootMethod": "UEFI",
"cloudServicesNetworkAttachment": {
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
"ipAllocationMethod": "Dynamic"
},
"clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
"consoleExtendedLocation": {
"name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/consoleCustomLocationName",
"type": "CustomLocation"
},
"cpuCores": 2,
"detailedStatus": "Available",
"detailedStatusMessage": "VM is up and healthy",
"memorySizeGB": 8,
"networkAttachments": [
{
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
"defaultGateway": "True",
"ipAllocationMethod": "Dynamic",
"ipv4Address": "198.51.100.1",
"ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
"macAddress": "bf:1c:29:31:31:1f",
"networkAttachmentName": "netAttachName01"
}
],
"placementHints": [
{
"hintType": "Affinity",
"resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
"schedulingExecution": "Hard",
"scope": ""
}
],
"powerState": "On",
"provisioningState": "Succeeded",
"sshPublicKeys": [
{
"keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
}
],
"storageProfile": {
"osDisk": {
"createOption": "Ephemeral",
"deleteOption": "Delete",
"diskSizeGB": 120
},
"volumeAttachments": [
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
]
},
"vmDeviceModel": "T2",
"vmImage": "myacr.azurecr.io/foobar:latest",
"vmImageRepositoryCredentials": {
"registryUrl": "myacr.azurecr.io",
"username": "myuser"
},
"volumes": [
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
]
},
"systemData": {
"createdAt": "2021-01-22T13:27:03.008Z",
"createdBy": "identityA",
"createdByType": "Application",
"lastModifiedAt": "2021-01-22T13:29:03.001Z",
"lastModifiedBy": "identityB",
"lastModifiedByType": "User"
},
"tags": {
"key1": "myvalue1",
"key2": "myvalue2"
},
"type": "Microsoft.NetworkCloud/virtualMachines"
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2025-09-01
{
"extendedLocation": {
"name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
"type": "CustomLocation"
},
"id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {}
}
},
"location": "location",
"name": "virtualMachineName",
"properties": {
"adminUsername": "username",
"availabilityZone": "1",
"bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
"bootMethod": "UEFI",
"cloudServicesNetworkAttachment": {
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
"ipAllocationMethod": "Dynamic"
},
"clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
"consoleExtendedLocation": {
"name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/consoleCustomLocationName",
"type": "CustomLocation"
},
"cpuCores": 2,
"detailedStatus": "Available",
"detailedStatusMessage": "VM is up and healthy",
"memorySizeGB": 8,
"networkAttachments": [
{
"attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
"defaultGateway": "True",
"ipAllocationMethod": "Dynamic",
"ipv4Address": "198.51.100.1",
"ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
"macAddress": "bf:1c:29:31:31:1f",
"networkAttachmentName": "netAttachName01"
}
],
"placementHints": [
{
"hintType": "Affinity",
"resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
"schedulingExecution": "Hard",
"scope": ""
}
],
"powerState": "On",
"provisioningState": "Accepted",
"sshPublicKeys": [
{
"keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
}
],
"storageProfile": {
"osDisk": {
"createOption": "Ephemeral",
"deleteOption": "Delete",
"diskSizeGB": 120
},
"volumeAttachments": [
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
]
},
"vmDeviceModel": "T2",
"vmImage": "myacr.azurecr.io/foobar:latest",
"vmImageRepositoryCredentials": {
"registryUrl": "myacr.azurecr.io",
"username": "myuser"
},
"volumes": [
"/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
]
},
"systemData": {
"createdAt": "2021-01-22T13:27:03.008Z",
"createdBy": "identityA",
"createdByType": "Application",
"lastModifiedAt": "2021-01-22T13:29:03.001Z",
"lastModifiedBy": "identityB",
"lastModifiedByType": "User"
},
"tags": {
"key1": "myvalue1",
"key2": "myvalue2"
},
"type": "Microsoft.NetworkCloud/virtualMachines"
}
Definitions
| Name | Description |
|---|---|
|
Azure. |
The complex type of the extended location. |
|
created |
The type of identity that created the resource. |
|
Default |
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Extended |
The type of the extended location. |
|
Image |
ImageRepositoryCredentials represents the credentials used to login to the image repository. |
|
Managed |
Managed service identity (system assigned and/or user assigned identities) |
|
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
Network |
NetworkAttachment represents the single network attachment. |
|
Os |
OsDisk represents configuration of the boot disk. |
|
Os |
The strategy for creating the OS disk. |
|
Os |
The strategy for deleting the OS disk. |
|
Ssh |
SshPublicKey represents the public key used to authenticate with a resource through SSH. |
|
Storage |
StorageProfile represents information about a disk. |
|
system |
Metadata pertaining to creation and last modification of the resource. |
|
User |
User assigned identity properties |
|
Virtual |
VirtualMachine represents the on-premises Network Cloud virtual machine. |
|
Virtual |
Selects the boot method for the virtual machine. |
|
Virtual |
The more detailed status of the virtual machine. |
|
Virtual |
The type of the device model to use. |
|
Virtual |
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. |
|
Virtual |
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. |
|
Virtual |
VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine. |
|
Virtual |
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. |
|
Virtual |
The specification of whether this hint supports affinity or anti-affinity with the referenced resources. |
|
Virtual |
The power state of the virtual machine. |
|
Virtual |
The provisioning state of the virtual machine. |
|
Virtual |
The indicator of whether the hint is a hard or soft requirement during scheduling. |
|
Virtual |
Field Deprecated, use virtualizationModel instead. The type of the virtio interface. |
Azure.ResourceManager.CommonTypes.ExtendedLocation
The complex type of the extended location.
| Name | Type | Description |
|---|---|---|
| name |
string |
The name of the extended location. |
| type |
The type of the extended location. |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DefaultGateway
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
| Value | Description |
|---|---|
| True |
This is the default gateway. |
| False |
This is not the default gateway. |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
object |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
ExtendedLocationType
The type of the extended location.
| Value | Description |
|---|---|
| EdgeZone |
Azure Edge Zones location type |
| CustomLocation |
Azure Custom Locations type |
ImageRepositoryCredentials
ImageRepositoryCredentials represents the credentials used to login to the image repository.
| Name | Type | Description |
|---|---|---|
| password |
string (password) minLength: 1 |
The password or token used to access an image in the target repository. |
| registryUrl |
string |
The URL of the authentication server used to validate the repository credentials. |
| username |
string minLength: 1 |
The username used to access an image in the target repository. |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
| Name | Type | Description |
|---|---|---|
| principalId |
string (uuid) |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| tenantId |
string (uuid) |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
| userAssignedIdentities |
<string,
User |
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
| Value | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
NetworkAttachment
NetworkAttachment represents the single network attachment.
| Name | Type | Description |
|---|---|---|
| attachedNetworkId |
string (arm-id) |
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. |
| defaultGateway |
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. |
|
| ipAllocationMethod |
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. |
|
| ipv4Address |
string |
The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. |
| ipv6Address |
string |
The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. |
| macAddress |
string |
The MAC address of the interface for the virtual machine that corresponds to this network attachment. |
| networkAttachmentName |
string maxLength: 15 |
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. |
OsDisk
OsDisk represents configuration of the boot disk.
| Name | Type | Default value | Description |
|---|---|---|---|
| createOption | Ephemeral |
The strategy for creating the OS disk. |
|
| deleteOption | Delete |
The strategy for deleting the OS disk. |
|
| diskSizeGB |
integer (int64) |
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. |
OsDiskCreateOption
The strategy for creating the OS disk.
| Value | Description |
|---|---|
| Ephemeral |
The Os Disk will be created on ephemeral storage. |
| Persistent |
The Os Disk is on persistent storage. |
OsDiskDeleteOption
The strategy for deleting the OS disk.
| Value | Description |
|---|---|
| Delete |
The Os Disk will be deleted when the virtual machine is deleted. |
SshPublicKey
SshPublicKey represents the public key used to authenticate with a resource through SSH.
| Name | Type | Description |
|---|---|---|
| keyData |
string minLength: 1 |
The SSH public key data. |
StorageProfile
StorageProfile represents information about a disk.
| Name | Type | Description |
|---|---|---|
| osDisk |
The disk to use with this virtual machine. |
|
| volumeAttachments |
string[] |
The resource IDs of volumes that are requested to be attached to the virtual machine. |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |
UserAssignedIdentity
User assigned identity properties
| Name | Type | Description |
|---|---|---|
| clientId |
string (uuid) |
The client ID of the assigned identity. |
| principalId |
string (uuid) |
The principal ID of the assigned identity. |
VirtualMachine
VirtualMachine represents the on-premises Network Cloud virtual machine.
| Name | Type | Default value | Description |
|---|---|---|---|
| etag |
string |
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
|
| extendedLocation |
The extended location of the resource. This property is required when creating the resource. |
||
| id |
string (arm-id) |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
| identity |
The managed service identities assigned to this resource. |
||
| location |
string |
The geo-location where the resource lives |
|
| name |
string |
The name of the resource |
|
| properties.adminUsername |
string minLength: 1maxLength: 32 pattern: ^[a-z_][a-z0-9_]{0,31}$ |
The name of the administrator to which the ssh public keys will be added into the authorized keys. |
|
| properties.availabilityZone |
string |
The cluster availability zone containing this virtual machine. |
|
| properties.bareMetalMachineId |
string (arm-id) |
The resource ID of the bare metal machine that hosts the virtual machine. |
|
| properties.bootMethod | UEFI |
Selects the boot method for the virtual machine. |
|
| properties.cloudServicesNetworkAttachment |
The cloud service network that provides platform-level services for the virtual machine. |
||
| properties.clusterId |
string (arm-id) |
The resource ID of the cluster the virtual machine is created for. |
|
| properties.consoleExtendedLocation |
The extended location to use for creation of a VM console resource. |
||
| properties.cpuCores |
integer (int64) minimum: 2 |
The number of CPU cores in the virtual machine. |
|
| properties.detailedStatus |
The more detailed status of the virtual machine. |
||
| properties.detailedStatusMessage |
string |
The descriptive message about the current detailed status. |
|
| properties.isolateEmulatorThread | True |
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. |
|
| properties.memorySizeGB |
integer (int64) minimum: 1 |
The memory size of the virtual machine. Allocations are measured in gibibytes. |
|
| properties.networkAttachments |
The list of network attachments to the virtual machine. |
||
| properties.networkData |
string |
Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property. |
|
| properties.networkDataContent |
string (password) |
The Base64 encoded cloud-init network data. |
|
| properties.placementHints |
The scheduling hints for the virtual machine. |
||
| properties.powerState |
The power state of the virtual machine. |
||
| properties.provisioningState |
The provisioning state of the virtual machine. |
||
| properties.sshPublicKeys |
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. |
||
| properties.storageProfile |
The storage profile that specifies size and other parameters about the disks related to the virtual machine. |
||
| properties.userData |
string |
Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property. |
|
| properties.userDataContent |
string (password) |
The Base64 encoded cloud-init user data. |
|
| properties.virtioInterface | Modern |
Field Deprecated, use virtualizationModel instead. The type of the virtio interface. |
|
| properties.vmDeviceModel | T2 |
The type of the device model to use. |
|
| properties.vmImage |
string |
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. |
|
| properties.vmImageRepositoryCredentials |
The credentials used to login to the image repository that has access to the specified image. |
||
| properties.volumes |
string[] |
The resource IDs of volumes that are attached to the virtual machine. |
|
| systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
||
| tags |
object |
Resource tags. |
|
| type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
VirtualMachineBootMethod
Selects the boot method for the virtual machine.
| Value | Description |
|---|---|
| BIOS |
BIOS boot mode. |
| UEFI |
UEFI boot mode. |
VirtualMachineDetailedStatus
The more detailed status of the virtual machine.
| Value | Description |
|---|---|
| Available |
The Available status. |
| Error |
The Error status. |
| Provisioning |
The Provisioning status. |
| Running |
The Running status. |
| Scheduling |
The Scheduling status. |
| Stopped |
The Stopped status. |
| Terminating |
The Terminating status. |
| Unknown |
The Unknown status. |
VirtualMachineDeviceModelType
The type of the device model to use.
| Value | Description |
|---|---|
| T1 |
The T1 device model. |
| T2 |
The T2 device model. |
| T3 |
The T3 device model. |
VirtualMachineIPAllocationMethod
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
| Value | Description |
|---|---|
| Dynamic |
Dynamic VM IP allocation. |
| Static |
Static VM IP allocation. |
| Disabled |
No VM IP allocation. |
VirtualMachineIsolateEmulatorThread
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
| Value | Description |
|---|---|
| False |
Do not isolate the emulator thread. |
| True |
Isolate the emulator thread. |
VirtualMachinePlacementHint
VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.
| Name | Type | Description |
|---|---|---|
| hintType |
The specification of whether this hint supports affinity or anti-affinity with the referenced resources. |
|
| resourceId |
string (arm-id) |
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. |
| schedulingExecution |
The indicator of whether the hint is a hard or soft requirement during scheduling. |
|
| scope |
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. |
VirtualMachinePlacementHintPodAffinityScope
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
| Value | Description |
|---|---|
| Machine |
The virtual machine placement hint is scoped to the bare metal machine. |
| Rack |
The virtual machine placement hint is scoped to the rack. |
VirtualMachinePlacementHintType
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
| Value | Description |
|---|---|
| Affinity |
The virtual machine has affinity with the referenced resources. |
| AntiAffinity |
The virtual machine has anti-affinity with the referenced resources. |
VirtualMachinePowerState
The power state of the virtual machine.
| Value | Description |
|---|---|
| Off |
The virtual machine is powered off. |
| On |
The virtual machine is powered on. |
| Unknown |
The virtual machine power state is unknown. |
VirtualMachineProvisioningState
The provisioning state of the virtual machine.
| Value | Description |
|---|---|
| Accepted |
The Accepted status. |
| Canceled |
The Canceled status. |
| Failed |
The Failed status. |
| Provisioning |
The Provisioning status. |
| Succeeded |
The Succeeded status. |
VirtualMachineSchedulingExecution
The indicator of whether the hint is a hard or soft requirement during scheduling.
| Value | Description |
|---|---|
| Hard |
The hint is a requirement during scheduling. |
| Soft |
The hint is applied using a best-effort approach during scheduling. |
VirtualMachineVirtioInterfaceType
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
| Value | Description |
|---|---|
| Modern |
Modern virtio interface. |
| Transitional |
Transitional virtio interface. |