Machine Run Commands - List

Referência

Service:: Hybrid Compute

API Version:: 2024-03-31-preview

A operação para obter todos os comandos de execução de uma máquina não Azure.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?api-version=2024-03-31-preview

With optional parameters:

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

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-_\.]+`
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		string	A expressão expandir a aplicar na operação.

Respostas

Name	Tipo	Description
200 OK	MachineRunCommandsListResult	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 all Machine Run Commands

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands?api-version=2024-03-31-preview

Sample Response

Status code:: 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	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ExecutionState	Estado de execução do script.
ExtensionsResourceStatus	Estado da vista de instância.
ExtensionsStatusLevelTypes	O código de nível.
MachineRunCommand	Descreve um Comando Executar
MachineRunCommandInstanceView	A vista de instância de um comando de execução de máquina.
MachineRunCommandScriptSource	Descreve as origens de script para o comando executar. Utilize apenas um script, scriptUri, commandId.
MachineRunCommandsListResult	Descreve o Resultado da Lista de Comandos executar.
RunCommandInputParameter	Descreve as propriedades de um parâmetro de comando de execução.
RunCommandManagedIdentity	Contém clientId ou objectId (utilize apenas um, não ambos) de uma identidade gerida atribuída pelo utilizador que tenha acesso ao blob de armazenamento utilizado no Comando Executar. Utilize um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo sistema. Confirme que o blob de armazenamento do Azure existe em caso de scriptUri e que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Leitor de Dados do Blob de Armazenamento" com o blob scriptUri e o "Contribuidor de Dados do Blob de Armazenamento" para blobs de Acréscimo(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.
systemData	Metadados relativos à criação e última modificação do recurso.

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ções adicionais.

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.

ExecutionState

Estado de execução do script.

Name	Tipo	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

ExtensionsResourceStatus

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

ExtensionsStatusLevelTypes

O código de nível.

Name	Tipo	Description
Error	string
Info	string
Warning	string

MachineRunCommand

Descreve um Comando Executar

Name	Tipo	Valor Predefinido	Description
id	string		ID de recurso completamente qualificado para o recurso. Por exemplo, "/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.asyncExecution	boolean	False	Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará que o script seja concluído.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		A vista de instância de comandos de execução do computador.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja 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 do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Os parâmetros utilizados pelo script.
properties.protectedParameters	RunCommandInputParameter[]		Os parâmetros utilizados pelo script.
properties.provisioningState	string		O estado de aprovisionamento, que só aparece na resposta.
properties.runAsPassword	string		Especifica a palavra-passe da conta de utilizador no computador ao executar o comando executar.
properties.runAsUser	string		Especifica a conta de utilizador no computador ao executar o comando executar.
properties.source	MachineRunCommandScriptSource		A origem do script de comandos de execução.
properties.timeoutInSeconds	integer		O tempo limite em segundos para executar o comando de execução.
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"

MachineRunCommandInstanceView

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

Name	Tipo	Description
endTime	string	Hora de fim do script.
error	string	Fluxo de erros do script.
executionMessage	string	Comunicar erros de configuração do script ou mensagens de execução.
executionState	ExecutionState	Estado de execução do script.
exitCode	integer	Código de saída devolvido da execução do script.
output	string	Fluxo de saída do script.
startTime	string	Hora de início do script.
statuses	ExtensionsResourceStatus[]	As informações de estado.

MachineRunCommandScriptSource

Descreve as origens de script para o comando executar. Utilize apenas um script, scriptUri, commandId.

Name	Tipo	Description
commandId	string	Especifica o commandId do script incorporado predefinido.
script	string	Especifica o conteúdo do script a ser executado no computador.
scriptUri	string	Especifica a localização de transferência do script. Pode ser o URI de SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identidade gerida atribuída pelo utilizador que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que o blob de armazenamento do Azure existe e que a identidade gerida tem acesso ao contentor do blob com a atribuição da função "Leitor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

MachineRunCommandsListResult

Descreve o Resultado da Lista de Comandos executar.

Name	Tipo	Description
nextLink	string	O URI para obter a página seguinte dos comandos de execução. Chame ListNext() para obter a página seguinte dos comandos de execução.
value	MachineRunCommand[]	A lista de comandos de execução

RunCommandInputParameter

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

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

RunCommandManagedIdentity

Contém clientId ou objectId (utilize apenas um, não ambos) de uma identidade gerida atribuída pelo utilizador que tenha acesso ao blob de armazenamento utilizado no Comando Executar. Utilize um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo sistema. Confirme que o blob de armazenamento do Azure existe em caso de scriptUri e que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Leitor de Dados do Blob de Armazenamento" com o blob scriptUri e o "Contribuidor de Dados do Blob de Armazenamento" para blobs de Acréscimo(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Name	Tipo	Description
clientId	string	ID de cliente (valor GUID) da identidade gerida atribuída pelo utilizador. ObjectId não deve ser utilizado se for fornecido.
objectId	string	ID do objeto (valor GUID) da identidade gerida atribuída pelo utilizador. ClientId não deve ser utilizado se for fornecido.

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.

Partilhar via