Share via


VirtualMachine interface

Define the virtualMachine.

Properties

customResourceName

Gets the name of the corresponding resource in Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.

extendedLocation

Gets or sets the extended location.

firmwareType

Firmware type

folderPath

Gets or sets the folder path of the vm. NOTE: This property will not be serialized. It can only be populated by the server.

guestAgentProfile

Guest agent status properties.

hardwareProfile

Hardware properties.

id

Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.

identity

The identity of the resource.

instanceUuid

Gets or sets the instance uuid of the vm. NOTE: This property will not be serialized. It can only be populated by the server.

inventoryItemId

Gets or sets the inventory Item ID for the virtual machine.

kind

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.

location

Gets or sets the location.

moName

Gets or sets the vCenter Managed Object name for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

moRefId

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.

name

Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.

networkProfile

Network properties.

osProfile

OS properties.

placementProfile

Placement properties.

powerState

Gets the power state of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState

Gets or sets the provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

resourcePoolId

Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.

securityProfile

Gets the security profile.

smbiosUuid

Gets or sets the SMBIOS UUID of the vm.

statuses

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

storageProfile

Storage properties.

systemData

The system data. NOTE: This property will not be serialized. It can only be populated by the server.

tags

Gets or sets the Resource tags.

templateId

Gets or sets the ARM Id of the template resource to deploy the virtual machine.

type

Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

uuid

Gets or sets a unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.

vCenterId

Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.

vmId

Gets or sets a unique identifier for the vm resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

customResourceName

Gets the name of the corresponding resource in Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.

customResourceName?: string

Property Value

string

extendedLocation

Gets or sets the extended location.

extendedLocation?: ExtendedLocation

Property Value

firmwareType

Firmware type

firmwareType?: string

Property Value

string

folderPath

Gets or sets the folder path of the vm. NOTE: This property will not be serialized. It can only be populated by the server.

folderPath?: string

Property Value

string

guestAgentProfile

Guest agent status properties.

guestAgentProfile?: GuestAgentProfile

Property Value

hardwareProfile

Hardware properties.

hardwareProfile?: HardwareProfile

Property Value

id

Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

identity

The identity of the resource.

identity?: Identity

Property Value

instanceUuid

Gets or sets the instance uuid of the vm. NOTE: This property will not be serialized. It can only be populated by the server.

instanceUuid?: string

Property Value

string

inventoryItemId

Gets or sets the inventory Item ID for the virtual machine.

inventoryItemId?: string

Property Value

string

kind

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.

kind?: string

Property Value

string

location

Gets or sets the location.

location: string

Property Value

string

moName

Gets or sets the vCenter Managed Object name for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

moName?: string

Property Value

string

moRefId

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.

moRefId?: string

Property Value

string

name

Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

networkProfile

Network properties.

networkProfile?: NetworkProfile

Property Value

osProfile

OS properties.

osProfile?: OsProfile

Property Value

placementProfile

Placement properties.

placementProfile?: PlacementProfile

Property Value

powerState

Gets the power state of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

powerState?: string

Property Value

string

provisioningState

Gets or sets the provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourcePoolId

Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.

resourcePoolId?: string

Property Value

string

securityProfile

Gets the security profile.

securityProfile?: SecurityProfile

Property Value

smbiosUuid

Gets or sets the SMBIOS UUID of the vm.

smbiosUuid?: string

Property Value

string

statuses

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

statuses?: ResourceStatus[]

Property Value

storageProfile

Storage properties.

storageProfile?: StorageProfile

Property Value

systemData

The system data. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

tags

Gets or sets the Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

templateId

Gets or sets the ARM Id of the template resource to deploy the virtual machine.

templateId?: string

Property Value

string

type

Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

uuid

Gets or sets a unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.

uuid?: string

Property Value

string

vCenterId

Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.

vCenterId?: string

Property Value

string

vmId

Gets or sets a unique identifier for the vm resource. NOTE: This property will not be serialized. It can only be populated by the server.

vmId?: string

Property Value

string