Virtual Machine Run Commands - Create Or Update

Operacja tworzenia lub aktualizowania polecenia Run.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}?api-version=2020-12-01

Parametry identyfikatora URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nazwa grupy zasobów.

runCommandName
path True
  • string

Nazwa polecenia Uruchom maszynę wirtualną.

subscriptionId
path True
  • string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

vmName
path True
  • string

Nazwa maszyny wirtualnej, w której ma zostać utworzone lub zaktualizowane polecenie Run.

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

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

Name Required Type Description
location True
  • string

Lokalizacja zasobu

properties.asyncExecution
  • boolean

Opcjonalny. Jeśli ustawiono wartość true, Inicjowanie obsługi zostanie zakończone zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.

properties.errorBlobUri
  • string

Określa obiekt BLOB usługi Azure Storage, do którego zostanie przekazany strumień błędów skryptu.

properties.outputBlobUri
  • string

Określa obiekt BLOB usługi Azure Storage, do którego zostanie przekazany strumień wyjściowy skryptu.

properties.parameters

Parametry używane przez skrypt.

properties.protectedParameters

Parametry używane przez skrypt.

properties.runAsPassword
  • string

Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia Uruchom.

properties.runAsUser
  • string

Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia Uruchom.

properties.source

Źródło skryptu polecenia uruchomieniowego.

properties.timeoutInSeconds
  • integer

Limit czasu (w sekundach) wykonywania polecenia Run.

tags
  • object

Tagi zasobów

Odpowiedzi

Name Type Description
200 OK

OK

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

201 Created

Utworzone

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

Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

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

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Create or update a run command.

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand?api-version=2020-12-01
{
  "location": "West US",
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600
  }
}

Sample Response

{
  "name": "myRunCommand",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded"
  }
}
{
  "name": "myRunCommand",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Creating"
  }
}

Definicje

ApiError

Błąd interfejsu API.

ApiErrorBase

Baza błędów interfejsu API.

CloudError

Odpowiedź na błąd z usługi obliczeniowej.

ExecutionState

Stan wykonywania skryptu.

InnerError

Szczegóły błędu wewnętrznego.

InstanceViewStatus

Stan widoku wystąpienia.

RunCommandInputParameter

Opisuje właściwości parametru polecenia uruchomieniowego.

StatusLevelTypes

Kod poziomu.

VirtualMachineRunCommand

Opisuje polecenie uruchomienia maszyny wirtualnej.

VirtualMachineRunCommandInstanceView

Widok wystąpienia polecenia maszyny wirtualnej.

VirtualMachineRunCommandScriptSource

Opisuje źródła skryptów dla polecenia Uruchom.

ApiError

Błąd interfejsu API.

Name Type Description
code
  • string

Kod błędu.

details

Szczegóły błędu interfejsu API

innererror

Wewnętrzny błąd interfejsu API

message
  • string

Komunikat o błędzie.

target
  • string

Obiekt docelowy konkretnego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Obiekt docelowy konkretnego błędu.

CloudError

Odpowiedź na błąd z usługi obliczeniowej.

Name Type Description
error

Błąd interfejsu API.

ExecutionState

Stan wykonywania skryptu.

Name Type Description
Canceled
  • string
Failed
  • string
Pending
  • string
Running
  • string
Succeeded
  • string
TimedOut
  • string
Unknown
  • string

InnerError

Szczegóły błędu wewnętrznego.

Name Type Description
errordetail
  • string

Wewnętrzny komunikat o błędzie lub zrzut wyjątku.

exceptiontype
  • string

Typ wyjątku.

InstanceViewStatus

Stan widoku wystąpienia.

Name Type Description
code
  • string

Kod stanu.

displayStatus
  • string

Krótka lokalizowalna etykieta dla stanu.

level

Kod poziomu.

message
  • string

Szczegółowy komunikat o stanie, w tym dotyczące alertów i komunikatów o błędach.

time
  • string

Godzina stanu.

RunCommandInputParameter

Opisuje właściwości parametru polecenia uruchomieniowego.

Name Type Description
name
  • string

Nazwa parametru polecenia uruchomieniowego.

value
  • string

Wartość parametru Run polecenia.

StatusLevelTypes

Kod poziomu.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

VirtualMachineRunCommand

Opisuje polecenie uruchomienia maszyny wirtualnej.

Name Type Description
id
  • string

Identyfikator zasobu

location
  • string

Lokalizacja zasobu

name
  • string

Nazwa zasobu

properties.asyncExecution
  • boolean

Opcjonalny. Jeśli ustawiono wartość true, Inicjowanie obsługi zostanie zakończone zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.

properties.errorBlobUri
  • string

Określa obiekt BLOB usługi Azure Storage, do którego zostanie przekazany strumień błędów skryptu.

properties.instanceView

Widok wystąpienia polecenia Uruchom maszynę wirtualną.

properties.outputBlobUri
  • string

Określa obiekt BLOB usługi Azure Storage, do którego zostanie przekazany strumień wyjściowy skryptu.

properties.parameters

Parametry używane przez skrypt.

properties.protectedParameters

Parametry używane przez skrypt.

properties.provisioningState
  • string

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

properties.runAsPassword
  • string

Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia Uruchom.

properties.runAsUser
  • string

Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia Uruchom.

properties.source

Źródło skryptu polecenia uruchomieniowego.

properties.timeoutInSeconds
  • integer

Limit czasu (w sekundach) wykonywania polecenia Run.

tags
  • object

Tagi zasobów

type
  • string

Typ zasobu

VirtualMachineRunCommandInstanceView

Widok wystąpienia polecenia maszyny wirtualnej.

Name Type Description
endTime
  • string

Czas zakończenia skryptu.

error
  • string

Strumień błędu skryptu.

executionMessage
  • string

Komunikacja z błędami lub komunikatami o wykonywaniu skryptu.

executionState

Stan wykonywania skryptu.

exitCode
  • integer

Kod wyjścia zwrócony przez wykonanie skryptu.

output
  • string

Strumień wyjściowy skryptu.

startTime
  • string

Godzina rozpoczęcia skryptu.

statuses

Informacje o stanie zasobu.

VirtualMachineRunCommandScriptSource

Opisuje źródła skryptów dla polecenia Uruchom.

Name Type Description
commandId
  • string

Określa commandId wstępnie zdefiniowanego skryptu wbudowanego.

script
  • string

Określa zawartość skryptu do wykonania na maszynie wirtualnej.

scriptUri
  • string

Określa lokalizację pobierania skryptu.