Machines - Get

Retrieves information about the model view or the instance view of a hybrid machine.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}?api-version=2024-07-10
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}?api-version=2024-07-10&$expand=instanceView

URI Parameters

Name In Required Type Description
machineName
path True

string

The name of the hybrid machine.

Regex pattern: ^[a-zA-Z0-9-_\.]{1,54}$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

$expand
query

InstanceViewTypes

The expand expression to apply on the operation.

Responses

Name Type Description
200 OK

Machine

OK

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get Machine

Sample request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine?api-version=2024-07-10&$expand=instanceView

Sample response

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine",
  "name": "myMachine",
  "location": "eastus2euap",
  "tags": null,
  "identity": {
    "type": "SystemAssigned",
    "principalId": "string",
    "tenantId": "string"
  },
  "type": "Microsoft.HybridCompute/machines",
  "kind": null,
  "properties": {
    "provisioningState": "Succeeded",
    "agentVersion": null,
    "status": null,
    "lastStatusChange": null,
    "errorDetails": null,
    "displayName": null,
    "machineFqdn": null,
    "vmUuid": null,
    "osSku": null,
    "osEdition": "Standard",
    "domainName": null,
    "adFqdn": null,
    "dnsFqdn": null,
    "osVersion": null,
    "osType": null,
    "osProfile": {
      "computerName": null,
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null,
          "enableHotpatching": true,
          "status": {
            "hotpatchEnablementStatus": "Enabled",
            "error": null
          }
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      }
    },
    "licenseProfile": {
      "licenseStatus": "Licensed",
      "licenseChannel": "PSG",
      "softwareAssurance": {
        "softwareAssuranceCustomer": true
      },
      "esuProfile": {
        "licenseAssignmentState": "Assigned",
        "esuEligibility": "Ineligible",
        "serverType": "Standard",
        "esuKeyState": "Inactive",
        "esuKeys": [
          {
            "sku": "skuNumber1",
            "licenseStatus": 1
          },
          {
            "sku": "skuNumber2",
            "licenseStatus": 1
          }
        ]
      },
      "productProfile": {
        "subscriptionStatus": "Enabled",
        "productType": "WindowsServer",
        "enrollmentDate": "2023-10-05T20:36:49.745Z",
        "billingStartDate": "2023-10-05T20:36:49.745Z",
        "disenrollmentDate": "2023-11-05T20:36:49.745Z",
        "billingEndDate": "2023-11-05T20:36:49.745Z",
        "productFeatures": [
          {
            "name": "Hotpatch",
            "subscriptionStatus": "Enabled",
            "enrollmentDate": "2023-10-05T20:36:49.745Z",
            "billingStartDate": "2023-10-05T20:36:49.745Z",
            "disenrollmentDate": "2023-11-05T20:36:49.745Z",
            "billingEndDate": "2023-11-05T20:36:49.745Z"
          }
        ]
      }
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "locationData": {
      "name": "Redmond",
      "city": "redmond",
      "district": null,
      "countryOrRegion": "usa"
    },
    "clientPublicKey": "string",
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "mssqlDiscovered": "false",
    "detectedProperties": {
      "cloudprovider": "N/A",
      "manufacturer": "Microsoft Corporation",
      "model": "Virtual Machine"
    },
    "agentConfiguration": {
      "proxyUrl": "https://test.test",
      "incomingConnectionsPorts": [
        "22",
        "23"
      ],
      "extensionsAllowList": null,
      "extensionsBlockList": null,
      "proxyBypass": [
        "proxy1",
        "proxy2"
      ],
      "extensionsEnabled": "true",
      "guestConfigurationEnabled": "true",
      "configMode": "full"
    },
    "serviceStatuses": {
      "extensionService": {
        "status": "Running",
        "startupType": "Automatic"
      },
      "guestConfigurationService": {
        "status": "Running",
        "startupType": "Automatic"
      }
    },
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName",
    "networkProfile": {
      "networkInterfaces": [
        {
          "ipAddresses": [
            {
              "address": "192.168.12.345",
              "ipAddressVersion": "IPv4",
              "subnet": {
                "addressPrefix": "192.168.12.0/24"
              }
            }
          ]
        },
        {
          "ipAddresses": [
            {
              "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc",
              "ipAddressVersion": "IPv6",
              "subnet": {
                "addressPrefix": "1001:0:34aa:5000::/64"
              }
            }
          ]
        }
      ]
    }
  },
  "resources": []
}

