Virtual Machine Instances - Get

Reference

Service:: Azure Arc enabled SCVMM

API Version:: 2024-06-01

Gets a virtual machine.
Retrieves information about a virtual machine instance.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

URI Parameters

Name	In	Required	Type	Description
resourceUri	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VirtualMachineInstance	Azure operation completed successfully.
Other Status Codes	ErrorResponse	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

VirtualMachineInstances_Get_MaximumSet

VirtualMachineInstances_Get_MinimumSet

VirtualMachineInstances_Get_MaximumSet

Sample request

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

Sample response

Status code:: 200

{
  "properties": {
    "availabilitySets": [
      {
        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName",
        "name": "lwbhaseo"
      }
    ],
    "osProfile": {
      "computerName": "uuxpcxuxcufllc",
      "osType": "Windows",
      "osSku": "cxqnjxgkts",
      "osVersion": "djt",
      "domainName": "vblzsoqxzlrygdulnefexjdezo",
      "domainUsername": "sn",
      "workgroup": "bsqftibgcnnjpvmuxligk",
      "timezone": 4,
      "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty"
    },
    "hardwareProfile": {
      "memoryMB": 5,
      "cpuCount": 22,
      "limitCpuForMigration": "true",
      "dynamicMemoryEnabled": "true",
      "dynamicMemoryMaxMB": 2,
      "dynamicMemoryMinMB": 30,
      "isHighlyAvailable": "true"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "name": "kvofzqulbjlbtt",
          "displayName": "yoayfd",
          "ipv4Addresses": [
            "eeunirpkpqazzxhsqonkxcfuks"
          ],
          "ipv6Addresses": [
            "pk"
          ],
          "macAddress": "oaeqqegt",
          "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName",
          "networkName": "lqbm",
          "ipv4AddressType": "Dynamic",
          "ipv6AddressType": "Dynamic",
          "macAddressType": "Dynamic",
          "nicId": "roxpsvlo"
        }
      ]
    },
    "storageProfile": {
      "disks": [
        {
          "name": "fgnckfymwdsqnfxkdvexuaobe",
          "displayName": "fgladknawlgjodo",
          "diskId": "ltdrwcfjklpsimhzqyh",
          "diskSizeGB": 30,
          "maxDiskSizeGB": 18,
          "bus": 8,
          "lun": 10,
          "busType": "zu",
          "vhdType": "cnbeeeylrvopigdynvgpkfp",
          "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln",
          "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb",
          "templateDiskId": "lcdwrokpyvekqccclf",
          "storageQoSPolicy": {
            "name": "ceiyfrflu",
            "id": "o"
          },
          "createDiffDisk": "true"
        }
      ]
    },
    "infrastructureProfile": {
      "inventoryItemId": "ihkkqmg",
      "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
      "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName",
      "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
      "vmName": "qovpayfydhcvfrhe",
      "uuid": "hrpw",
      "lastRestoredVMCheckpoint": {
        "parentCheckpointID": "hqhhzikoxunuqguouw",
        "checkpointID": "wsqmrje",
        "name": "keqn",
        "description": "qurzfrgyflrh"
      },
      "checkpoints": [
        {
          "parentCheckpointID": "hqhhzikoxunuqguouw",
          "checkpointID": "wsqmrje",
          "name": "keqn",
          "description": "qurzfrgyflrh"
        }
      ],
      "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz",
      "generation": 28,
      "biosGuid": "xixivxifyql"
    },
    "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default",
  "name": "uuqpsdoiyvedvqtrwop",
  "type": "zculorteltpvthtzgnpgdpoe",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

VirtualMachineInstances_Get_MinimumSet

Sample request

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default",
  "extendedLocation": {}
}

Definitions

