Machine Run Commands - Update
Operacja aktualizowania polecenia run.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}?api-version=2024-05-20-preview
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
machine
|
path | True |
string |
Nazwa maszyny hybrydowej. Wzorzec wyrażenia regularnego: |
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
run
|
path | True |
string |
Nazwa polecenia uruchamiania. Wzorzec wyrażenia regularnego: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
tags |
object |
Tagi zasobów |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
202 Accepted |
HTTP 202 (Zaakceptowano), jeśli operacja została pomyślnie uruchomiona i zostanie ukończona asynchronicznie. Nagłówki
|
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Update a Run Command
Sample request
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands/myRunCommand?api-version=2024-05-20-preview
{
"tags": {
"tag1": "value1",
"tag2": "value2"
}
}
Sample response
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand",
"name": "myRunCommand",
"type": "Microsoft.HybridCompute/machines/runcommands",
"location": "eastus2",
"properties": {
"source": {
"script": "Write-Host Hello World!"
},
"parameters": [
{
"name": "param1",
"value": "value1"
},
{
"name": "param2",
"value": "value2"
}
],
"asyncExecution": false,
"runAsUser": "user1",
"timeoutInSeconds": 3600,
"outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
"errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
"provisioningState": "Succeeded",
"instanceView": {
"executionState": "Succeeded",
"executionMessage": "",
"exitCode": 0,
"output": "Hello World",
"error": "",
"startTime": "2023-06-15T20:48:41.4641785+00:00",
"endTime": "2023-06-15T20:48:41.4641785+00:00"
}
}
}
Location: {callbackUrl}
Retry-After: 200
Azure-AsyncOperation: {callbackUri}
Definicje
Nazwa | Opis |
---|---|
created |
Typ tożsamości, która utworzyła zasób. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Execution |
Stan wykonywania skryptu. |
Extensions |
Stan widoku wystąpienia. |
Extensions |
Kod poziomu. |
Machine |
Opisuje polecenie uruchamiania |
Machine |
Widok wystąpienia polecenia uruchamiania maszyny. |
Machine |
Opisuje źródła skryptów do uruchamiania polecenia. Użyj tylko jednego skryptu, scriptUri, commandId. |
Machine |
Opisuje aktualizację rozszerzenia maszyny. |
Run |
Opisuje właściwości parametru polecenia run. |
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 "Storage Blob Data Reader" z przypisaniem roli scriptUri 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ść 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. |
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
createdByType
Typ tożsamości, która utworzyła zasób.
Nazwa | Typ | Opis |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
ExecutionState
Stan wykonywania skryptu.
Nazwa | Typ | Opis |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
Pending |
string |
|
Running |
string |
|
Succeeded |
string |
|
TimedOut |
string |
|
Unknown |
string |
ExtensionsResourceStatus
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. |
ExtensionsStatusLevelTypes
Kod poziomu.
Nazwa | Typ | Opis |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
MachineRunCommand
Opisuje polecenie uruchamiania
Nazwa | Typ | wartość domyślna | Opis |
---|---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
location |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
|
name |
string |
Nazwa zasobu |
|
properties.asyncExecution |
boolean |
False |
Opcjonalny. Jeśli ustawienie ma wartość true, aprowizacja zostanie zakończona zaraz 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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. |
|
properties.instanceView |
Widok wystąpienia polecenia uruchamiania maszyny. |
||
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ść 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 w celu zapewnienia dostępu maszyny wirtualnej 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. |
|
properties.runAsPassword |
string |
Określa hasło konta użytkownika na maszynie podczas wykonywania polecenia run. |
|
properties.runAsUser |
string |
Określa konto użytkownika na maszynie podczas wykonywania polecenia run. |
|
properties.source |
Źródło skryptu polecenia run. |
||
properties.timeoutInSeconds |
integer |
Limit czasu w sekundach do wykonania polecenia uruchomienia. |
|
systemData |
Metadane usługi Azure Resource Manager zawierające informacje utworzone przez i zmodyfikowane przez użytkownika. |
||
tags |
object |
Tagi zasobów. |
|
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
MachineRunCommandInstanceView
Widok wystąpienia polecenia uruchamiania maszyny.
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. |
MachineRunCommandScriptSource
Opisuje źródła skryptów do uruchamiania polecenia. 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, która ma być wykonywana na maszynie. |
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 została udzielona dostępu do kontenera obiektów blob z przypisaniem roli "Czytelnik danych obiektów blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość 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. |
MachineRunCommandUpdate
Opisuje aktualizację rozszerzenia maszyny.
Nazwa | Typ | Opis |
---|---|---|
tags |
object |
Tagi zasobów |
RunCommandInputParameter
Opisuje właściwości parametru polecenia run.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa parametru polecenia run. |
value |
string |
Wartość parametru polecenia run. |
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 "Storage Blob Data Reader" z przypisaniem roli scriptUri 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ść 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. Identyfikator ObjectId nie powinien być używany, jeśli jest to podane. |
objectId |
string |
Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Identyfikator ClientId nie powinien być używany, jeśli jest to podane. |
systemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Nazwa | Typ | Opis |
---|---|---|
createdAt |
string |
Sygnatura czasowa tworzenia zasobu (UTC). |
createdBy |
string |
Tożsamość, która utworzyła zasób. |
createdByType |
Typ tożsamości, która utworzyła zasób. |
|
lastModifiedAt |
string |
Sygnatura czasowa ostatniej modyfikacji zasobu (UTC) |
lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |