VirtualMachine interface

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

The resource ID of the bare metal machine that hosts the virtual machine.
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.
consoleExtendedLocation

The extended location to use for creation of a VM console resource.
cpuCores

The number of CPU cores in the virtual machine.
detailedStatus

The more detailed status of the virtual machine.
detailedStatusMessage

The descriptive message about the current detailed status.
etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
extendedLocation

The extended location of the resource. This property is required when creating the resource.
identity

The managed service identities assigned to this 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. Allocations are measured in gibibytes.
networkAttachments

The list of network attachments to the virtual machine.
networkData

Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.
networkDataContent

The Base64 encoded cloud-init network data.
placementHints

The scheduling hints for the virtual machine.
powerState

The power state of the virtual machine.
provisioningState

The provisioning state of the virtual machine.
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

Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.
userDataContent

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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

availabilityZone?: string

Property Value

string

bareMetalMachineId

The resource ID of the bare metal machine that hosts the virtual machine.

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.

clusterId?: string

Property Value

string

consoleExtendedLocation

The extended location to use for creation of a VM console resource.

consoleExtendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

cpuCores

The number of CPU cores in the virtual machine.

cpuCores: number

Property Value

number

detailedStatus

The more detailed status of the virtual machine.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status.

detailedStatusMessage?: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: string

Property Value

string

extendedLocation

The extended location of the resource. This property is required when creating the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

identity

The managed service identities assigned to this resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

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. Allocations are measured in gibibytes.

memorySizeGB: number

Property Value

number

networkAttachments

The list of network attachments to the virtual machine.

networkAttachments?: NetworkAttachment[]

Property Value

NetworkAttachment[]

networkData

Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.

networkData?: string

Property Value

string

networkDataContent

The Base64 encoded cloud-init network data.

networkDataContent?: 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.

powerState?: string

Property Value

string

provisioningState

The provisioning state of the virtual machine.

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

Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.

userData?: string

Property Value

string

userDataContent

The Base64 encoded cloud-init user data.

userDataContent?: 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.

volumes?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type