VirtualMachineInstanceProperties Class

Definition

Properties under the virtual machine instance resource

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.VirtualMachineInstancePropertiesTypeConverter))]
public class VirtualMachineInstanceProperties : Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IVirtualMachineInstanceProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.VirtualMachineInstancePropertiesTypeConverter))>]
type VirtualMachineInstanceProperties = class
    interface IVirtualMachineInstanceProperties
    interface IJsonSerializable
Public Class VirtualMachineInstanceProperties
Implements IVirtualMachineInstanceProperties
Inheritance
VirtualMachineInstanceProperties
Attributes
Implements

Constructors

VirtualMachineInstanceProperties()

Creates an new VirtualMachineInstanceProperties 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.

GuestAgentInstallStatusAgentVersion

The hybrid machine agent full version.

GuestAgentInstallStatusErrorDetail

Details about the error state.

GuestAgentInstallStatusLastStatusChange

The time of the last status change.

GuestAgentInstallStatusStatus

The installation status of the hybrid machine agent installation.

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.

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.

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

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

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

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

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of VirtualMachineInstanceProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of VirtualMachineInstanceProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to