Package version:

InterfaceMachine

Describes a hybrid machine.

interface Machine {
    adFqdn?: string;
    agentConfiguration?: AgentConfiguration;
    agentUpgrade?: AgentUpgrade;
    agentVersion?: string;
    clientPublicKey?: string;
    cloudMetadata?: CloudMetadata;
    detectedProperties?: {
        [propertyName: string]: string;
    };
    displayName?: string;
    dnsFqdn?: string;
    domainName?: string;
    errorDetails?: ErrorDetail[];
    extensions?: MachineExtensionInstanceView[];
    id?: string;
    identity?: Identity;
    kind?: string;
    lastStatusChange?: Date;
    licenseProfile?: LicenseProfileMachineInstanceView;
    location: string;
    locationData?: LocationData;
    machineFqdn?: string;
    mssqlDiscovered?: string;
    name?: string;
    networkProfile?: NetworkProfile;
    osEdition?: string;
    osName?: string;
    osProfile?: OSProfile;
    osSku?: string;
    osType?: string;
    osVersion?: string;
    parentClusterResourceId?: string;
    privateLinkScopeResourceId?: string;
    provisioningState?: string;
    resources?: MachineExtension[];
    serviceStatuses?: ServiceStatuses;
    status?: string;
    systemData?: SystemData;
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
    vmId?: string;
    vmUuid?: string;
}

Hierarchy (view full)

Properties

adFqdn? agentConfiguration? agentUpgrade? agentVersion? clientPublicKey? cloudMetadata? detectedProperties? displayName? dnsFqdn? domainName? errorDetails? extensions? id? identity? kind? lastStatusChange? licenseProfile? location locationData? machineFqdn? mssqlDiscovered? name? networkProfile? osEdition? osName? osProfile? osSku? osType? osVersion? parentClusterResourceId? privateLinkScopeResourceId? provisioningState? resources? serviceStatuses? status? systemData? tags? type? vmId? vmUuid?

Properties

Optional ReadonlyadFqdn

adFqdn?: string

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

Optional ReadonlyagentConfiguration

agentConfiguration?: 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.

OptionalagentUpgrade

agentUpgrade?: AgentUpgrade

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

Optional ReadonlyagentVersion

agentVersion?: string

The hybrid machine agent full version. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalclientPublicKey

clientPublicKey?: string

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

OptionalcloudMetadata

cloudMetadata?: CloudMetadata

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

Optional ReadonlydetectedProperties

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

Detected properties from the machine. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlydisplayName

displayName?: string

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

Optional ReadonlydnsFqdn

dnsFqdn?: string

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

Optional ReadonlydomainName

domainName?: string

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

Optional ReadonlyerrorDetails

errorDetails?: ErrorDetail[]

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

Optionalextensions

extensions?: MachineExtensionInstanceView[]

Machine Extensions information (deprecated field)

Optional Readonlyid

id?: string

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.

Optionalidentity

identity?: Identity

Identity for the resource.

Optionalkind

kind?: string

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

Optional ReadonlylastStatusChange

lastStatusChange?: Date

The time of the last status change. NOTE: This property will not be serialized. It can only be populated by the server.

OptionallicenseProfile

licenseProfile?: LicenseProfileMachineInstanceView

Specifies the License related properties for a machine.

location

location: string

The geo-location where the resource lives

OptionallocationData

locationData?: LocationData

Metadata pertaining to the geographic location of the resource.

Optional ReadonlymachineFqdn

machineFqdn?: string

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

OptionalmssqlDiscovered

mssqlDiscovered?: string

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

Optional Readonlyname

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlynetworkProfile

networkProfile?: NetworkProfile

Information about the network the machine is on. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyosEdition

osEdition?: string

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

Optional ReadonlyosName

osName?: string

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

OptionalosProfile

osProfile?: OSProfile

Specifies the operating system settings for the hybrid machine.

Optional ReadonlyosSku

osSku?: string

Specifies the Operating System product SKU. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalosType

osType?: string

The type of Operating System (windows/linux).

Optional ReadonlyosVersion

osVersion?: string

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.

OptionalparentClusterResourceId

parentClusterResourceId?: string

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

OptionalprivateLinkScopeResourceId

privateLinkScopeResourceId?: string

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

Optional ReadonlyprovisioningState

provisioningState?: string

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyresources

resources?: MachineExtension[]

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

OptionalserviceStatuses

serviceStatuses?: ServiceStatuses

Statuses of dependent services that are reported back to ARM.

Optional Readonlystatus

status?: string

The status of the hybrid machine agent. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlysystemData

systemData?: 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.

Optionaltags

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

Resource tags.

Optional Readonlytype

type?: string

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.

OptionalvmId

vmId?: string

Specifies the hybrid machine unique ID.

Optional ReadonlyvmUuid

vmUuid?: string

Specifies the Arc Machine's unique SMBIOS ID NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility