Virtual Machines - List By Subscription

Service:

Operator Nexus - Network Cloud

API Version:

2024-07-01

List virtual machines in the subscription.
Get a list of virtual machines in the provided subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VirtualMachineList	The resource list has been successfully retrieved.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

List virtual machines for subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/virtualMachines?api-version=2024-07-01

Java

/**
 * Samples for VirtualMachines List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/
     * VirtualMachines_ListBySubscription.json
     */
    /**
     * Sample code: List virtual machines for subscription.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        listVirtualMachinesForSubscription(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.virtualMachines().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python virtual_machines_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.virtual_machines.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c0a12a75b702054cf1e7fcd8c014d0fc116dea6e/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json
func ExampleVirtualMachinesClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualMachinesClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineList = armnetworkcloud.VirtualMachineList{
		// 	Value: []*armnetworkcloud.VirtualMachine{
		// 		{
		// 			Name: to.Ptr("virtualMachineName"),
		// 			Type: to.Ptr("Microsoft.NetworkCloud/virtualMachines"),
		// 			ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"),
		// 			SystemData: &armnetworkcloud.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
		// 				CreatedBy: to.Ptr("identityA"),
		// 				CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("identityB"),
		// 				LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("myvalue1"),
		// 				"key2": to.Ptr("myvalue2"),
		// 			},
		// 			ExtendedLocation: &armnetworkcloud.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
		// 				Type: to.Ptr("CustomLocation"),
		// 			},
		// 			Properties: &armnetworkcloud.VirtualMachineProperties{
		// 				AdminUsername: to.Ptr("username"),
		// 				AvailabilityZone: to.Ptr("1"),
		// 				BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
		// 				BootMethod: to.Ptr(armnetworkcloud.VirtualMachineBootMethodUEFI),
		// 				CloudServicesNetworkAttachment: &armnetworkcloud.NetworkAttachment{
		// 					AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
		// 					IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 				},
		// 				ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
		// 				CPUCores: to.Ptr[int64](2),
		// 				DetailedStatus: to.Ptr(armnetworkcloud.VirtualMachineDetailedStatusAvailable),
		// 				DetailedStatusMessage: to.Ptr("VM is up and healthy"),
		// 				MemorySizeGB: to.Ptr[int64](8),
		// 				NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
		// 					{
		// 						AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 						DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayTrue),
		// 						IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 						IPv4Address: to.Ptr("198.51.100.1"),
		// 						IPv6Address: to.Ptr("2001:0db8:0000:0000:0000:0000:0000:0000"),
		// 						MacAddress: to.Ptr("bf:1c:29:31:31:1f"),
		// 						NetworkAttachmentName: to.Ptr("netAttachName01"),
		// 				}},
		// 				NetworkData: to.Ptr("bmV0d29ya0RhdGVTYW1wbGU="),
		// 				PlacementHints: []*armnetworkcloud.VirtualMachinePlacementHint{
		// 					{
		// 						HintType: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintTypeAffinity),
		// 						ResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName"),
		// 						SchedulingExecution: to.Ptr(armnetworkcloud.VirtualMachineSchedulingExecutionHard),
		// 						Scope: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintPodAffinityScope("")),
		// 				}},
		// 				PowerState: to.Ptr(armnetworkcloud.VirtualMachinePowerStateOn),
		// 				ProvisioningState: to.Ptr(armnetworkcloud.VirtualMachineProvisioningStateSucceeded),
		// 				SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 					{
		// 						KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 				}},
		// 				StorageProfile: &armnetworkcloud.StorageProfile{
		// 					OSDisk: &armnetworkcloud.OsDisk{
		// 						CreateOption: to.Ptr(armnetworkcloud.OsDiskCreateOptionEphemeral),
		// 						DeleteOption: to.Ptr(armnetworkcloud.OsDiskDeleteOptionDelete),
		// 						DiskSizeGB: to.Ptr[int64](120),
		// 					},
		// 					VolumeAttachments: []*string{
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
		// 					},
		// 					UserData: to.Ptr("dXNlckRhdGVTYW1wbGU="),
		// 					VMDeviceModel: to.Ptr(armnetworkcloud.VirtualMachineDeviceModelTypeT2),
		// 					VMImage: to.Ptr("myacr.azurecr.io/foobar:latest"),
		// 					VMImageRepositoryCredentials: &armnetworkcloud.ImageRepositoryCredentials{
		// 						RegistryURL: to.Ptr("myacr.azurecr.io"),
		// 						Username: to.Ptr("myuser"),
		// 					},
		// 					Volumes: []*string{
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a list of virtual machines in the provided subscription.
 *
 * @summary Get a list of virtual machines in the provided subscription.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json
 */
