Virtual Machine Scale Set VM Run Commands - Get
Operacja pobierania polecenia uruchomienia maszyny wirtualnej zestawu skalowania maszyn wirtualnych.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2024-07-01
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 identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
instance
|
path | True |
string |
Identyfikator wystąpienia maszyny wirtualnej. |
resource
|
path | True |
string |
Nazwa grupy zasobów. |
run
|
path | True |
string |
Nazwa polecenia uruchomienia maszyny wirtualnej. |
subscription
|
path | True |
string |
Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi. |
vm
|
path | True |
string |
Nazwa zestawu skalowania maszyn wirtualnych. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
$expand
|
query |
string |
Wyrażenie expand, które ma być stosowane w operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK Media Types: "application/json", "text/json" |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. Media Types: "application/json", "text/json" |
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Get VirtualMachineScaleSet VM run commands.
Przykładowe żądanie
Przykładowa odpowiedź
{
"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"
}
}
Definicje
Nazwa | Opis |
---|---|
Api |
Błąd interfejsu API. |
Api |
Baza błędów interfejsu API. |
Cloud |
Odpowiedź na błąd z usługi Obliczeniowej. |
Execution |
Stan wykonywania skryptu. |
Inner |
Szczegóły błędu wewnętrznego. |
Instance |
Stan widoku wystąpienia. |
Run |
Opisuje właściwości parametru polecenia uruchamiania. |
Run |
Zawiera identyfikator clientId lub objectId (użyj tylko jednego, a nie obu) tożsamości zarządzanej przypisanej przez użytkownika, która ma dostęp do obiektu blob magazynu używanego w poleceniu uruchamiania. Użyj pustego obiektu RunCommandManagedIdentity w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje w przypadku identyfikatora scriptUri, a tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage" z przypisaniem roli scriptUri blob i "Współautor danych obiektu blob usługi Storage" dla uzupełnialnych obiektów blob (outputBlobUri, errorBlobUri). W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged. |
Status |
Kod poziomu. |
Virtual |
Opisuje polecenie uruchamiania maszyny wirtualnej. |
Virtual |
Widok wystąpienia polecenia uruchomienia maszyny wirtualnej. |
Virtual |
Opisuje źródła skryptów dla polecenia uruchamiania. Użyj tylko jednego skryptu, scriptUri, commandId. |
ApiError
Błąd interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
Szczegóły błędu interfejsu API |
|
innererror |
Błąd wewnętrzny interfejsu API |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy określonego błędu. |
ApiErrorBase
Baza błędów interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy określonego błędu. |
CloudError
Odpowiedź na błąd z usługi Obliczeniowej.
Nazwa | Typ | Opis |
---|---|---|
error |
Błąd interfejsu API. |
ExecutionState
Stan wykonywania skryptu.
Nazwa | Typ | Opis |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
Pending |
string |
|
Running |
string |
|
Succeeded |
string |
|
TimedOut |
string |
|
Unknown |
string |
InnerError
Szczegóły błędu wewnętrznego.
Nazwa | Typ | Opis |
---|---|---|
errordetail |
string |
Wewnętrzny komunikat o błędzie lub zrzut wyjątku. |
exceptiontype |
string |
Typ wyjątku. |
InstanceViewStatus
Stan widoku wystąpienia.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod stanu. |
displayStatus |
string |
Krótka etykieta lokalizowalna dla stanu. |
level |
Kod poziomu. |
|
message |
string |
Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach. |
time |
string |
Czas stanu. |
RunCommandInputParameter
Opisuje właściwości parametru polecenia uruchamiania.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa parametru polecenia uruchamiania. |
value |
string |
Wartość parametru polecenia uruchomienia. |
RunCommandManagedIdentity
Zawiera identyfikator clientId lub objectId (użyj tylko jednego, a nie obu) tożsamości zarządzanej przypisanej przez użytkownika, która ma dostęp do obiektu blob magazynu używanego w poleceniu uruchamiania. Użyj pustego obiektu RunCommandManagedIdentity w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje w przypadku identyfikatora scriptUri, a tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage" z przypisaniem roli scriptUri blob i "Współautor danych obiektu blob usługi Storage" dla uzupełnialnych obiektów blob (outputBlobUri, errorBlobUri). W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged.
Nazwa | Typ | Opis |
---|---|---|
clientId |
string |
Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane. |
objectId |
string |
Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId. |
StatusLevelTypes
Kod poziomu.
Nazwa | Typ | Opis |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
VirtualMachineRunCommand
Opisuje polecenie uruchamiania maszyny wirtualnej.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
id |
string |
Identyfikator zasobu |
|
location |
string |
Lokalizacja zasobu |
|
name |
string |
Nazwa zasobu |
|
properties.asyncExecution |
boolean |
False |
Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. |
properties.errorBlobManagedIdentity |
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged |
||
properties.errorBlobUri |
string |
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. |
|
properties.instanceView |
Widok wystąpienia polecenia uruchamiania maszyny wirtualnej. |
||
properties.outputBlobManagedIdentity |
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged |
||
properties.outputBlobUri |
string |
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. |
|
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. Jeśli parametr treatFailureAsDeploymentFailure ma wartość true, wszystkie błędy w skrypcie nie powiedzą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli parametr treatFailureAsDeploymentFailure ma wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
|
properties.runAsPassword |
string |
Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. |
|
properties.runAsUser |
string |
Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. |
|
properties.source |
Źródło skryptu polecenia uruchamiania. |
||
properties.timeoutInSeconds |
integer |
Limit czasu w sekundach do wykonania polecenia uruchomienia. |
|
properties.treatFailureAsDeploymentFailure |
boolean |
False |
Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
tags |
object |
Tagi zasobów |
|
type |
string |
Typ zasobu |
VirtualMachineRunCommandInstanceView
Widok wystąpienia polecenia uruchomienia maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
endTime |
string |
Godzina zakończenia skryptu. |
error |
string |
Strumień błędów skryptu. |
executionMessage |
string |
Przekazywanie błędów konfiguracji skryptu lub komunikatów wykonywania. |
executionState |
Stan wykonywania skryptu. |
|
exitCode |
integer |
Kod zakończenia zwrócony z wykonywania 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 uruchamiania. Użyj tylko jednego skryptu, scriptUri, commandId.
Nazwa | Typ | Opis |
---|---|---|
commandId |
string |
Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. |
script |
string |
Określa zawartość skryptu do wykonania na maszynie wirtualnej. |
scriptUri |
string |
Określa lokalizację pobierania skryptu. Może to być identyfikator URI sygnatury dostępu współdzielonego obiektu blob usługi Azure Storage z dostępem do odczytu lub publicznym identyfikatorem URI. |
scriptUriManagedIdentity |
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do identyfikatora scriptUri w przypadku obiektu blob usługi Azure Storage. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje, a tożsamość zarządzana uzyskała dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged. |