Machine interface

Package:

@azure/arm-hybridcompute

Describes a hybrid machine.

Extends

TrackedResource

Properties

adFqdn	Specifies the AD fully qualified display name.
agentConfiguration	Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.
agentUpgrade	The info of the machine w.r.t Agent Upgrade
agentVersion	The hybrid machine agent full version.
clientPublicKey	Public Key that the client provides to be used during initial resource onboarding
cloudMetadata	The metadata of the cloud environment (Azure/GCP/AWS/OCI...).
detectedProperties	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.
errorDetails	Details about the error state.
extensions	Machine Extensions information (deprecated field)
firmwareProfile	Information about the machine's firmware
hardwareProfile	Information about the machine's hardware
hardwareResourceId	Specifies the resource ID of the associated hardware device. Only settable by HCI RP.
identity	Identity for the resource.
identityKeyStore	Specifies the identity key store a machine is using.
kind	Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.
lastStatusChange	The time of the last status change.
licenseProfile	Specifies the License related properties for a machine.
locationData	Metadata pertaining to the geographic location of the resource.
machineFqdn	Specifies the hybrid machine FQDN.
mssqlDiscovered	Specifies whether any MS SQL instance is discovered on the machine.
networkProfile	Information about the network the machine is on.
osEdition	The edition of the Operating System.
osName	The Operating System running on the hybrid machine.
osProfile	Specifies the operating system settings for 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.
resources	The list of extensions affiliated to the machine
serviceStatuses	Statuses of dependent services that are reported back to ARM.
status	The status of the hybrid machine agent.
statusReason	Indicates whether the service has detected that this Arc machine is a clone of another onboarded machine. Service-computed; not settable by the user.
storageProfile	Information about the machine's storage
tpmEkCertificate	Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding.
vmId	Specifies the hybrid machine unique ID.
vmUuid	Specifies the Arc Machine's unique SMBIOS ID

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

adFqdn

Specifies the AD fully qualified display name.

adFqdn?: string

Property Value

string

agentConfiguration

Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.

agentConfiguration?: AgentConfiguration

Property Value

AgentConfiguration

agentUpgrade

The info of the machine w.r.t Agent Upgrade

agentUpgrade?: AgentUpgrade

Property Value

AgentUpgrade

agentVersion

The hybrid machine agent full version.

agentVersion?: string

Property Value

string

clientPublicKey

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

clientPublicKey?: string

Property Value

string

cloudMetadata

The metadata of the cloud environment (Azure/GCP/AWS/OCI...).

cloudMetadata?: CloudMetadata

Property Value

CloudMetadata

detectedProperties

Detected properties from the machine.

detectedProperties?: Record<string, string>

Property Value

Record<string, string>

displayName

Specifies the hybrid machine display name.

displayName?: string

Property Value

string

dnsFqdn

Specifies the DNS fully qualified display name.

dnsFqdn?: string

Property Value

string

domainName

Specifies the Windows domain name.

domainName?: string

Property Value

string

errorDetails

Details about the error state.

errorDetails?: ErrorDetail[]

Property Value

ErrorDetail[]

extensions

Machine Extensions information (deprecated field)

extensions?: MachineExtensionInstanceView[]

Property Value

MachineExtensionInstanceView[]

firmwareProfile

Information about the machine's firmware

firmwareProfile?: FirmwareProfile

Property Value

FirmwareProfile

hardwareProfile

Information about the machine's hardware

hardwareProfile?: HardwareProfile

Property Value

HardwareProfile

hardwareResourceId

Specifies the resource ID of the associated hardware device. Only settable by HCI RP.

hardwareResourceId?: string

Property Value

string

identity

Identity for the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

identityKeyStore

Specifies the identity key store a machine is using.

identityKeyStore?: string

Property Value

string

kind

Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.

kind?: string

Property Value

string

lastStatusChange

The time of the last status change.

lastStatusChange?: Date

Property Value

Date

licenseProfile

Specifies the License related properties for a machine.

licenseProfile?: LicenseProfileMachineInstanceView

Property Value

LicenseProfileMachineInstanceView

locationData

Metadata pertaining to the geographic location of the resource.

locationData?: LocationData

Property Value

LocationData

machineFqdn

Specifies the hybrid machine FQDN.

machineFqdn?: string

Property Value

string

mssqlDiscovered

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

mssqlDiscovered?: string

Property Value

string

networkProfile

Information about the network the machine is on.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

osEdition

The edition of the Operating System.

osEdition?: string

Property Value

string

osName

The Operating System running on the hybrid machine.

osName?: string

Property Value

string

osProfile

Specifies the operating system settings for the hybrid machine.

osProfile?: OSProfile

Property Value

OSProfile

osSku

Specifies the Operating System product SKU.

osSku?: string

Property Value

string

osType

The type of Operating System (windows/linux).

osType?: string

Property Value

string

osVersion

The version of Operating System running on the hybrid machine.

osVersion?: string

Property Value

string

parentClusterResourceId

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

parentClusterResourceId?: string

Property Value

string

privateLinkScopeResourceId

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

privateLinkScopeResourceId?: string

Property Value

string

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

resources

The list of extensions affiliated to the machine

resources?: MachineExtension[]

Property Value

MachineExtension[]

serviceStatuses

Statuses of dependent services that are reported back to ARM.

serviceStatuses?: ServiceStatuses

Property Value

ServiceStatuses

status

The status of the hybrid machine agent.

status?: string

Property Value

string

statusReason

Indicates whether the service has detected that this Arc machine is a clone of another onboarded machine. Service-computed; not settable by the user.

statusReason?: string

Property Value

string

storageProfile

Information about the machine's storage

storageProfile?: StorageProfile

Property Value

StorageProfile

tpmEkCertificate

Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding.

tpmEkCertificate?: string

Property Value

string

vmId

Specifies the hybrid machine unique ID.

vmId?: string

Property Value

string

vmUuid

Specifies the Arc Machine's unique SMBIOS ID

vmUuid?: 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