IVirtualMachine Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.VirtualMachineTypeConverter))]
public interface IVirtualMachine : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api40.ITrackedResource[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.VirtualMachineTypeConverter))>]
type IVirtualMachine = interface
interface IJsonSerializable
interface ITrackedResource
interface IResourcePublic Interface IVirtualMachine
Implements ITrackedResource- Derived
- Attributes
- Implements
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 the virtual machine has landed to. |
| BootMethod |
Selects the boot method for the virtual machine. |
| CloudServiceNetworkAttachmentAttachedNetworkId |
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. |
| CloudServiceNetworkAttachmentDefaultGateway |
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. |
| CloudServiceNetworkAttachmentIPAllocationMethod |
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. |
| CloudServiceNetworkAttachmentIpv4Address |
The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. |
| CloudServiceNetworkAttachmentIpv6Address |
The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. |
| CloudServiceNetworkAttachmentMacAddress |
The MAC address of the interface for the virtual machine that corresponds to this network attachment. |
| CloudServiceNetworkAttachmentName |
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. |
| ClusterId |
The resource ID of the cluster the virtual machine is created for. |
| CpuCore |
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. |
| ExtendedLocationName |
The resource ID of the extended location on which the resource will be created. |
| ExtendedLocationType |
The extended location type, for example, CustomLocation. |
| Id |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from IResource) |
| 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. |
| Location |
The geo-location where the resource lives (Inherited from ITrackedResource) |
| MemorySizeGb |
The memory size of the virtual machine in GB. |
| Name |
The name of the resource (Inherited from IResource) |
| NetworkAttachment |
The list of network attachments to the virtual machine. |
| NetworkData |
The Base64 encoded cloud-init network data. |
| OSDiskCreateOption |
The strategy for creating the OS disk. |
| OSDiskDeleteOption |
The strategy for deleting the OS disk. |
| OSDiskSizeGb |
The size of the disk in gigabytes. Required if the createOption is Ephemeral. |
| PlacementHint |
The scheduling hints for the virtual machine. |
| PowerState |
The power state of the virtual machine. |
| ProvisioningState |
The provisioning state of the virtual machine. |
| SshPublicKey |
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. |
| StorageProfileVolumeAttachment |
The resource IDs of volumes that are requested to be attached to the virtual machine. |
| SystemDataCreatedAt |
The timestamp of resource creation (UTC). (Inherited from IResource) |
| SystemDataCreatedBy |
The identity that created the resource. (Inherited from IResource) |
| SystemDataCreatedByType |
The type of identity that created the resource. (Inherited from IResource) |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) (Inherited from IResource) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. (Inherited from IResource) |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. (Inherited from IResource) |
| Tag |
Resource tags. (Inherited from ITrackedResource) |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
| 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. |
| VMImageRepositoryCredentialsPassword |
The password or token used to access an image in the target repository. |
| VMImageRepositoryCredentialsRegistryUrl |
The URL of the authentication server used to validate the repository credentials. |
| VMImageRepositoryCredentialsUsername |
The username used to access an image in the target repository. |
| Volume |
The resource IDs of volumes that are attached to the virtual machine. |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |