Machine interface

Package:

@azure/arm-hybridcompute

Describes a hybrid machine.

Extends

TrackedResource

Properties

adFqdn	Specifies the AD fully qualified display name. NOTE: This property will not be serialized. It can only be populated by the server.
agentConfiguration	Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. NOTE: This property will not be serialized. It can only be populated by the server.
agentUpgrade	The info of the machine w.r.t Agent Upgrade
agentVersion	The hybrid machine agent full version. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
displayName	Specifies the hybrid machine display name. NOTE: This property will not be serialized. It can only be populated by the server.
dnsFqdn	Specifies the DNS fully qualified display name. NOTE: This property will not be serialized. It can only be populated by the server.
domainName	Specifies the Windows domain name. NOTE: This property will not be serialized. It can only be populated by the server.
errorDetails	Details about the error state. NOTE: This property will not be serialized. It can only be populated by the server.
extensions	Machine Extensions information (deprecated field)
identity	Identity for the resource.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
mssqlDiscovered	Specifies whether any MS SQL instance is discovered on the machine.
networkProfile	Information about the network the machine is on. NOTE: This property will not be serialized. It can only be populated by the server.
osEdition	The edition of the Operating System. NOTE: This property will not be serialized. It can only be populated by the server.
osName	The Operating System running on the hybrid machine. NOTE: This property will not be serialized. It can only be populated by the server.
osProfile	Specifies the operating system settings for the hybrid machine.
osSku	Specifies the Operating System product SKU. NOTE: This property will not be serialized. It can only be populated by the server.
osType	The type of Operating System (windows/linux).
osVersion	The version of Operating System running on the hybrid machine. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
resources	The list of extensions affiliated to the machine NOTE: This property will not be serialized. It can only be populated by the server.
serviceStatuses	Statuses of dependent services that are reported back to ARM.
status	The status of the hybrid machine agent. NOTE: This property will not be serialized. It can only be populated by the server.
vmId	Specifies the hybrid machine unique ID.
vmUuid	Specifies the Arc Machine's unique SMBIOS ID NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

adFqdn

Specifies the AD fully qualified display name. NOTE: This property will not be serialized. It can only be populated by the server.

adFqdn?: string

Property Value

string

agentConfiguration

Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

detectedProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

displayName

Specifies the hybrid machine display name. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

dnsFqdn

Specifies the DNS fully qualified display name. NOTE: This property will not be serialized. It can only be populated by the server.

dnsFqdn?: string

Property Value

string

domainName

Specifies the Windows domain name. NOTE: This property will not be serialized. It can only be populated by the server.

domainName?: string

Property Value

string

errorDetails

Details about the error state. NOTE: This property will not be serialized. It can only be populated by the server.

errorDetails?: ErrorDetail[]

Property Value

ErrorDetail[]

extensions

Machine Extensions information (deprecated field)

extensions?: MachineExtensionInstanceView[]

Property Value

MachineExtensionInstanceView[]

identity

Identity for the resource.

identity?: Identity

Property Value

Identity

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

osEdition

The edition of the Operating System. NOTE: This property will not be serialized. It can only be populated by the server.

osEdition?: string

Property Value

string

osName

The Operating System running on the hybrid machine. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resources

The list of extensions affiliated to the machine NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

status?: 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 NOTE: This property will not be serialized. It can only be populated by the server.

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} NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type