Virtual Machines - Run Command
Execute o comando na VM.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand?api-version=2024-03-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. |
subscription
|
path | True |
string |
Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
vm
|
path | True |
string |
O nome da máquina virtual. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
Corpo do Pedido
Media Types: "application/json", "text/json"
Name | Necessário | Tipo | Description |
---|---|---|---|
commandId | True |
string |
O ID de comando de execução. |
parameters |
Os parâmetros de comando de execução. |
||
script |
string[] |
Opcional. O script a ser executado. Quando este valor é fornecido, o script especificado substituirá o script predefinido do comando. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK Media Types: "application/json", "text/json" |
|
202 Accepted |
Aceite Media Types: "application/json", "text/json" |
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
VirtualMachineRunCommand
Sample Request
POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2024-03-01
{
"commandId": "RunPowerShellScript"
}
Sample Response
{
"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": ""
}
]
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01
Definições
Name | Description |
---|---|
Instance |
Estado da vista de instância. |
Run |
Capturar parâmetros da Máquina Virtual. |
Run |
Descreve as propriedades de um parâmetro de comando de execução. |
Run |
|
Status |
O código de nível. |
InstanceViewStatus
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 |
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. |
RunCommandInput
Capturar parâmetros da Máquina Virtual.
Name | Tipo | Description |
---|---|---|
commandId |
string |
O ID de comando de execução. |
parameters |
Os parâmetros de comando de execução. |
|
script |
string[] |
Opcional. O script a ser executado. Quando este valor é fornecido, o script especificado substituirá o script predefinido do comando. |
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 de execução. |
RunCommandResult
Name | Tipo | Description |
---|---|---|
value |
Execute a resposta da operação de comando. |
StatusLevelTypes
O código de nível.
Name | Tipo | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |