Machines - Get

Service:

Hybrid Compute

API Version:

2022-12-27

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=2022-12-27

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}?api-version=2022-12-27&$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

HTTP

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

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HybridCompute;
using Azure.ResourceManager.HybridCompute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2022-12-27/examples/Machines_Get.json
// this example is just showing the usage of "Machines_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HybridComputeMachineResource created on azure
// for more information of creating HybridComputeMachineResource, please refer to the document of HybridComputeMachineResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "myResourceGroup";
string machineName = "myMachine";
ResourceIdentifier hybridComputeMachineResourceId = HybridComputeMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, machineName);
HybridComputeMachineResource hybridComputeMachine = client.GetHybridComputeMachineResource(hybridComputeMachineResourceId);

// invoke the operation
HybridComputeMachineResource result = await hybridComputeMachine.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HybridComputeMachineData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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",
  "properties": {
    "provisioningState": "Succeeded",
    "agentVersion": null,
    "status": null,
    "lastStatusChange": null,
    "errorDetails": null,
    "displayName": null,
    "machineFqdn": null,
    "vmUuid": null,
    "osSku": null,
    "domainName": null,
    "adFqdn": null,
    "dnsFqdn": null,
    "osVersion": null,
    "osType": null,
    "osProfile": {
      "computerName": null,
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      }
    },
    "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"
  },
  "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.
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
Identity	Identity for the resource.
InstanceViewTypes	The expand expression to apply on the operation.
LastAttemptStatusEnum	Specifies the status of Agent Upgrade.
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.
OSProfile	Specifies the operating system settings for the hybrid machine.
PatchModeTypes	Specifies the patch mode.
ResourceIdentityType	The identity type.
ServiceStatus	Describes the status and behavior of a service.
ServiceStatuses	Reports the state and behavior of dependent services.
Status	Instance view status.
StatusLevelTypes	The level code.
StatusTypes	The status of the hybrid machine agent.
systemData	Metadata pertaining to creation and last modification of the resource.
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
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

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.

Identity

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.

InstanceViewTypes

The expand expression to apply on the operation.

Name	Type	Description
instanceView	string

LastAttemptStatusEnum

Specifies the status of Agent Upgrade.

Name	Type	Description
Failed	string
Success	string

LinuxConfiguration

Specifies the linux configuration for update management.

Name	Type	Description
patchSettings.assessmentMode	AssessmentModeTypes	Specifies the assessment mode.
patchSettings.patchMode	PatchModeTypes	Specifies the patch mode.

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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identity for the resource.
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.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.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. Ex - /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.

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

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

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string	The time of the status.

StatusLevelTypes

The level code.

Name	Type	Description
Error	string
Info	string
Warning	string

StatusTypes

The status of the hybrid machine agent.

Name	Type	Description
Connected	string
Disconnected	string
Error	string

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.

WindowsConfiguration

Specifies the windows configuration for update management.

Name	Type	Description
patchSettings.assessmentMode	AssessmentModeTypes	Specifies the assessment mode.
patchSettings.patchMode	PatchModeTypes	Specifies the patch mode.