Machines - List By Subscription

Referência

Service:: Hybrid Compute

API Version:: 2022-12-27

Listas todos os computadores híbridos na assinatura especificada. Use a propriedade nextLink na resposta para obter a próxima página de computadores híbridos.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines?api-version=2022-12-27

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	MachineListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List Machines by resource group

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.HybridCompute/machines?api-version=2022-12-27

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_ListBySubscription.json
// this example is just showing the usage of "Machines_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (HybridComputeMachineResource item in subscriptionResource.GetHybridComputeMachinesAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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"
        },
        "clientPublicKey": "string",
        "parentClusterResourceId": null,
        "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"
        },
        "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"
      }
    },
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2",
      "name": "myMachine2",
      "location": "westus2",
      "tags": null,
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f",
        "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f"
      },
      "type": "Microsoft.HybridCompute/machines",
      "properties": {
        "provisioningState": "Succeeded",
        "agentVersion": null,
        "status": null,
        "lastStatusChange": null,
        "errorDetails": null,
        "displayName": null,
        "machineFqdn": null,
        "osVersion": null,
        "osType": null,
        "osProfile": {
          "computerName": null,
          "windowsConfiguration": {
            "patchSettings": {
              "assessmentMode": null,
              "patchMode": null
            }
          },
          "linuxConfiguration": {
            "patchSettings": {
              "assessmentMode": null,
              "patchMode": null
            }
          }
        },
        "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f",
        "locationData": {
          "name": "Redmond"
        },
        "clientPublicKey": "string",
        "parentClusterResourceId": "{AzureStackHCIResourceId}",
        "mssqlDiscovered": "true",
        "detectedProperties": {
          "cloudprovider": "N/A",
          "manufacturer": "Microsoft Corporation",
          "model": "Surfacebook"
        },
        "agentConfiguration": {
          "proxyUrl": "https://test.test",
          "incomingConnectionsPorts": [
            "22",
            "23"
          ],
          "extensionsAllowList": null,
          "extensionsBlockList": null,
          "proxyBypass": [
            "proxy1",
            "proxy2"
          ],
          "extensionsEnabled": "true",
          "guestConfigurationEnabled": "true",
          "configMode": "full"
        }
      }
    }
  ],
  "nextLink": "string"
}

Definições

Nome	Description
agent configuration mode	Nome do modo de configuração a ser usado. Os modos são configurações predefinidas de controles de segurança, listas de permitidos de extensão e configuração de convidado, mantidas pela Microsoft.
AgentConfiguration	Propriedades configuráveis que o usuário pode definir localmente por meio do comando de configuração azcmagent ou remotamente por meio do ARM.
AgentUpgrade	As informações w.r.t Agent Upgrade.
AssessmentModeTypes	Especifica o modo de avaliação.
CloudMetadata	Os metadados do ambiente de nuvem (Azure/GCP/AWS/OCI...).
ConfigurationExtension	Descreve as propriedades que podem identificar extensões.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
LastAttemptStatusEnum	Especifica o status da Atualização do Agente.
LinuxConfiguration	Especifica a configuração do Linux para gerenciamento de atualizações.
locationData	Metadados relativos à localização geográfica do recurso.
Machine	Descreve um computador híbrido.
MachineExtension	Descreve uma extensão de computador.
MachineExtensionInstanceView	Descreve a Exibição da Instância de Extensão do Computador.
MachineExtensionProperties	Descreve as propriedades de uma extensão de computador.
MachineListResult	A resposta de operação da máquina híbrida de lista.
OSProfile	Especifica as configurações do sistema operacional para o computador híbrido.
PatchModeTypes	Especifica o modo de patch.
ResourceIdentityType	O tipo de identidade.
ServiceStatus	Descreve o status e o comportamento de um serviço.
ServiceStatuses	Relata o estado e o comportamento dos serviços dependentes.
Status	Exibição de instância status.
StatusLevelTypes	O código de nível.
StatusTypes	O status do agente de computador híbrido.
systemData	Metadados relativos à criação e à última modificação do recurso.
WindowsConfiguration	Especifica a configuração do Windows para gerenciamento de atualizações.

