Sdílet prostřednictvím

Virtual Machine Scale Set VM Run Commands - Get

  • Reference
Služba:
Compute
Verze rozhraní API:
2024-07-01

Operace získání příkazu spuštění virtuálního počítače VMSS.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2024-07-01
S volitelnými parametry: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2024-07-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
instanceId
 path True

string

ID instance virtuálního počítače.
resourceGroupName
 path True

string

Název skupiny prostředků.
runCommandName
 path True

string

Název příkazu spuštění virtuálního počítače.
subscriptionId
 path True

string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vmScaleSetName
 path True

string

Název škálovací sady virtuálních počítačů
api-version
 query True

string

Verze rozhraní API klienta.
$expand
 query

string

Výraz rozbalení, který se má použít pro operaci.

Odpovědi

Name Typ Description
200 OK

VirtualMachineRunCommand

OK

Media Types: "application/json", "text/json"
Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

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

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get VirtualMachineScaleSet VM run commands.

Ukázkový požadavek

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand?api-version=2024-07-01

Ukázková odpověď

Stavový kód:
200 
{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "scriptUri": "https://gist.githubusercontent.com/myusername/75fd3634w7511116063c60bcc50bee0/raw/04a4c68ac9e1d36asfasdc64bd1d889b104c7abdb8/HelloWorld.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definice

Name Description
ApiError

Chyba rozhraní API
ApiErrorBase

Základ chyb rozhraní API.
CloudError

Odpověď na chybu z výpočetní služby
ExecutionState

Stav spuštění skriptu.
InnerError

Podrobnosti vnitřní chyby.
InstanceViewStatus

Stav zobrazení instance
RunCommandInputParameter

Popisuje vlastnosti parametru příkazu run.
RunCommandManagedIdentity

Obsahuje clientId nebo objectId (použijte pouze jednu, ne obě) spravované identity přiřazené uživatelem, která má přístup k objektu blob úložiště používanému v příkazu Spustit. V případě identity přiřazené systémem použijte prázdný objekt RunCommandManagedIdentity. Ujistěte se, že objekt blob úložiště Azure existuje v případě scriptUri a spravovaná identita má udělený přístup ke kontejneru objektů blob s přiřazením role Čtenář dat objektů blob služby Storage s objekty blob scriptUri a Přispěvatelem dat objektů blob úložiště pro doplňovací objekty blob (outputBlobUri, errorBlobUri). V případě identity přiřazené uživatelem se ujistěte, že ji přidáte pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.
StatusLevelTypes

Kód úrovně.
VirtualMachineRunCommand

Popisuje příkaz spuštění virtuálního počítače.
VirtualMachineRunCommandInstanceView

Zobrazení instance příkazu spuštění virtuálního počítače.
VirtualMachineRunCommandScriptSource

Popisuje zdroje skriptů pro příkaz spustit. Použijte pouze jeden skript, scriptUri, commandId.

ApiError

Chyba rozhraní API

Name Typ Description
code

string

Kód chyby.
details

ApiErrorBase[]

Podrobnosti o chybě rozhraní API
innererror

InnerError

Vnitřní chyba rozhraní API
message

string

Chybová zpráva.
target

string

Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name Typ Description
code

string

Kód chyby.
message

string

Chybová zpráva.
target

string

Cíl konkrétní chyby.

CloudError

Odpověď na chybu z výpočetní služby

Name Typ Description
error

ApiError

Chyba rozhraní API

ExecutionState

Stav spuštění skriptu.

Name Typ Description
Canceled

string

Failed

string

Pending

string

Running

string

Succeeded

string

TimedOut

string

Unknown

string

InnerError

Podrobnosti vnitřní chyby.

Name Typ Description
errordetail

string

Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype

string

Typ výjimky.

InstanceViewStatus

Stav zobrazení instance

Name Typ Description
code

string

Stavový kód.
displayStatus

string

Krátký lokalizovatelný popisek stavu.
level

StatusLevelTypes

Kód úrovně.
message

string

Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time

string

Čas stavu.

RunCommandInputParameter

Popisuje vlastnosti parametru příkazu run.

Name Typ Description
name

string

Název parametru příkazu run.
value

string

Hodnota parametru příkazu run.

RunCommandManagedIdentity

Obsahuje clientId nebo objectId (použijte pouze jednu, ne obě) spravované identity přiřazené uživatelem, která má přístup k objektu blob úložiště používanému v příkazu Spustit. V případě identity přiřazené systémem použijte prázdný objekt RunCommandManagedIdentity. Ujistěte se, že objekt blob úložiště Azure existuje v případě scriptUri a spravovaná identita má udělený přístup ke kontejneru objektů blob s přiřazením role Čtenář dat objektů blob služby Storage s objekty blob scriptUri a Přispěvatelem dat objektů blob úložiště pro doplňovací objekty blob (outputBlobUri, errorBlobUri). V případě identity přiřazené uživatelem se ujistěte, že ji přidáte pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.

Name Typ Description
clientId

string

ID klienta (hodnota GUID) spravované identity přiřazené uživatelem Id objektu by se nemělo používat, pokud je k dispozici.
objectId

string

ID objektu (hodnota GUID) spravované identity přiřazené uživatelem Id klienta by se nemělo používat, pokud je k dispozici.

StatusLevelTypes

Kód úrovně.

Name Typ Description
Error

string

Info

string

Warning

string

VirtualMachineRunCommand

Popisuje příkaz spuštění virtuálního počítače.

Name Typ Default value Description
id

string

ID prostředku
location

string

Umístění prostředku
name

string

Název prostředku
properties.asyncExecution

boolean

False

Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu.
properties.errorBlobManagedIdentity

RunCommandManagedIdentity

Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.errorBlobUri

string

Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity.
properties.instanceView

VirtualMachineRunCommandInstanceView

Virtuální počítač spustí zobrazení instance příkazu.
properties.outputBlobManagedIdentity

RunCommandManagedIdentity

Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.outputBlobUri

string

Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity.
properties.parameters

RunCommandInputParameter[]

Parametry používané skriptem.
properties.protectedParameters

RunCommandInputParameter[]

Parametry používané skriptem.
properties.provisioningState

string

Stav zřizování, který se zobrazí pouze v odpovědi. Pokud je léčbaFailureAsDeploymentFailure nastavená na hodnotu true, selhání skriptu selže při nasazení a provisioningState se označí jako Neúspěšné. Pokud je zacházíFailureAsDeploymentFailure nastavená na false, provisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn nebo ne platformou rozšíření, neznačí, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword

string

Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run.
properties.runAsUser

string

Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit.
properties.source

VirtualMachineRunCommandScriptSource

Zdroj skriptu příkazu run.
properties.timeoutInSeconds

integer

Časový limit v sekundách pro spuštění příkazu.
properties.treatFailureAsDeploymentFailure

boolean

False

Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags

object

Značky prostředků
type

string

Typ prostředku

VirtualMachineRunCommandInstanceView

Zobrazení instance příkazu spuštění virtuálního počítače.

Name Typ Description
endTime

string

Čas ukončení skriptu.
error

string

Stream chyb skriptu
executionMessage

string

Komunikujte s chybami konfigurace skriptu nebo zprávami o spuštění.
executionState

ExecutionState

Stav spuštění skriptu.
exitCode

integer

Ukončete kód vrácený ze spuštění skriptu.
output

string

Výstupní datový proud skriptu
startTime

string

Čas spuštění skriptu.
statuses

InstanceViewStatus[]

Informace o stavu zdroje

VirtualMachineRunCommandScriptSource

Popisuje zdroje skriptů pro příkaz spustit. Použijte pouze jeden skript, scriptUri, commandId.

Name Typ Description
commandId

string

Určuje commandId předdefinovaného předdefinovaného skriptu.
script

string

Určuje obsah skriptu, který se má na virtuálním počítači spustit.
scriptUri

string

Určuje umístění stahování skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení nebo veřejným identifikátorem URI.
scriptUriManagedIdentity

RunCommandManagedIdentity

Spravovaná identita přiřazená uživatelem, která má přístup k identifikátoru scriptUri v případě objektu blob úložiště Azure. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že objekt blob úložiště Azure existuje, a spravovaná identita má udělený přístup k kontejneru objektu blob s přiřazením role Čtenář dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.