Virtual Machines - Run Command

Serviço:

Compute

Versão da API:

2021-07-01

Execute o comando na VM.

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand?api-version=2021-07-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Media Types: "application/json", "text/json"

Nome	Obrigatório	Tipo	Description
commandId	True	string	A ID do comando de execução.
parameters		RunCommandInputParameter[]	Os parâmetros de comando de execução.
script		string[]	Opcional. O script a ser executado. Quando esse valor for fornecido, o script fornecido substituirá o script padrão do comando.

Respostas

Nome	Tipo	Description
200 OK	RunCommandResult	OK Media Types: "application/json", "text/json"
202 Accepted		Aceito Media Types: "application/json", "text/json"

Segurança

azure_auth

Fluxo do 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

VirtualMachineRunCommand

Solicitação de exemplo

HTTP

HTTP

POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2021-07-01

{
  "commandId": "RunPowerShellScript"
}

Java

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.compute.models.RunCommandInput;

/** Samples for VirtualMachines RunCommand. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/runCommands/VirtualMachineRunCommand.json
     */
    /**
     * Sample code: VirtualMachineRunCommand.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineRunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachines()
            .runCommand(
                "crptestar98131", "vm3036", new RunCommandInput().withCommandId("RunPowerShellScript"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

JSON

{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "This is a sample script with parameters value1 value2"
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": ""
    }
  ]
}

Código de status:

202

Definições

Nome	Description
InstanceViewStatus	Exibição de instância status.
RunCommandInput	Capturar parâmetros da Máquina Virtual.
RunCommandInputParameter	Descreve as propriedades de um parâmetro de comando de execução.
RunCommandResult
StatusLevelTypes	O código de nível.

InstanceViewStatus

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.

RunCommandInput

Capturar parâmetros da Máquina Virtual.

Nome	Tipo	Description
commandId	string	A ID do comando de execução.
parameters	RunCommandInputParameter[]	Os parâmetros de comando de execução.
script	string[]	Opcional. O script a ser executado. Quando esse valor for fornecido, o script fornecido substituirá o script padrão do comando.

RunCommandInputParameter

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

RunCommandResult

Nome	Tipo	Description
value	InstanceViewStatus[]	Execute a resposta da operação de comando.

StatusLevelTypes

O código de nível.

Nome	Tipo	Description
Error	string
Info	string
Warning	string