Name	Description
AllocationMethod	Network address allocation method.
AvailabilitySetListItem	Availability Set model
Checkpoint	Defines the resource properties.
createdByType	The type of identity that created the resource.
CreateDiffDisk	Create diff disk.
DynamicMemoryEnabled	Dynamic memory enabled.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	The extended location.
HardwareProfile	Defines the resource properties.
InfrastructureProfile	Specifies the vmmServer infrastructure specific settings for the virtual machine instance.
IsHighlyAvailable	Highly available.
LimitCpuForMigration	Limit CPU for migration.
NetworkInterface	Network Interface model
NetworkProfile	Defines the resource properties.
OsProfileForVmInstance	Defines the resource properties.
OsType	Virtual machine operating system type.
ProvisioningState	The provisioning state of the resource.
StorageProfile	Defines the resource properties.
StorageQosPolicyDetails	The StorageQoSPolicyDetails definition.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualDisk	Virtual disk model
VirtualMachineInstance	Define the virtualMachineInstance.

AllocationMethod

Enumeration

Network address allocation method.

Value	Description
Dynamic	Dynamically allocated address.
Static	Statically allocated address.

AvailabilitySetListItem

Object

Availability Set model

Name	Type	Description
id	string (arm-id)	Gets the ARM Id of the microsoft.scvmm/availabilitySets resource.
name	string	Gets or sets the name of the availability set.

Checkpoint

Object

Defines the resource properties.

Name	Type	Description
checkpointID	string	Gets ID of the checkpoint.
description	string	Gets description of the checkpoint.
name	string	Gets name of the checkpoint.
parentCheckpointID	string	Gets ID of parent of the checkpoint.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

CreateDiffDisk

Enumeration

Create diff disk.

Value	Description
false	Disable create diff disk.
true	Enable create diff disk.

DynamicMemoryEnabled

Enumeration

Dynamic memory enabled.

Value	Description
false	Disable dynamic memory.
true	Enable dynamic memory.

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

The extended location.

Name	Type	Description
name	string (arm-id)	The extended location name.
type	string	The extended location type.

HardwareProfile

Object

Defines the resource properties.

Name	Type	Description
cpuCount	integer (int32)	Gets or sets the number of vCPUs for the vm.
dynamicMemoryEnabled	DynamicMemoryEnabled	Gets or sets a value indicating whether to enable dynamic memory or not.
dynamicMemoryMaxMB	integer (int32)	Gets or sets the max dynamic memory for the vm.
dynamicMemoryMinMB	integer (int32)	Gets or sets the min dynamic memory for the vm.
isHighlyAvailable	IsHighlyAvailable	Gets highly available property.
limitCpuForMigration	LimitCpuForMigration	Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs.
memoryMB	integer (int32)	MemoryMB is the size of a virtual machine's memory, in MB.

InfrastructureProfile

Object

Specifies the vmmServer infrastructure specific settings for the virtual machine instance.

Name	Type	Description
biosGuid	string	Gets or sets the bios guid for the vm.
checkpointType	string	Type of checkpoint supported for the vm.
checkpoints	Checkpoint[]	Checkpoints in the vm.
cloudId	string (arm-id)	ARM Id of the cloud resource to use for deploying the vm.
generation	integer (int32)	Gets or sets the generation for the vm.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
lastRestoredVMCheckpoint	Checkpoint	Last restored checkpoint in the vm.
templateId	string (arm-id)	ARM Id of the template resource to use for deploying the vm.
uuid	string	Unique ID of the virtual machine.
vmName	string minLength: 1	VMName is the name of VM on the SCVmm server.
vmmServerId	string (arm-id)	ARM Id of the vmmServer resource in which this resource resides.

IsHighlyAvailable

Enumeration

Highly available.

Value	Description
false	Disable highly available.
true	Enable highly available.

LimitCpuForMigration

Enumeration

Limit CPU for migration.

Value	Description
false	Disable limit CPU for migration.
true	Enable limit CPU for migration.

NetworkInterface

Object

Network Interface model

Name	Type	Description
displayName	string	Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set.
ipv4AddressType	AllocationMethod	Gets or sets the ipv4 address type.
ipv4Addresses	string[]	Gets the nic ipv4 addresses.
ipv6AddressType	AllocationMethod	Gets or sets the ipv6 address type.
ipv6Addresses	string[]	Gets the nic ipv6 addresses.
macAddress	string	Gets or sets the nic MAC address.
macAddressType	AllocationMethod	Gets or sets the mac address type.
name	string	Gets or sets the name of the network interface.
networkName	string	Gets the name of the virtual network in vmmServer that the nic is connected to.
nicId	string	Gets or sets the nic id.
virtualNetworkId	string (arm-id)	Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.

NetworkProfile

Object

Defines the resource properties.

Name	Type	Description
networkInterfaces	NetworkInterface[]	Gets or sets the list of network interfaces associated with the virtual machine.

OsProfileForVmInstance

Object

Defines the resource properties.

Name	Type	Description
adminPassword	string (password)	Admin password of the virtual machine.
computerName	string	Gets or sets computer name.
domainName	string	Gets or sets the domain name.
domainPassword	string (password)	Password of the domain the VM has to join.
domainUsername	string	Gets or sets the domain username.
osSku	string	Gets os sku.
osType	OsType	Gets the type of the os.
osVersion	string	Gets os version.
productKey	string (password)	Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
runOnceCommands	string	Get or sets the commands to be run once at the time of creation separated by semicolons.
timezone	integer (int32)	Gets or sets the index value of the timezone.
workgroup	string	Gets or sets the workgroup.

OsType

Enumeration

Virtual machine operating system type.

Value	Description
Linux	Linux operating system.
Other	Other operating system.
Windows	Windows operating system.

ProvisioningState

Enumeration

The provisioning state of the resource.

Value	Description
Accepted	The resource has been accepted.
Canceled	Resource creation was canceled.
Created	The resource was created.
Deleting	The resource is being deleted.
Failed	Resource creation failed.
Provisioning	The resource is provisioning.
Succeeded	Resource has been created.
Updating	The resource is updating.

StorageProfile

Object

Defines the resource properties.

Name	Type	Description
disks	VirtualDisk[]	Gets or sets the list of virtual disks associated with the virtual machine.

StorageQosPolicyDetails

Object

The StorageQoSPolicyDetails definition.

Name	Type	Description
id	string	The ID of the QoS policy.
name	string	The name of the policy.

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.

VirtualDisk

Object

Virtual disk model

Name	Type	Description
bus	integer (int32)	Gets or sets the disk bus.
busType	string	Gets or sets the disk bus type.
createDiffDisk	CreateDiffDisk	Gets or sets a value indicating diff disk.
diskId	string	Gets or sets the disk id.
diskSizeGB	integer (int32)	Gets or sets the disk total size.
displayName	string	Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set.
lun	integer (int32)	Gets or sets the disk lun.
maxDiskSizeGB	integer (int32)	Gets the max disk size.
name	string	Gets or sets the name of the disk.
storageQoSPolicy	StorageQosPolicyDetails	The QoS policy for the disk.
templateDiskId	string	Gets or sets the disk id in the template.
vhdFormatType	string	Gets the disk vhd format type.
vhdType	string	Gets or sets the disk vhd type.
volumeType	string	Gets the disk volume type.

VirtualMachineInstance

Object

Define the virtualMachineInstance.

Name	Type	Description
extendedLocation	ExtendedLocation	Gets or sets the extended location.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.availabilitySets	AvailabilitySetListItem[]	Availability Sets in vm.
properties.hardwareProfile	HardwareProfile	Hardware properties.
properties.infrastructureProfile	InfrastructureProfile	Gets the infrastructure profile.
properties.networkProfile	NetworkProfile	Network properties.
properties.osProfile	OsProfileForVmInstance	OS properties.
properties.powerState	string	Gets the power state of the virtual machine.
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
properties.storageProfile	StorageProfile	Storage properties.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Share via

Virtual Machine Instances - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

VirtualMachineInstances_Get_MaximumSet

Sample request

Sample response

VirtualMachineInstances_Get_MinimumSet

Sample request

Sample response

Definitions

AllocationMethod

AvailabilitySetListItem

Checkpoint

createdByType

CreateDiffDisk

DynamicMemoryEnabled

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

HardwareProfile

InfrastructureProfile

IsHighlyAvailable

LimitCpuForMigration

NetworkInterface

NetworkProfile

OsProfileForVmInstance

OsType

ProvisioningState

StorageProfile

StorageQosPolicyDetails

systemData

VirtualDisk

VirtualMachineInstance

Additional resources