agent configuration mode

Nome do modo de configuração a ser usado. Os modos são configurações predefinidas de controles de segurança, listas de permitidos de extensão e configuração de convidado, mantidas pela Microsoft.

Nome	Tipo	Description
full	string
monitor	string

AgentConfiguration

Propriedades configuráveis que o usuário pode definir localmente por meio do comando de configuração azcmagent ou remotamente por meio do ARM.

Nome	Tipo	Description
configMode	agent configuration mode	Nome do modo de configuração a ser usado. Os modos são configurações predefinidas de controles 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 têm permissão para serem instaladas ou atualizadas.
extensionsBlockList	ConfigurationExtension[]	Matriz de extensões bloqueadas (não podem ser instaladas ou atualizadas)
extensionsEnabled	string	Especifica se o serviço de extensão está habilitado ou desabilitado.
guestConfigurationEnabled	string	Especificado se o serviço de configuração de convidado está habilitado ou desabilitado.
incomingConnectionsPorts	string[]	Especifica a lista de portas em que o agente poderá escutar.
proxyBypass	string[]	Lista de nomes de serviço que não devem usar o servidor proxy especificado.
proxyUrl	string	Especifica a URL do proxy a ser usado.

AgentUpgrade

As informações w.r.t Agent Upgrade.

Nome	Tipo	Description
correlationId	string	A ID de correlação passada do RSM por atualização.
desiredVersion	string	Especifica as informações de 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 houver.
lastAttemptStatus	LastAttemptStatusEnum	Especifica o status de Atualização do Agente.
lastAttemptTimestamp	string	Carimbo de data/hora da última tentativa de atualização

AssessmentModeTypes

Especifica o modo de avaliação.

Nome	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

CloudMetadata

Os metadados do ambiente de nuvem (Azure/GCP/AWS/OCI...).

Nome	Tipo	Description
provider	string	Especifica o provedor de nuvem (Azure/AWS/GCP...).

ConfigurationExtension

Descreve as propriedades que podem identificar extensões.

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

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Identidade do recurso.

Nome	Tipo	Description
principalId	string	A ID principal da identidade do recurso.
tenantId	string	A ID do locatário do recurso.
type	ResourceIdentityType	O tipo de identidade.

LastAttemptStatusEnum

Especifica o status da Atualização do Agente.

Nome	Tipo	Description
Failed	string
Success	string

LinuxConfiguration

Especifica a configuração do Linux para gerenciamento de atualizações.

Nome	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.

Nome	Tipo	Description
city	string	A cidade ou localidade em que o recurso está localizado.
countryOrRegion	string	O país ou região em que 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 um computador híbrido.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidade do recurso.
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.adFqdn	string	Especifica o nome de exibição totalmente qualificado do AD.
properties.agentConfiguration	AgentConfiguration	Propriedades configuráveis que o usuário pode definir localmente por meio do comando de configuração azcmagent ou remotamente por meio do ARM.
properties.agentUpgrade	AgentUpgrade	As informações do computador w.r.t Agent Upgrade
properties.agentVersion	string	A versão completa do agente de computador híbrido.
properties.clientPublicKey	string	Chave pública que o cliente fornece para ser usada durante a integração inicial de recursos
properties.cloudMetadata	CloudMetadata	Os metadados do ambiente de nuvem (Azure/GCP/AWS/OCI...).
properties.detectedProperties	object	Propriedades detectadas do computador.
properties.displayName	string	Especifica o nome de exibição do computador híbrido.
properties.dnsFqdn	string	Especifica o nome de exibição totalmente 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 sobre extensões de computador (campo preterido)
properties.lastStatusChange	string	A hora da última alteração status.
properties.locationData	locationData	Metadados relativos à localização geográfica do recurso.
properties.machineFqdn	string	Especifica o FQDN do computador híbrido.
properties.mssqlDiscovered	string	Especifica se alguma instância do MS SQL é descoberta no computador.
properties.osName	string	O sistema operacional em execução no computador híbrido.
properties.osProfile	OSProfile	Especifica as configurações do sistema operacional para o computador híbrido.
properties.osSku	string	Especifica o SKU do produto do sistema operacional.
properties.osType	string	O tipo de Sistema Operacional (windows/linux).
properties.osVersion	string	A versão do sistema operacional em execução no computador híbrido.
properties.parentClusterResourceId	string	A ID do recurso do cluster pai (Azure HCI) ao qual esse computador é atribuído, se houver.
properties.privateLinkScopeResourceId	string	A ID do recurso do escopo do link privado ao qual este computador é atribuído, se houver.
properties.provisioningState	string	O estado de provisionamento, que aparece apenas na resposta.
properties.serviceStatuses	ServiceStatuses	Status de serviços dependentes que são relatados de volta ao ARM.
properties.status	StatusTypes	O status do agente de computador híbrido.
properties.vmId	string	Especifica a ID exclusiva do computador híbrido.
properties.vmUuid	string	Especifica a ID SMBIOS exclusiva do Computador Arc
resources	MachineExtension[]	A lista de extensões afiliadas ao computador
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineExtension

Descreve uma extensão de computador.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties	MachineExtensionProperties	Descreve as propriedades da extensão do computador.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineExtensionInstanceView

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

Nome	Tipo	Description
name	string	O nome da extensão do computador.
status	Status	Exibição de instância status.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de script.

MachineExtensionProperties

Descreve as propriedades de uma extensão de computador.

Nome	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira.
enableAutomaticUpgrade	boolean	Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente disponível.
forceUpdateTag	string	Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.
instanceView	MachineExtensionInstanceView	A exibição da instância de extensão do computador.
protectedSettings		A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.
provisioningState	string	O estado de provisionamento, que aparece apenas na resposta.
publisher	string	O nome do editor do manipulador de extensão.
settings		Configurações públicas formatadas em Json para a extensão.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de script.

MachineListResult

A resposta de operação da máquina híbrida de lista.

Nome	Tipo	Description
nextLink	string	O URI para buscar a próxima página de Computadores. Chame ListNext() com esse URI para buscar a próxima página de computadores híbridos.
value	Machine[]	A lista de computadores híbridos.

OSProfile

Especifica as configurações do sistema operacional para o computador híbrido.

Nome	Tipo	Description
computerName	string	Especifica o nome do sistema operacional host do computador híbrido.
linuxConfiguration	LinuxConfiguration	Especifica a configuração do Linux para gerenciamento de atualizações.
windowsConfiguration	WindowsConfiguration	Especifica a configuração do Windows para o gerenciamento de atualizações.

PatchModeTypes

Especifica o modo de patch.

Nome	Tipo	Description
AutomaticByOS	string
AutomaticByPlatform	string
ImageDefault	string
Manual	string

ResourceIdentityType

O tipo de identidade.

Nome	Tipo	Description
SystemAssigned	string

ServiceStatus

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

Nome	Tipo	Description
startupType	string	O comportamento do serviço quando o computador habilitado para Arc é iniciado.
status	string	O status atual do serviço.

ServiceStatuses

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

Nome	Tipo	Description
extensionService	ServiceStatus	O estado do serviço de extensão no computador habilitado para Arc.
guestConfigurationService	ServiceStatus	O estado do serviço de configuração de convidado no computador habilitado para Arc.

Status

Exibição de instância status.

Nome	Tipo	Description
code	string	O código do status.
displayStatus	string	O rótulo localizável curto para o status.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time	string	A hora da status.

StatusLevelTypes

O código de nível.

Nome	Tipo	Description
Error	string
Info	string
Warning	string

StatusTypes

O status do agente de computador híbrido.

Nome	Tipo	Description
Connected	string
Disconnected	string
Error	string

systemData

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

Nome	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 gerenciamento de atualizações.

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