async function listVirtualMachinesForSubscription() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.virtualMachines.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.NetworkCloud;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json
// this example is just showing the usage of "VirtualMachines_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (NetworkCloudVirtualMachineResource item in subscriptionResource.GetNetworkCloudVirtualMachinesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkCloudVirtualMachineData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
      "name": "virtualMachineName",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/virtualMachines",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "vmImage": "myacr.azurecr.io/foobar:latest",
        "vmImageRepositoryCredentials": {
          "username": "myuser",
          "registryUrl": "myacr.azurecr.io"
        },
        "vmDeviceModel": "T2",
        "cpuCores": 2,
        "memorySizeGB": 8,
        "storageProfile": {
          "osDisk": {
            "createOption": "Ephemeral",
            "deleteOption": "Delete",
            "diskSizeGB": 120
          },
          "volumeAttachments": [
            "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
          ]
        },
        "cloudServicesNetworkAttachment": {
          "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
          "ipAllocationMethod": "Dynamic"
        },
        "networkAttachments": [
          {
            "networkAttachmentName": "netAttachName01",
            "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
            "ipAllocationMethod": "Dynamic",
            "ipv4Address": "198.51.100.1",
            "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
            "macAddress": "bf:1c:29:31:31:1f",
            "defaultGateway": "True"
          }
        ],
        "placementHints": [
          {
            "hintType": "Affinity",
            "schedulingExecution": "Hard",
            "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
            "scope": ""
          }
        ],
        "userData": "dXNlckRhdGVTYW1wbGU=",
        "networkData": "bmV0d29ya0RhdGVTYW1wbGU=",
        "bootMethod": "UEFI",
        "adminUsername": "username",
        "sshPublicKeys": [
          {
            "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
          }
        ],
        "provisioningState": "Succeeded",
        "availabilityZone": "1",
        "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
        "powerState": "On",
        "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
        "detailedStatus": "Available",
        "detailedStatusMessage": "VM is up and healthy",
        "volumes": [
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
        ]
      }
    }
  ],
  "nextLink": "https://fully.qualified.hyperlink"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created.
ImageRepositoryCredentials	ImageRepositoryCredentials represents the credentials used to login to the image repository.
NetworkAttachment	NetworkAttachment represents the single network attachment.
OsDisk	OsDisk represents configuration of the boot disk.
OsDiskCreateOption	The strategy for creating the OS disk.
OsDiskDeleteOption	The strategy for deleting the OS disk.
SshPublicKey	SshPublicKey represents the public key used to authenticate with a resource through SSH.
StorageProfile	StorageProfile represents information about a disk.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualMachine	VirtualMachine represents the on-premises Network Cloud virtual machine.
VirtualMachineBootMethod	Selects the boot method for the virtual machine.
VirtualMachineDetailedStatus	The more detailed status of the virtual machine.
VirtualMachineDeviceModelType	The type of the device model to use.
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.
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.
VirtualMachineList	VirtualMachineList represents a list of virtual machines.
VirtualMachinePlacementHint	VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.
VirtualMachinePlacementHintPodAffinityScope	The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
VirtualMachinePlacementHintType	The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
VirtualMachinePowerState	The power state of the virtual machine.
VirtualMachineProvisioningState	The provisioning state of the virtual machine.
VirtualMachineSchedulingExecution	The indicator of whether the hint is a hard or soft requirement during scheduling.
VirtualMachineVirtioInterfaceType	Field Deprecated, use virtualizationModel instead. The type of the virtio interface.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DefaultGateway

Enumeration

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
False

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Object

ExtendedLocation represents the Azure custom location where the resource will be created.

Name	Type	Description
name	string	The resource ID of the extended location on which the resource will be created.
type	string	The extended location type, for example, CustomLocation.

ImageRepositoryCredentials

Object

ImageRepositoryCredentials represents the credentials used to login to the image repository.

Name	Type	Description
password	string 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.

NetworkAttachment

Object

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

Object

OsDisk represents configuration of the boot disk.

