MachineProperties Class

Definition

Describes the properties of a hybrid machine.

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

Constructors

MachineProperties()

Creates an new MachineProperties instance.

Properties

AdFqdn

Specifies the AD fully qualified display name.

AgentConfigurationConfigMode

Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.

AgentConfigurationExtensionsAllowList

Array of extensions that are allowed to be installed or updated.

AgentConfigurationExtensionsBlockList

Array of extensions that are blocked (cannot be installed or updated)

AgentConfigurationExtensionsEnabled

Specifies whether the extension service is enabled or disabled.

AgentConfigurationGuestConfigurationEnabled

Specified whether the guest configuration service is enabled or disabled.

AgentConfigurationIncomingConnectionsPort

Specifies the list of ports that the agent will be able to listen on.

AgentConfigurationProxyBypass

List of service names which should not use the specified proxy server.

AgentConfigurationProxyUrl

Specifies the URL of the proxy to be used.

AgentUpgradeCorrelationId

The correlation ID passed in from RSM per upgrade.

AgentUpgradeDesiredVersion

Specifies the version info w.r.t AgentUpgrade for the machine.

AgentUpgradeEnableAutomaticUpgrade

Specifies if RSM should try to upgrade this machine

AgentUpgradeLastAttemptDesiredVersion

Specifies the version of the last attempt

AgentUpgradeLastAttemptMessage

Failure message of last upgrade attempt if any.

AgentUpgradeLastAttemptStatus

Specifies the status of Agent Upgrade.

AgentUpgradeLastAttemptTimestamp

Timestamp of last upgrade attempt

AgentVersion

The hybrid machine agent full version.

ClientPublicKey

Public Key that the client provides to be used during initial resource onboarding

CloudMetadataProvider

Specifies the cloud provider (Azure/AWS/GCP...).

DetectedProperty

Detected properties from the machine.

DisplayName

Specifies the hybrid machine display name.

DnsFqdn

Specifies the DNS fully qualified display name.

DomainName

Specifies the Windows domain name.

ErrorDetail

Details about the error state.

Extension

Machine Extensions information (deprecated field)

ExtensionServiceStartupType

The behavior of the service when the Arc-enabled machine starts up.

ExtensionServiceStatus

The current status of the service.

GuestConfigurationServiceStartupType

The behavior of the service when the Arc-enabled machine starts up.

GuestConfigurationServiceStatus

The current status of the service.

LastStatusChange

The time of the last status change.

LinuxConfigurationPatchSettingsAssessmentMode

Specifies the assessment mode.

LinuxConfigurationPatchSettingsPatchMode

Specifies the patch mode.

LocationDataCity

The city or locality where the resource is located.

LocationDataCountryOrRegion

The country or region where the resource is located

LocationDataDistrict

The district, state, or province where the resource is located.

LocationDataName

A canonical name for the geographic or physical location.

MachineFqdn

Specifies the hybrid machine FQDN.

MssqlDiscovered

Specifies whether any MS SQL instance is discovered on the machine.

NetworkProfileNetworkInterface

The list of network interfaces.

OSName

The Operating System running on the hybrid machine.

OSProfileComputerName

Specifies the host OS name of the hybrid machine.

OSSku

Specifies the Operating System product SKU.

OSType

The type of Operating System (windows/linux).

OSVersion

The version of Operating System running on the hybrid machine.

ParentClusterResourceId

The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.

PrivateLinkScopeResourceId

The resource id of the private link scope this machine is assigned to, if any.

ProvisioningState

The provisioning state, which only appears in the response.

Status

The status of the hybrid machine agent.

VMId

Specifies the hybrid machine unique ID.

VMUuid

Specifies the Arc Machine's unique SMBIOS ID

WindowsConfigurationPatchSettingsAssessmentMode

Specifies the assessment mode.

WindowsConfigurationPatchSettingsPatchMode

Specifies the patch mode.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of MachineProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of MachineProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of MachineProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to