Machine Run Commands - List

Serviço:: Hybrid Compute

Versão da API:: 2025-01-13

A operação para obter todos os comandos de execução de um computador que não seja do Azure.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?api-version=2025-01-13

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?$expand={$expand}&api-version=2025-01-13

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
machineName	path	True	string pattern: [a-zA-Z0-9-_\.]+	O nome do computador híbrido.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	A expressão de expansão a ser aplicada na operação.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GET all Machine Run Commands

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands?api-version=2025-01-13

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_1",
      "name": "myRunCommand_1",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 3600,
        "provisioningState": "Succeeded",
        "instanceView": {
          "executionState": "Succeeded",
          "executionMessage": "",
          "exitCode": 0,
          "output": "Hello World",
          "error": "",
          "startTime": "2023-06-15T20:48:41.4641785+00:00",
          "endTime": "2023-06-15T20:48:41.4641785+00:00"
        }
      }
    },
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_2",
      "name": "myRunCommand_2",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Get-Process | Where-Object { $_.CPU -gt 10000 }"
        },
        "parameters": [],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "userA",
        "timeoutInSeconds": 100,
        "provisioningState": "Succeeded",
        "instanceView": {
          "executionState": "Succeeded",
          "executionMessage": "",
          "exitCode": 0,
          "output": "<some output>",
          "error": "",
          "startTime": "2023-06-15T20:48:41.4641785+00:00",
          "endTime": "2023-06-15T20:48:41.4641785+00:00"
        }
      }
    }
  ]
}

Definições

Nome	Description
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
ExecutionState	Status de execução de script.
ExtensionsResourceStatus	Status da exibição da instância.
ExtensionsStatusLevelTypes	O código de nível.
MachineRunCommand	Descreve um comando Executar
MachineRunCommandInstanceView	A exibição de instância de um comando de execução de computador.
MachineRunCommandScriptSource	Descreve as fontes de script para o comando executar. Use apenas um script, scriptUri, commandId.
MachineRunCommandsListResult	Descreve o resultado da lista Executar Comandos.
RunCommandInputParameter	Descreve as propriedades de um parâmetro de comando de execução.
RunCommandManagedIdentity	Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tenha acesso ao blob de armazenamento usado no Comando Executar. Use um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados de Blob de Armazenamento" com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para blobs de acréscimo(outputBlobUri, errorBlobUri). No caso de identidade atribuída pelo usuário, adicione-a na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExecutionState

Enumeração

Status de execução de script.

Valor	Description
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

ExtensionsResourceStatus

Objeto

Status da exibição da instância.

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

ExtensionsStatusLevelTypes

Enumeração

O código de nível.

Valor	Description
Info
Warning
Error

MachineRunCommand

Objeto

Descreve um comando Executar

Nome	Tipo	Valor padrão	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 onde o recurso reside
name	string		O nome do recurso
properties.asyncExecution	boolean	False	Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		O modo de exibição da instância de comando de execução do computador.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Os parâmetros usados pelo script.
properties.protectedParameters	RunCommandInputParameter[]		Os parâmetros usados pelo script.
properties.provisioningState	string		O estado de provisionamento, que aparece apenas na resposta.
properties.runAsPassword	string		Especifica a senha da conta de usuário no computador ao executar o comando executar.
properties.runAsUser	string		Especifica a conta de usuário no computador ao executar o comando de execução.
properties.source	MachineRunCommandScriptSource		A origem do script de comando de execução.
properties.timeoutInSeconds	integer (int32)		O tempo limite em segundos para executar o comando de execução.
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

Objeto

A exibição de instância de um comando de execução de computador.

Nome	Tipo	Description
endTime	string (date-time)	Hora de término do script.
error	string	Fluxo de erros de script.
executionMessage	string	Comunique erros de configuração de script ou mensagens de execução.
executionState	ExecutionState	Status de execução de script.
exitCode	integer (int32)	Código de saída retornado da execução do script.
output	string	Fluxo de saída de script.
startTime	string (date-time)	Hora de início do script.
statuses	ExtensionsResourceStatus[]	As informações de status.

MachineRunCommandScriptSource

Objeto

Descreve as fontes de script para o comando executar. Use apenas um script, scriptUri, commandId.

Nome	Tipo	Description
commandId	string	Especifica a commandId do script interno predefinido.
script	string	Especifica o conteúdo do script a ser executado no computador.
scriptUri	string	Especifica o local de download do script. Pode ser um URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso de blob de armazenamento do Azure. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados do Blob de Armazenamento". No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

MachineRunCommandsListResult

Objeto

Descreve o resultado da lista Executar Comandos.

Nome	Tipo	Description
nextLink	string	O uri para buscar a próxima página de comandos de execução. Chame ListNext() com isso para buscar a próxima página de comandos de execução.
value	MachineRunCommand[]	A lista de comandos de execução

RunCommandInputParameter

Objeto

Descreve as propriedades de um parâmetro de comando de execução.

Nome	Tipo	Description
name	string	O nome do parâmetro de comando de execução.
value	string	O valor do parâmetro de comando de execução.

RunCommandManagedIdentity

Objeto

Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tenha acesso ao blob de armazenamento usado no Comando Executar. Use um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados de Blob de Armazenamento" com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para blobs de acréscimo(outputBlobUri, errorBlobUri). No caso de identidade atribuída pelo usuário, adicione-a na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Nome	Tipo	Description
clientId	string	ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá ser usado se isso for fornecido.
objectId	string	ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartilhar via

Machine Run Commands - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

GET all Machine Run Commands

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

MachineRunCommandsListResult

RunCommandInputParameter

RunCommandManagedIdentity

systemData