Get Machine with License Profile Instance View

Sample request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine?api-version=2024-07-10&$expand=instanceView

Sample response

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine",
  "name": "myMachine",
  "location": "eastus2euap",
  "tags": null,
  "identity": {
    "type": "SystemAssigned",
    "principalId": "string",
    "tenantId": "string"
  },
  "type": "Microsoft.HybridCompute/machines",
  "kind": null,
  "properties": {
    "provisioningState": "Succeeded",
    "agentVersion": null,
    "status": null,
    "lastStatusChange": null,
    "errorDetails": null,
    "displayName": null,
    "machineFqdn": null,
    "vmUuid": null,
    "osSku": null,
    "osEdition": "Standard",
    "domainName": null,
    "adFqdn": null,
    "dnsFqdn": null,
    "osVersion": null,
    "osType": null,
    "osProfile": {
      "computerName": null,
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null,
          "enableHotpatching": true,
          "status": {
            "hotpatchEnablementStatus": "Enabled",
            "error": null
          }
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      }
    },
    "licenseProfile": {
      "licenseStatus": "Licensed",
      "licenseChannel": "PSG",
      "softwareAssurance": {
        "softwareAssuranceCustomer": true
      },
      "esuProfile": {
        "assignedLicense": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}",
          "name": "{licenseName}",
          "type": "Microsoft.HybridCompute/licenses",
          "location": "eastus2euap",
          "tags": null,
          "properties": {
            "tenantId": "{tenandId}",
            "licenseType": "ESU",
            "licenseDetails": {
              "state": "Activated",
              "target": "Windows Server 2012",
              "edition": "Datacenter",
              "type": "pCore",
              "processors": 6,
              "assignedLicenses": 8,
              "immutableId": "<generated Guid>"
            }
          }
        },
        "licenseAssignmentState": "Assigned",
        "esuEligibility": "Ineligible",
        "serverType": "Standard",
        "esuKeyState": "Inactive",
        "esuKeys": [
          {
            "sku": "skuNumber1",
            "licenseStatus": 1
          },
          {
            "sku": "skuNumber2",
            "licenseStatus": 1
          }
        ]
      },
      "productProfile": {
        "subscriptionStatus": "Enabled",
        "productType": "WindowsServer",
        "enrollmentDate": "2023-10-05T20:36:49.745Z",
        "billingStartDate": "2023-10-05T20:36:49.745Z",
        "disenrollmentDate": "2023-11-05T20:36:49.745Z",
        "billingEndDate": "2023-11-05T20:36:49.745Z",
        "productFeatures": [
          {
            "name": "Hotpatch",
            "subscriptionStatus": "Enabled",
            "enrollmentDate": "2023-10-05T20:36:49.745Z",
            "billingStartDate": "2023-10-05T20:36:49.745Z",
            "disenrollmentDate": "2023-11-05T20:36:49.745Z",
            "billingEndDate": "2023-11-05T20:36:49.745Z"
          }
        ]
      }
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "locationData": {
      "name": "Redmond",
      "city": "redmond",
      "district": null,
      "countryOrRegion": "usa"
    },
    "clientPublicKey": "string",
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "mssqlDiscovered": "false",
    "detectedProperties": {
      "cloudprovider": "N/A",
      "manufacturer": "Microsoft Corporation",
      "model": "Virtual Machine"
    },
    "agentConfiguration": {
      "proxyUrl": "https://test.test",
      "incomingConnectionsPorts": [
        "22",
        "23"
      ],
      "extensionsAllowList": null,
      "extensionsBlockList": null,
      "proxyBypass": [
        "proxy1",
        "proxy2"
      ],
      "extensionsEnabled": "true",
      "guestConfigurationEnabled": "true",
      "configMode": "full"
    },
    "serviceStatuses": {
      "extensionService": {
        "status": "Running",
        "startupType": "Automatic"
      },
      "guestConfigurationService": {
        "status": "Running",
        "startupType": "Automatic"
      }
    },
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName",
    "networkProfile": {
      "networkInterfaces": [
        {
          "ipAddresses": [
            {
              "address": "192.168.12.345",
              "ipAddressVersion": "IPv4",
              "subnet": {
                "addressPrefix": "192.168.12.0/24"
              }
            }
          ]
        },
        {
          "ipAddresses": [
            {
              "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc",
              "ipAddressVersion": "IPv6",
              "subnet": {
                "addressPrefix": "1001:0:34aa:5000::/64"
              }
            }
          ]
        }
      ]
    }
  },
  "resources": []
}

