Share via

VirtualMachine interface

  • Reference
Package:
@azure/arm-networkcloud

VirtualMachine represents the on-premises Network Cloud virtual machine.

Extends
TrackedResource

Properties

adminUsername

The name of the administrator to which the ssh public keys will be added into the authorized keys.
availabilityZone

The cluster availability zone containing this virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
bareMetalMachineId

The resource ID of the bare metal machine the virtual machine has landed to. NOTE: This property will not be serialized. It can only be populated by the server.
bootMethod

Selects the boot method for the virtual machine.
cloudServicesNetworkAttachment

The cloud service network that provides platform-level services for the virtual machine.
clusterId

The resource ID of the cluster the virtual machine is created for. NOTE: This property will not be serialized. It can only be populated by the server.
cpuCores

The number of CPU cores in the virtual machine.
detailedStatus

The more detailed status of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

The extended location of the cluster associated with the resource.
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.
memorySizeGB

The memory size of the virtual machine in GB.
networkAttachments

The list of network attachments to the virtual machine.
networkData

The Base64 encoded cloud-init network data.
placementHints

The scheduling hints for the virtual machine.
powerState

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

The provisioning state of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
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.
storageProfile

The storage profile that specifies size and other parameters about the disks related to the virtual machine.
userData

The Base64 encoded cloud-init user data.
virtioInterface

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

The type of the device model to use.
vmImage

The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
vmImageRepositoryCredentials

The credentials used to login to the image repository that has access to the specified image.
volumes

The resource IDs of volumes that are attached to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

adminUsername

The name of the administrator to which the ssh public keys will be added into the authorized keys.

adminUsername: string

Property Value

string

availabilityZone

The cluster availability zone containing this virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

availabilityZone?: string

Property Value

string

bareMetalMachineId

The resource ID of the bare metal machine the virtual machine has landed to. NOTE: This property will not be serialized. It can only be populated by the server.

bareMetalMachineId?: string

Property Value

string

bootMethod

Selects the boot method for the virtual machine.

bootMethod?: string

Property Value

string

cloudServicesNetworkAttachment

The cloud service network that provides platform-level services for the virtual machine.

cloudServicesNetworkAttachment: NetworkAttachment

Property Value

NetworkAttachment

clusterId

The resource ID of the cluster the virtual machine is created for. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

cpuCores

The number of CPU cores in the virtual machine.

cpuCores: number

Property Value

number

detailedStatus

The more detailed status of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

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.

isolateEmulatorThread?: string

Property Value

string

memorySizeGB

The memory size of the virtual machine in GB.

memorySizeGB: number

Property Value

number

networkAttachments

The list of network attachments to the virtual machine.

networkAttachments?: NetworkAttachment[]

Property Value

NetworkAttachment[]

networkData

The Base64 encoded cloud-init network data.

networkData?: string

Property Value

string

placementHints

The scheduling hints for the virtual machine.

placementHints?: VirtualMachinePlacementHint[]

Property Value

VirtualMachinePlacementHint[]

powerState

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

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

provisioningState?: string

Property Value

string

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.

sshPublicKeys?: SshPublicKey[]

Property Value

SshPublicKey[]

storageProfile

The storage profile that specifies size and other parameters about the disks related to the virtual machine.

storageProfile: StorageProfile

Property Value

StorageProfile

userData

The Base64 encoded cloud-init user data.

userData?: string

Property Value

string

virtioInterface

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

virtioInterface?: string

Property Value

string

vmDeviceModel

The type of the device model to use.

vmDeviceModel?: string

Property Value

string

vmImage

The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.

vmImage: string

Property Value

string

vmImageRepositoryCredentials

The credentials used to login to the image repository that has access to the specified image.

vmImageRepositoryCredentials?: ImageRepositoryCredentials

Property Value

ImageRepositoryCredentials

volumes

The resource IDs of volumes that are attached to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

volumes?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type