Name	Type	Default value	Description
createOption	OsDiskCreateOption	Ephemeral	The strategy for creating the OS disk.
deleteOption	OsDiskDeleteOption	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

Enumeration

The strategy for creating the OS disk.

Value	Description
Ephemeral

OsDiskDeleteOption

Enumeration

The strategy for deleting the OS disk.

Value	Description
Delete

SshPublicKey

Object

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

Object

StorageProfile represents information about a disk.

Name	Type	Description
osDisk	OsDisk	OsDisk represents configuration of the boot disk. 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

Object

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	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	createdByType	The type of identity that last modified the resource.

VirtualMachine

Object

VirtualMachine represents the on-premises Network Cloud virtual machine.

Name	Type	Default value	Description
extendedLocation	ExtendedLocation		ExtendedLocation represents the Azure custom location where the resource will be created. The extended location of the cluster associated with the resource.
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.adminUsername	string minLength: 1 maxLength: 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	VirtualMachineBootMethod	UEFI	Selects the boot method for the virtual machine.
properties.cloudServicesNetworkAttachment	NetworkAttachment		NetworkAttachment represents the single network attachment. 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.cpuCores	integer (int64) minimum: 2		The number of CPU cores in the virtual machine.
properties.detailedStatus	VirtualMachineDetailedStatus		The more detailed status of the virtual machine.
properties.detailedStatusMessage	string		The descriptive message about the current detailed status.
properties.isolateEmulatorThread	VirtualMachineIsolateEmulatorThread	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	NetworkAttachment[]		The list of network attachments to the virtual machine.
properties.networkData	string		The Base64 encoded cloud-init network data.
properties.placementHints	VirtualMachinePlacementHint[]		The scheduling hints for the virtual machine.
properties.powerState	VirtualMachinePowerState		The power state of the virtual machine.
properties.provisioningState	VirtualMachineProvisioningState		The provisioning state of the virtual machine.
properties.sshPublicKeys	SshPublicKey[]		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	StorageProfile		StorageProfile represents information about a disk. The storage profile that specifies size and other parameters about the disks related to the virtual machine.
properties.userData	string		The Base64 encoded cloud-init user data.
properties.virtioInterface	VirtualMachineVirtioInterfaceType	Modern	Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
properties.vmDeviceModel	VirtualMachineDeviceModelType	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	ImageRepositoryCredentials		ImageRepositoryCredentials represents the credentials used to login to the image repository. 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	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

Enumeration

Selects the boot method for the virtual machine.

Value	Description
UEFI
BIOS

VirtualMachineDetailedStatus

Enumeration

The more detailed status of the virtual machine.

Value	Description
Available
Error
Provisioning
Running
Scheduling
Stopped
Terminating
Unknown

VirtualMachineDeviceModelType

Enumeration

The type of the device model to use.

Value	Description
T1
T2

VirtualMachineIPAllocationMethod

Enumeration

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
Static
Disabled

VirtualMachineIsolateEmulatorThread

Enumeration

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
True
False

VirtualMachineList

Object

VirtualMachineList represents a list of virtual machines.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	VirtualMachine[]	The list of virtual machines.

VirtualMachinePlacementHint

Object

VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.

Name	Type	Description
hintType	VirtualMachinePlacementHintType	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	VirtualMachineSchedulingExecution	The indicator of whether the hint is a hard or soft requirement during scheduling.
scope	VirtualMachinePlacementHintPodAffinityScope	The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.

VirtualMachinePlacementHintPodAffinityScope

Enumeration

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
Rack
Machine

VirtualMachinePlacementHintType

Enumeration

The specification of whether this hint supports affinity or anti-affinity with the referenced resources.

Value	Description
Affinity
AntiAffinity

VirtualMachinePowerState

Enumeration

The power state of the virtual machine.

Value	Description
On
Off
Unknown

VirtualMachineProvisioningState

Enumeration

The provisioning state of the virtual machine.

Value	Description
Succeeded
Failed
Canceled
Provisioning
Accepted

VirtualMachineSchedulingExecution

Enumeration

The indicator of whether the hint is a hard or soft requirement during scheduling.

Value	Description
Hard
Soft

VirtualMachineVirtioInterfaceType

Enumeration

Field Deprecated, use virtualizationModel instead. The type of the virtio interface.

Value	Description
Modern
Transitional