--- title: "Implements GET virtualMachines in a subscription." method: GET path: "/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines" tags: ["VirtualMachines"] --- # Implements GET virtualMachines in a subscription. `GET /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines` List of virtualMachines in a subscription. ## Path parameters - `subscriptionId` string, required ## Query parameters - `api-version` string, required ## Response `200` Success - VirtualMachinesList — List of VirtualMachines. - `nextLink` string — Url to follow for getting next page of VirtualMachines. - `value` VirtualMachine[], required — Array of VirtualMachines - `properties` VirtualMachineProperties, required — Defines the resource properties. - `resourcePoolId` string — Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy. - `templateId` string — Gets or sets the ARM Id of the template resource to deploy the virtual machine. - `vCenterId` string — Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. - `placementProfile` PlacementProfile — Defines the resource properties. - `resourcePoolId` string — Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy. - `clusterId` string — Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy. - `hostId` string — Gets or sets the ARM Id of the host resource on which this virtual machine will deploy. - `datastoreId` string — Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept. - `osProfile` OsProfile — Defines the resource properties. - `computerName` string — Gets or sets computer name. - `adminUsername` string — Gets or sets administrator username. - `adminPassword` string — Gets or sets administrator password. - `osType` 'Windows' | 'Linux' | 'Other' — Defines the different types of VM guest operating systems. - `osName` string — Gets or sets os name. - `toolsRunningStatus` string — Gets or sets the current running status of VMware Tools running in the guest operating system. - `toolsVersionStatus` string — Gets or sets the current version status of VMware Tools installed in the guest operating system. - `toolsVersion` string — Gets or sets the current version of VMware Tools. - `hardwareProfile` HardwareProfile — Defines the resource properties. - `memorySizeMB` integer — Gets or sets memory size in MBs for the vm. - `numCPUs` integer — Gets or sets the number of vCPUs for the vm. - `numCoresPerSocket` integer — Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified. - `cpuHotAddEnabled` boolean — Gets or sets a value indicating whether virtual processors can be added while this virtual machine is running. - `cpuHotRemoveEnabled` boolean — Gets or sets a value indicating whether virtual processors can be removed while this virtual machine is running. - `memoryHotAddEnabled` boolean — Gets or sets a value indicating whether memory can be added while this virtual machine is running. - `networkProfile` NetworkProfile — Defines the resource properties. - `networkInterfaces` NetworkInterface[] — Gets or sets the list of network interfaces associated with the virtual machine. - `name` string — Gets or sets the name of the network interface. - `label` string — Gets or sets the label of the virtual network in vCenter that the nic is connected to. - `ipAddresses` string[] — Gets or sets the nic ip addresses. - `macAddress` string — Gets or sets the NIC MAC address. - `networkId` string — Gets or sets the ARM Id of the network resource to connect the virtual machine. - `nicType` 'vmxnet3' | 'vmxnet2' | 'vmxnet' | 'e1000' | 'e1000e' | 'pcnet32' — NIC type - `powerOnBoot` 'enabled' | 'disabled' — Defines the options for power on boot. - `networkMoRefId` string — Gets or sets the vCenter MoRef (Managed Object Reference) ID of the virtual network that the nic is connected to. - `networkMoName` string — Gets or sets the name of the virtual network in vCenter that the nic is connected to. - `deviceKey` integer — Gets or sets the device key value. - `ipSettings` NicIPSettings — Defines the network interface ip settings. - `allocationMethod` 'unset' | 'dynamic' | 'static' | 'linklayer' | 'random' | 'other' — IP address allocation method. - `dnsServers` string[] — Gets or sets the dns servers. - `gateway` string[] — Gets or sets the gateway. - `ipAddress` string — Gets or sets the ip address for the nic. - `subnetMask` string — Gets or sets the mask. - `primaryWinsServer` string — Gets or sets the primary server. - `secondaryWinsServer` string — Gets or sets the secondary server. - `ipAddressInfo` NicIPAddressSettings[] — Gets or sets the IP address information being reported for this NIC. This contains the same IPv4 information above plus IPV6 information. - … - `storageProfile` StorageProfile — Defines the resource properties. - `disks` VirtualDisk[] — Gets or sets the list of virtual disks associated with the virtual machine. - `name` string — Gets or sets the name of the virtual disk. - `label` string — Gets or sets the label of the virtual disk in vCenter. - `diskObjectId` string — Gets or sets the disk object id. - `diskSizeGB` integer — Gets or sets the disk total size. - `deviceKey` integer — Gets or sets the device key value. - `diskMode` 'persistent' | 'independent_persistent' | 'independent_nonpersistent' — Defines the different types of disk modes. - `controllerKey` integer — Gets or sets the controller id. - `unitNumber` integer — Gets or sets the unit number of the disk on the controller. - `deviceName` string — Gets or sets the device name. - `diskType` 'flat' | 'pmem' | 'rawphysical' | 'rawvirtual' | 'sparse' | 'sesparse' | 'unknown' — Defines the different types of disks. - `scsiControllers` VirtualSCSIController[] — Gets or sets the list of virtual SCSI controllers associated with the virtual machine. - `type` 'lsilogic' | 'buslogic' | 'pvscsi' | 'lsilogicsas' — Defines the different types of SCSI controllers. - `controllerKey` integer — Gets or sets the key of the controller. - `busNumber` integer — Gets or sets the bus number of the controller. - `scsiCtlrUnitNumber` integer — Gets or sets the SCSI controller unit number. - `sharing` 'noSharing' | 'physicalSharing' | 'virtualSharing' — Defines the sharing mode for sharing the SCSI bus. - `guestAgentProfile` GuestAgentProfile — Defines the resource properties. - `vmUuid` string — Specifies the VM's unique SMBIOS ID. - `status` 'Connected' | 'Disconnected' | 'Error' — The status of the hybrid machine agent. - `lastStatusChange` string, date-time — The time of the last status change. - `agentVersion` string — The hybrid machine agent full version. - `errorDetails` ErrorDetail[] — Details about the error state. - `code` string, required — The error's code. - `message` string, required — A human readable error message. - `target` string — Indicates which property in the request is responsible for the error. - `details` ErrorDetail[] — Additional error details. - `moRefId` string — Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine. - `inventoryItemId` string — Gets or sets the inventory Item ID for the virtual machine. - `moName` string — Gets or sets the vCenter Managed Object name for the virtual machine. - `folderPath` string — Gets or sets the folder path of the vm. - `instanceUuid` string — Gets or sets the instance uuid of the vm. - `smbiosUuid` string — Gets or sets the SMBIOS UUID of the vm. - `firmwareType` 'bios' | 'efi' — Firmware type - `powerState` string — Gets the power state of the virtual machine. - `customResourceName` string — Gets the name of the corresponding resource in Kubernetes. - `uuid` string — Gets or sets a unique identifier for this resource. - `statuses` ResourceStatus[] — The resource status information. - `type` string — The type of the condition. - `status` string — Status of the condition. - `reason` string — The reason for the condition's status. - `message` string — A human readable message indicating details about the status. - `severity` string — Severity with which to treat failures of this type of condition. - `lastUpdatedAt` string, date-time — The last update time for this condition. - `provisioningState` string — Gets or sets the provisioning state. - `vmId` string — Gets or sets a unique identifier for the vm resource. - `location` string, required — Gets or sets the location. - `extendedLocation` ExtendedLocation — The extended location. - `type` string — The extended location type. - `name` string — The extended location name. - `systemData` SystemData — unresolved $ref - `tags` object — Gets or sets the Resource tags. - `name` string — Gets or sets the name. - `id` string — Gets or sets the Id. - `type` string — Gets or sets the type of the resource. - `kind` string — Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. - `identity` Identity — Managed service identity. - `principalId` string — The principal id of managed service identity. - `tenantId` string — The tenant of managed service identity. - `type` 'None' | 'SystemAssigned', required — The type of managed service identity. ## Other responses - `default` — Error response describing why the operation failed. ## Changes - **2021-10-01** (2020-10-01-preview) `3bc66cfa77bc` — 1 info - endpoint added [Change history](https://skmtc.dev/azure/apis/connectedvmware-microsoft-connectedvmwarevsphere/changes/subscriptions/:subscriptionId/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/get.md) --- [API](https://skmtc.dev/azure/apis/connectedvmware-microsoft-connectedvmwarevsphere.md) · [All operations](https://skmtc.dev/azure/apis/connectedvmware-microsoft-connectedvmwarevsphere/llms.txt) · [OpenAPI document](https://skmtc.dev/azure/apis/connectedvmware-microsoft-connectedvmwarevsphere/revisions/3bc66cfa77bc?raw)