Machines - Get

Referência

Service:: Hybrid Compute

API Version:: 2022-12-27

Obtém informações sobre a vista de modelo ou a vista de instância de uma máquina híbrida.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
machineName	path	True	string	O nome da máquina híbrida. Regex pattern: `^[a-zA-Z0-9-_\.]{1,54}$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$expand	query		InstanceViewTypes	A expressão expandir a aplicar na operação.

Respostas

Name	Tipo	Description
200 OK	Machine	OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get Machine

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

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": []
}

Definições

Name	Description
agent configuration mode	Nome do modo de configuração a utilizar. Os modos são configurações predefinidas de controlos de segurança, listas de permissões de extensão e configuração de convidado, mantidas pela Microsoft.
AgentConfiguration	Propriedades configuráveis que o utilizador pode definir localmente através do comando de configuração azcmagent ou remotamente através do ARM.
AgentUpgrade	As informações w.r.t Atualização do Agente.
AssessmentModeTypes	Especifica o modo de avaliação.
CloudMetadata	Os metadados do ambiente da cloud (Azure/GCP/AWS/OCI...).
ConfigurationExtension	Descreve propriedades que podem identificar extensões.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
Identity	Identidade do recurso.
InstanceViewTypes	A expressão de expansão a aplicar na operação.
LastAttemptStatusEnum	Especifica o estado da Atualização do Agente.
LinuxConfiguration	Especifica a configuração do linux para a gestão de atualizações.
locationData	Metadados relativos à localização geográfica do recurso.
Machine	Descreve uma máquina híbrida.
MachineExtension	Descreve uma Extensão de Máquina.
MachineExtensionInstanceView	Descreve a Vista de Instância da Extensão do Computador.
MachineExtensionProperties	Descreve as propriedades de uma Extensão de Máquina.
OSProfile	Especifica as definições do sistema operativo para a máquina híbrida.
PatchModeTypes	Especifica o modo de patch.
ResourceIdentityType	O tipo de identidade.
ServiceStatus	Descreve o estado e o comportamento de um serviço.
ServiceStatuses	Comunica o estado e o comportamento dos serviços dependentes.
Status	Estado da vista de instância.
StatusLevelTypes	O código de nível.
StatusTypes	O estado do agente da máquina híbrida.
systemData	Metadados relativos à criação e última modificação do recurso.
WindowsConfiguration	Especifica a configuração do windows para a gestão de atualizações.

agent configuration mode

Nome do modo de configuração a utilizar. Os modos são configurações predefinidas de controlos de segurança, listas de permissões de extensão e configuração de convidado, mantidas pela Microsoft.

Name	Tipo	Description
full	string
monitor	string

AgentConfiguration

Propriedades configuráveis que o utilizador pode definir localmente através do comando de configuração azcmagent ou remotamente através do ARM.

Name	Tipo	Description
configMode	agent configuration mode	Nome do modo de configuração a utilizar. Os modos são configurações predefinidas de controlos de segurança, listas de permissões de extensão e configuração de convidado, mantidas pela Microsoft.
extensionsAllowList	ConfigurationExtension[]	Matriz de extensões que podem ser instaladas ou atualizadas.
extensionsBlockList	ConfigurationExtension[]	Matriz de extensões bloqueadas (não pode ser instalada ou atualizada)
extensionsEnabled	string	Especifica se o serviço de extensão está ativado ou desativado.
guestConfigurationEnabled	string	Foi especificado se o serviço de configuração de convidado está ativado ou desativado.
incomingConnectionsPorts	string[]	Especifica a lista de portas nas quais o agente poderá escutar.
proxyBypass	string[]	Lista de nomes de serviço que não devem utilizar o servidor proxy especificado.
proxyUrl	string	Especifica o URL do proxy a ser utilizado.

AgentUpgrade

As informações w.r.t Atualização do Agente.

Name	Tipo	Description
correlationId	string	O ID de correlação transmitido a partir do RSM por atualização.
desiredVersion	string	Especifica as informações da versão w.r.t AgentUpgrade para o computador.
enableAutomaticUpgrade	boolean	Especifica se o RSM deve tentar atualizar este computador
lastAttemptMessage	string	Mensagem de falha da última tentativa de atualização, se existir.
lastAttemptStatus	LastAttemptStatusEnum	Especifica o estado de Atualização do Agente.
lastAttemptTimestamp	string	Carimbo de data/hora da última tentativa de atualização

AssessmentModeTypes

Especifica o modo de avaliação.

Name	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

CloudMetadata

Os metadados do ambiente da cloud (Azure/GCP/AWS/OCI...).

Name	Tipo	Description
provider	string	Especifica o fornecedor de cloud (Azure/AWS/GCP...).

ConfigurationExtension

Descreve propriedades que podem identificar extensões.

Name	Tipo	Description
publisher	string	Publicador da extensão.
type	string	Tipo da extensão.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso.
tenantId	string	O ID de inquilino do recurso.
type	ResourceIdentityType	O tipo de identidade.

InstanceViewTypes

A expressão de expansão a aplicar na operação.

Name	Tipo	Description
instanceView	string

LastAttemptStatusEnum

Especifica o estado da Atualização do Agente.

Name	Tipo	Description
Failed	string
Success	string

LinuxConfiguration

Especifica a configuração do linux para a gestão de atualizações.

Name	Tipo	Description
patchSettings.assessmentMode	AssessmentModeTypes	Especifica o modo de avaliação.
patchSettings.patchMode	PatchModeTypes	Especifica o modo de patch.

locationData

Metadados relativos à localização geográfica do recurso.

Name	Tipo	Description
city	string	A cidade ou localidade onde o recurso está localizado.
countryOrRegion	string	O país ou região onde o recurso está localizado
district	string	O distrito, o estado ou a província onde o recurso está localizado.
name	string	Um nome canónico para a localização geográfica ou física.

Machine

Descreve uma máquina híbrida.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidade do recurso.
location	string	A localização geográfica onde reside o recurso
name	string	O nome do recurso
properties.adFqdn	string	Especifica o nome a apresentar completamente qualificado do AD.
properties.agentConfiguration	AgentConfiguration	Propriedades configuráveis que o utilizador pode definir localmente através do comando de configuração azcmagent ou remotamente através do ARM.
properties.agentUpgrade	AgentUpgrade	As informações da Atualização do Agente w.r.t do computador
properties.agentVersion	string	A versão completa do agente de máquina híbrida.
properties.clientPublicKey	string	Chave Pública que o cliente fornece para ser utilizada durante a integração do recurso inicial
properties.cloudMetadata	CloudMetadata	Os metadados do ambiente da cloud (Azure/GCP/AWS/OCI...).
properties.detectedProperties	object	Foram detetadas propriedades do computador.
properties.displayName	string	Especifica o nome a apresentar da máquina híbrida.
properties.dnsFqdn	string	Especifica o nome a apresentar completamente qualificado do DNS.
properties.domainName	string	Especifica o nome de domínio do Windows.
properties.errorDetails	ErrorDetail[]	Detalhes sobre o estado do erro.
properties.extensions	MachineExtensionInstanceView[]	Informações das Extensões de Máquina (campo preterido)
properties.lastStatusChange	string	A hora da última alteração de estado.
properties.locationData	locationData	Metadados relativos à localização geográfica do recurso.
properties.machineFqdn	string	Especifica o FQDN da máquina híbrida.
properties.mssqlDiscovered	string	Especifica se alguma instância do MS SQL é detetada no computador.
properties.osName	string	O Sistema Operativo em execução no computador híbrido.
properties.osProfile	OSProfile	Especifica as definições do sistema operativo para a máquina híbrida.
properties.osSku	string	Especifica o SKU do produto do Sistema Operativo.
properties.osType	string	O tipo de Sistema Operativo (windows/linux).
properties.osVersion	string	A versão do Sistema Operativo em execução no computador híbrido.
properties.parentClusterResourceId	string	O ID de recurso do cluster principal (Azure HCI) a que este computador está atribuído, se existir.
properties.privateLinkScopeResourceId	string	O ID de recurso do âmbito da ligação privada a que este computador está atribuído, se existir.
properties.provisioningState	string	O estado de aprovisionamento, que só aparece na resposta.
properties.serviceStatuses	ServiceStatuses	Estados dos serviços dependentes que são comunicados ao ARM.
properties.status	StatusTypes	O estado do agente da máquina híbrida.
properties.vmId	string	Especifica o ID exclusivo da máquina híbrida.
properties.vmUuid	string	Especifica o ID SMBIOS exclusivo do Arc Machine
resources	MachineExtension[]	A lista de extensões afiliadas ao computador
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
tags	object	Etiquetas de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineExtension

Descreve uma Extensão de Máquina.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde reside o recurso
name	string	O nome do recurso
properties	MachineExtensionProperties	Descreve as Propriedades da Extensão do Computador.
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
tags	object	Etiquetas de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineExtensionInstanceView

Descreve a Vista de Instância da Extensão do Computador.

Name	Tipo	Description
name	string	O nome da extensão do computador.
status	Status	Estado da vista de instância.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do processador de scripts.

MachineExtensionProperties

Descreve as propriedades de uma Extensão de Máquina.

Name	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica se a extensão deve utilizar uma versão secundária mais recente se uma estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias, a menos que seja reimplementada, mesmo com esta propriedade definida como verdadeira.
enableAutomaticUpgrade	boolean	Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir uma versão mais recente disponível.
forceUpdateTag	string	Como o processador de extensões deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.
instanceView	MachineExtensionInstanceView	A vista da instância da extensão do computador.
protectedSettings		A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma definição protegida.
provisioningState	string	O estado de aprovisionamento, que só aparece na resposta.
publisher	string	O nome do editor do processador de extensões.
settings		Definições públicas formatadas por Json para a extensão.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do processador de scripts.

OSProfile

Especifica as definições do sistema operativo para a máquina híbrida.

Name	Tipo	Description
computerName	string	Especifica o nome do SO anfitrião da máquina híbrida.
linuxConfiguration	LinuxConfiguration	Especifica a configuração do linux para a gestão de atualizações.
windowsConfiguration	WindowsConfiguration	Especifica a configuração do Windows para a gestão de atualizações.

PatchModeTypes

Especifica o modo de patch.

Name	Tipo	Description
AutomaticByOS	string
AutomaticByPlatform	string
ImageDefault	string
Manual	string

ResourceIdentityType

O tipo de identidade.

Name	Tipo	Description
SystemAssigned	string

ServiceStatus

Descreve o estado e o comportamento de um serviço.

Name	Tipo	Description
startupType	string	O comportamento do serviço quando a máquina compatível com o Arc é iniciada.
status	string	O estado atual do serviço.

ServiceStatuses

Comunica o estado e o comportamento dos serviços dependentes.

Name	Tipo	Description
extensionService	ServiceStatus	O estado do serviço de extensão no computador compatível com o Arc.
guestConfigurationService	ServiceStatus	O estado do serviço de configuração de convidados no computador compatível com o Arc.

Status

Estado da vista de instância.

Name	Tipo	Description
code	string	O código de estado.
displayStatus	string	A etiqueta localizável curta para o estado.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.
time	string	A hora do estado.

StatusLevelTypes

O código de nível.

Name	Tipo	Description
Error	string
Info	string
Warning	string

StatusTypes

O estado do agente da máquina híbrida.

Name	Tipo	Description
Connected	string
Disconnected	string
Error	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WindowsConfiguration

Especifica a configuração do windows para a gestão de atualizações.

Name	Tipo	Description
patchSettings.assessmentMode	AssessmentModeTypes	Especifica o modo de avaliação.
patchSettings.patchMode	PatchModeTypes	Especifica o modo de patch.