Definitions

Name Description
agent configuration mode

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

AgentConfiguration

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

AgentUpgrade

The info w.r.t Agent Upgrade.

ArcKindEnum

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

AssessmentModeTypes

Specifies the assessment mode.

CloudMetadata

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

ConfigurationExtension

Describes properties that can identify extensions.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

EsuEligibility

The ESU eligibility.

EsuKey

ESU key

EsuKeyState

The ESU key state.

EsuServerType

The server types for Esu.

HotpatchEnablementStatus

Status of hotpatch enablement or disablement.

Identity

Identity for the resource.

InstanceViewTypes

The expand expression to apply on the operation.

IpAddress

Describes properties of the IP address.

LastAttemptStatusEnum

Specifies the status of Agent Upgrade.

License

Describes a license in a hybrid machine.

licenseAssignmentState

Describes the license assignment state (Assigned or NotAssigned).

LicenseCoreType

Describes the license core type (pCore or vCore).

LicenseDetails

Describes the properties of a License.

LicenseEdition

Describes the edition of the license. The values are either Standard or Datacenter.

LicenseProfileMachineInstanceView

License Profile Instance View in Machine Properties.

LicenseProfileMachineInstanceViewEsuProperties

Properties for the Machine ESU profile.

LicenseProfileProductType

The product type of the license.

LicenseProfileSubscriptionStatus

Subscription status of the OS or Product feature.

LicenseState

Describes the state of the license.

LicenseStatus

The license status.

LicenseTarget

Describes the license target server.

LicenseType

The type of the license resource.

LinuxConfiguration

Specifies the linux configuration for update management.

locationData

Metadata pertaining to the geographic location of the resource.

Machine

Describes a hybrid machine.

MachineExtension

Describes a Machine Extension.

MachineExtensionInstanceView

Describes the Machine Extension Instance View.

MachineExtensionProperties

Describes the properties of a Machine Extension.

NetworkInterface

Describes a network interface.

NetworkProfile

Describes the network information on this machine.

OSProfile

Specifies the operating system settings for the hybrid machine.

PatchModeTypes

Specifies the patch mode.

ProductFeature

Product Feature

ProgramYear

Describes the program year the volume license is for.

ProvisioningState

The provisioning state, which only appears in the response.

ResourceIdentityType

The identity type.

ServiceStatus

Describes the status and behavior of a service.

ServiceStatuses

Reports the state and behavior of dependent services.

Status

Status of the hotpatch capability enrollment or disenrollment.

StatusTypes

The status of the hybrid machine agent.

Subnet

Describes the subnet.

systemData

Metadata pertaining to creation and last modification of the resource.

VolumeLicenseDetails
WindowsConfiguration

Specifies the windows configuration for update management.

agent configuration mode

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

Name Type Description
full

string

monitor

string

AgentConfiguration

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

Name Type Description
configMode

agent configuration mode

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

extensionsAllowList

ConfigurationExtension[]

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

extensionsBlockList

ConfigurationExtension[]

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

extensionsEnabled

string

Specifies whether the extension service is enabled or disabled.

guestConfigurationEnabled

string

Specified whether the guest configuration service is enabled or disabled.

incomingConnectionsPorts

string[]

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

proxyBypass

string[]

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

proxyUrl

string

Specifies the URL of the proxy to be used.

AgentUpgrade

The info w.r.t Agent Upgrade.

Name Type Description
correlationId

string

The correlation ID passed in from RSM per upgrade.

desiredVersion

string

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

enableAutomaticUpgrade

boolean

Specifies if RSM should try to upgrade this machine

lastAttemptDesiredVersion

string

Specifies the version of the last attempt

lastAttemptMessage

string

Failure message of last upgrade attempt if any.

