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 uma máquina 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 do URI

Name	Em	Necessário	Tipo	Description
machineName	path	True	string pattern: [a-zA-Z0-9-_\.]+	O nome da máquina híbrida.
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 expand a ser aplicada na operação.

Respostas

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

GET all Machine Run Commands

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExecutionState	Status de execução do 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 máquina.
MachineRunCommandScriptSource	Descreve as fontes de script para o comando run. Use apenas um dos scripts, 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 tem acesso ao blob de armazenamento usado em Executar comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída ao 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 'Storage Blob Data Reader' com scriptUri blob e 'Storage Blob Data Contributor' para Append blobs(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, certifique-se de adicioná-la sob a 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 referentes à 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

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExecutionState

Enumeração

Status de execução do script.

Valor	Description
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

ExtensionsResourceStatus

Object

Status da exibição da instância.

Name	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo curto localizável 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

Object

Descreve um comando Executar

Name	Tipo	Default value	Description
id	string		ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		A geolocalização onde o recurso vive
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 sob a 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 onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		A exibição da instância do comando de execução da máquina.
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 sob a 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 onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso 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 só aparece na resposta.
properties.runAsPassword	string		Especifica a senha da conta de usuário na máquina ao executar o comando run.
properties.runAsUser	string		Especifica a conta de usuário na máquina ao executar o comando run.
properties.source	MachineRunCommandScriptSource		A origem do script de comando run.
properties.timeoutInSeconds	integer (int32)		O tempo limite em segundos para executar o comando run.
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

Object

A exibição de instância de um comando de execução de máquina.

Name	Tipo	Description
endTime	string (date-time)	Hora de término do script.
error	string	Fluxo de erro de script.
executionMessage	string	Comunique erros de configuração de script ou mensagens de execução.
executionState	ExecutionState	Status de execução do 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

Object

Descreve as fontes de script para o comando run. Use apenas um dos scripts, scriptUri, commandId.

Name	Tipo	Description
commandId	string	Especifica o commandId do script interno predefinido.
script	string	Especifica o conteúdo do script a ser executado na máquina.
scriptUri	string	Especifica o local de download do script. Pode ser 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 de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a 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

Object

Descreve o resultado da lista Executar comandos.

Name	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

Object

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

Name	Tipo	Description
name	string	O nome do parâmetro do comando run.
value	string	O valor do parâmetro run command.

RunCommandManagedIdentity

Object

Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento usado em Executar comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída ao 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 'Storage Blob Data Reader' com scriptUri blob e 'Storage Blob Data Contributor' para Append blobs(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Name	Tipo	Description
clientId	string	ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deve 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

Object

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

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

Partilhar via

Machine Run Commands - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

GET all Machine Run Commands

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

MachineRunCommandsListResult

RunCommandInputParameter

RunCommandManagedIdentity

systemData