VirtualMachineInstance Class

Definition

The virtual machine instance resource definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.VirtualMachineInstanceTypeConverter))]
public class VirtualMachineInstance : Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IVirtualMachineInstance, Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.VirtualMachineInstanceTypeConverter))>]
type VirtualMachineInstance = class
    interface IVirtualMachineInstance
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates
Public Class VirtualMachineInstance
Implements IValidates, IVirtualMachineInstance
Inheritance
VirtualMachineInstance
Attributes
Implements

Constructors

VirtualMachineInstance()

Creates an new VirtualMachineInstance instance.

Properties

DynamicMemoryConfigMaximumMemoryMb
DynamicMemoryConfigMinimumMemoryMb
DynamicMemoryConfigTargetMemoryBuffer

Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.

ExtendedLocationName

The name of the extended location.

ExtendedLocationType

The type of the extended location.

GuestAgentInstallStatusAgentVersion

The hybrid machine agent full version.

GuestAgentInstallStatusErrorDetail

Details about the error state.

GuestAgentInstallStatusLastStatusChange

The time of the last status change.

GuestAgentInstallStatusVMUuid

Specifies the VM's unique SMBIOS ID.

HardwareProfileMemoryMb

RAM in MB for the virtual machine instance

HardwareProfileProcessor

number of processors for the virtual machine instance

HardwareProfileVMSize
HttpProxyConfigHttpProxy

The HTTP proxy server endpoint to use.

HttpProxyConfigHttpsProxy

The HTTPS proxy server endpoint to use.

HttpProxyConfigNoProxy

The endpoints that should not go through proxy.

HttpProxyConfigTrustedCa

Alternative CA cert to use for connecting to proxy servers.

Id

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

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The identity type.

ImageReferenceId

Resource ID of the image

LinuxConfigurationDisablePasswordAuthentication

DisablePasswordAuthentication - whether password authentication should be disabled

LinuxConfigurationProvisionVMAgent

Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.

LinuxConfigurationProvisionVMConfigAgent

Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.

LinuxConfigurationSshPublicKey

The list of SSH public keys used to authenticate with linux based VMs.

Name

The name of the resource

NetworkProfileNetworkInterface

NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance

OSDiskId

Resource ID of the OS disk

OSDiskOstype

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.

OSProfileAdminPassword

AdminPassword - admin password

OSProfileAdminUsername

AdminUsername - admin username

OSProfileComputerName

ComputerName - name of the compute

PropertiesGuestAgentInstallStatusStatus

The installation status of the hybrid machine agent installation.

ProvisioningState

Provisioning state of the virtual machine instance.

ProvisioningStatus

The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]

ProvisioningStatusOperationId

The ID of the operation performed on the virtual machine instance

ResourceGroupName

Gets the resource group name

ResourceUid

Unique identifier defined by ARC to identify the guest of the VM.

SecurityProfileEnableTpm
SecurityProfileSecurityType

Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.

StatusErrorCode

VirtualMachine provisioning error code

StatusErrorMessage

Descriptive error message

StatusPowerState

The power state of the virtual machine instance

StorageProfileDataDisk

adds data disks to the virtual machine instance

StorageProfileVMConfigStoragePathId

Id of the storage container that hosts the VM configuration file

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

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

UefiSettingSecureBootEnabled

Specifies whether secure boot should be enabled on the virtual machine instance.

VMAgentStatuses

The resource status information.

VMAgentVmconfigAgentVersion

The VM Config Agent full version.

VMId

Unique identifier for the vm resource.

WindowConfigurationEnableAutomaticUpdate

Whether to EnableAutomaticUpdates on the machine

WindowConfigurationProvisionVMAgent

Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.

WindowConfigurationProvisionVMConfigAgent

Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.

WindowConfigurationTimeZone

TimeZone for the virtual machine instance

WindowsConfigurationSshPublicKey

The list of SSH public keys used to authenticate with linux based VMs.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of VirtualMachineInstance.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of VirtualMachineInstance.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IVirtualMachineInstance.

FromJsonString(String)

Creates a new instance of VirtualMachineInstance, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of VirtualMachineInstance into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to