lastAttemptStatus

LastAttemptStatusEnum

Specifies the status of Agent Upgrade.

lastAttemptTimestamp

string

Timestamp of last upgrade attempt

ArcKindEnum

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

Name Type Description
AVS

string

AWS

string

EPS

string

GCP

string

HCI

string

SCVMM

string

VMware

string

AssessmentModeTypes

Specifies the assessment mode.

Name Type Description
AutomaticByPlatform

string

ImageDefault

string

CloudMetadata

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

Name Type Description
provider

string

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

ConfigurationExtension

Describes properties that can identify extensions.

Name Type Description
publisher

string

Publisher of the extension.

type

string

Type of the extension.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

EsuEligibility

The ESU eligibility.

Name Type Description
Eligible

string

Ineligible

string

Unknown

string

EsuKey

ESU key

Name Type Description
licenseStatus

integer

The current status of the license profile key. Represented by the same integer value that is presented on the machine itself when querying the license key status.

sku

string

SKU number.

EsuKeyState

The ESU key state.

Name Type Description
Active

string

Inactive

string

EsuServerType

The server types for Esu.

Name Type Description
Datacenter

string

Standard

string

HotpatchEnablementStatus

Status of hotpatch enablement or disablement.

Name Type Description
ActionRequired

string

Disabled

string

Enabled

string

PendingEvaluation

string

Unknown

string

Identity

Identity for the resource.

Name Type Description
principalId

string

The principal ID of resource identity. The value must be an UUID.

tenantId

string

The tenant ID of resource. The value must be an UUID.

type

ResourceIdentityType

The identity type.

InstanceViewTypes

The expand expression to apply on the operation.

Name Type Description
instanceView

string

IpAddress

Describes properties of the IP address.

Name Type Description
address

string

Represents the IP Address.

ipAddressVersion

string

Represents the Ip Address Version.

subnet

Subnet

The subnet to which this IP address belongs.

LastAttemptStatusEnum

Specifies the status of Agent Upgrade.

Name Type Description
Failed

string

Success

string

License

Describes a license in a hybrid machine.

Name Type Description
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.licenseDetails

LicenseDetails

Describes the properties of a License.

properties.licenseType

LicenseType

The type of the license resource.

properties.provisioningState

ProvisioningState

The provisioning state, which only appears in the response.

properties.tenantId

string

Describes the tenant id.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

licenseAssignmentState

Describes the license assignment state (Assigned or NotAssigned).

Name Type Description
Assigned

string

NotAssigned

string

LicenseCoreType

Describes the license core type (pCore or vCore).

Name Type Description
pCore

string

vCore

string

LicenseDetails

Describes the properties of a License.

Name Type Description
assignedLicenses

integer

Describes the number of assigned licenses.

edition

LicenseEdition

Describes the edition of the license. The values are either Standard or Datacenter.

immutableId

string

Describes the immutable id.

processors

integer

Describes the number of processors.

state

LicenseState

Describes the state of the license.

target

LicenseTarget

Describes the license target server.

type

LicenseCoreType

Describes the license core type (pCore or vCore).

volumeLicenseDetails

VolumeLicenseDetails[]

A list of volume license details.

LicenseEdition

Describes the edition of the license. The values are either Standard or Datacenter.

Name Type Description
Datacenter

string

Standard

string

LicenseProfileMachineInstanceView

License Profile Instance View in Machine Properties.

Name Type Description
esuProfile

LicenseProfileMachineInstanceViewEsuProperties

Properties for the Machine ESU profile.

licenseChannel

string

Indicates the license channel.

licenseStatus

LicenseStatus

Indicates the license status of the OS.

productProfile.billingEndDate

string

The timestamp in UTC when the billing ends.

productProfile.billingStartDate

string

The timestamp in UTC when the billing starts.

productProfile.disenrollmentDate

string

The timestamp in UTC when the user disenrolled the feature.

productProfile.enrollmentDate

string

The timestamp in UTC when the user enrolls the feature.

productProfile.error

ErrorDetail

The errors that were encountered during the feature enrollment or disenrollment.

productProfile.productFeatures

ProductFeature[]

The list of product features.

productProfile.productType

LicenseProfileProductType

Indicates the product type of the license.

productProfile.subscriptionStatus

LicenseProfileSubscriptionStatus

Indicates the subscription status of the product.

softwareAssurance.softwareAssuranceCustomer

boolean

Specifies if this machine is licensed as part of a Software Assurance agreement.

LicenseProfileMachineInstanceViewEsuProperties

Properties for the Machine ESU profile.

Name Type Description
assignedLicense

License

The assigned license resource.

assignedLicenseImmutableId

string

The guid id of the license.

esuEligibility

EsuEligibility

Indicates the eligibility state of Esu.

esuKeyState

EsuKeyState

Indicates whether there is an ESU Key currently active for the machine.

esuKeys

EsuKey[]

The list of ESU keys.

licenseAssignmentState

licenseAssignmentState

Describes the license assignment state (Assigned or NotAssigned).

serverType

EsuServerType

The type of the Esu servers.

LicenseProfileProductType

The product type of the license.

Name Type Description
WindowsIoTEnterprise

string

WindowsServer

string

LicenseProfileSubscriptionStatus

Subscription status of the OS or Product feature.

Name Type Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

Unknown

string

LicenseState

Describes the state of the license.

Name Type Description
Activated

string

Deactivated

string

LicenseStatus

The license status.

Name Type Description
ExtendedGrace

string

Licensed

string

NonGenuineGrace

string

Notification

string

OOBGrace

string

OOTGrace

string

Unlicensed

string

LicenseTarget

Describes the license target server.

Name Type Description
Windows Server 2012

string

Windows Server 2012 R2

string

LicenseType

The type of the license resource.

Name Type Description
ESU

string

LinuxConfiguration

Specifies the linux configuration for update management.

Name Type Description
patchSettings.assessmentMode

AssessmentModeTypes

Specifies the assessment mode.

patchSettings.enableHotpatching

boolean

Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot.

patchSettings.patchMode

PatchModeTypes

Specifies the patch mode.

patchSettings.status

Status

Status of the hotpatch capability enrollment or disenrollment.

locationData

Metadata pertaining to the geographic location of the resource.

Name Type Description
city

string

The city or locality where the resource is located.

countryOrRegion

string

The country or region where the resource is located

district

string

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

name

string

A canonical name for the geographic or physical location.

Machine

Describes a hybrid machine.

Name Type Description
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

Identity

Identity for the resource.

kind

ArcKindEnum

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

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.adFqdn

string

Specifies the AD fully qualified display name.

properties.agentConfiguration

AgentConfiguration

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

properties.agentUpgrade

AgentUpgrade

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

properties.agentVersion

string

The hybrid machine agent full version.

properties.clientPublicKey

string

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

properties.cloudMetadata

CloudMetadata

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

properties.detectedProperties

object

Detected properties from the machine.

properties.displayName

string

Specifies the hybrid machine display name.

properties.dnsFqdn

string

Specifies the DNS fully qualified display name.

properties.domainName

string

Specifies the Windows domain name.

properties.errorDetails

ErrorDetail[]

Details about the error state.

properties.extensions

MachineExtensionInstanceView[]

Machine Extensions information (deprecated field)

properties.lastStatusChange

string

The time of the last status change.

properties.licenseProfile

LicenseProfileMachineInstanceView

Specifies the License related properties for a machine.

properties.locationData

locationData

Metadata pertaining to the geographic location of the resource.

properties.machineFqdn

string

Specifies the hybrid machine FQDN.

properties.mssqlDiscovered

string

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

properties.networkProfile

NetworkProfile

Information about the network the machine is on.

properties.osEdition

string

The edition of the Operating System.

properties.osName

string

The Operating System running on the hybrid machine.

properties.osProfile

OSProfile

Specifies the operating system settings for the hybrid machine.

properties.osSku

string

Specifies the Operating System product SKU.

properties.osType

string

The type of Operating System (windows/linux).

properties.osVersion

string

The version of Operating System running on the hybrid machine.

properties.parentClusterResourceId

string

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

properties.privateLinkScopeResourceId

string

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

properties.provisioningState

string

The provisioning state, which only appears in the response.

properties.serviceStatuses

ServiceStatuses

Statuses of dependent services that are reported back to ARM.

properties.status

StatusTypes

The status of the hybrid machine agent.

properties.vmId

string

Specifies the hybrid machine unique ID.

properties.vmUuid

string

Specifies the Arc Machine's unique SMBIOS ID

resources

MachineExtension[]

The list of extensions affiliated to the machine

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MachineExtension

Describes a Machine Extension.

Name Type Description
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties

MachineExtensionProperties

Describes Machine Extension Properties.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MachineExtensionInstanceView

Describes the Machine Extension Instance View.

Name Type Description
name

string

The machine extension name.

status

Status

Instance view status.

type

string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion

string

Specifies the version of the script handler.

MachineExtensionProperties

Describes the properties of a Machine Extension.

Name Type Description
autoUpgradeMinorVersion

boolean

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

enableAutomaticUpgrade

boolean

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

forceUpdateTag

string

How the extension handler should be forced to update even if the extension configuration has not changed.

instanceView

MachineExtensionInstanceView

The machine extension instance view.

protectedSettings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provisioningState

string

The provisioning state, which only appears in the response.

publisher

string

The name of the extension handler publisher.

settings

Json formatted public settings for the extension.

type

string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion

string

Specifies the version of the script handler.

NetworkInterface

Describes a network interface.

Name Type Description
ipAddresses

IpAddress[]

The list of IP addresses in this interface.

NetworkProfile

Describes the network information on this machine.

Name Type Description
networkInterfaces

NetworkInterface[]

The list of network interfaces.

OSProfile

Specifies the operating system settings for the hybrid machine.

Name Type Description
computerName

string

Specifies the host OS name of the hybrid machine.

linuxConfiguration

LinuxConfiguration

Specifies the linux configuration for update management.

windowsConfiguration

WindowsConfiguration

Specifies the windows configuration for update management.

PatchModeTypes

Specifies the patch mode.

Name Type Description
AutomaticByOS

string

AutomaticByPlatform

string

ImageDefault

string

Manual

string

ProductFeature

Product Feature

Name Type Description
billingEndDate

string

The timestamp in UTC when the billing ends.

billingStartDate

string

The timestamp in UTC when the billing starts.

disenrollmentDate

string

The timestamp in UTC when the user disenrolled the feature.

enrollmentDate

string

The timestamp in UTC when the user enrolls the feature.

error

ErrorDetail

The errors that were encountered during the feature enrollment or disenrollment.

name

string

Product feature name.

subscriptionStatus

LicenseProfileSubscriptionStatus

Indicates the current status of the product features.

ProgramYear

Describes the program year the volume license is for.

Name Type Description
Year 1

string

Year 2

string

Year 3

string

ProvisioningState

The provisioning state, which only appears in the response.

Name Type Description
Accepted

string

Canceled

string

Creating

string

Deleted

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

The identity type.

Name Type Description
SystemAssigned

string

ServiceStatus

Describes the status and behavior of a service.

Name Type Description
startupType

string

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

status

string

The current status of the service.

ServiceStatuses

Reports the state and behavior of dependent services.

Name Type Description
extensionService

ServiceStatus

The state of the extension service on the Arc-enabled machine.

guestConfigurationService

ServiceStatus

The state of the guest configuration service on the Arc-enabled machine.

Status

Status of the hotpatch capability enrollment or disenrollment.

Name Type Description
error

ErrorDetail

The errors that were encountered during the hotpatch capability enrollment or disenrollment.

hotpatchEnablementStatus

HotpatchEnablementStatus

Indicates the current status of the hotpatch being enabled or disabled.

StatusTypes

The status of the hybrid machine agent.

Name Type Description
Connected

string

Disconnected

string

Error

string

Subnet

Describes the subnet.

Name Type Description
addressPrefix

string

Represents address prefix.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

VolumeLicenseDetails

Name Type Description
invoiceId

string

The invoice id for the volume license.

programYear

ProgramYear

Describes the program year the volume license is for.

WindowsConfiguration

Specifies the windows configuration for update management.

Name Type Description
patchSettings.assessmentMode

AssessmentModeTypes

Specifies the assessment mode.

patchSettings.enableHotpatching

boolean

Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot.

patchSettings.patchMode

PatchModeTypes

Specifies the patch mode.

patchSettings.status

Status

Status of the hotpatch capability enrollment or disenrollment.