Machine Run Commands - List

Odwołanie

Service:: Hybrid Compute

API Version:: 2024-03-31-preview

Operacja pobierania wszystkich poleceń uruchamiania maszyny spoza platformy Azure.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?api-version=2024-03-31-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?$expand={$expand}&api-version=2024-03-31-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
machineName	path	True	string	Nazwa maszyny hybrydowej. Regex pattern: `[a-zA-Z0-9-_\.]+`
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Wyrażenie rozwiń, które ma być stosowane w operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MachineRunCommandsListResult	OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GET all Machine Run Commands

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands?api-version=2024-03-31-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_1",
      "name": "myRunCommand_1",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 3600,
        "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"
        }
      }
    },
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_2",
      "name": "myRunCommand_2",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Get-Process | Where-Object { $_.CPU -gt 10000 }"
        },
        "parameters": [],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "userA",
        "timeoutInSeconds": 100,
        "provisioningState": "Succeeded",
        "instanceView": {
          "executionState": "Succeeded",
          "executionMessage": "",
          "exitCode": 0,
          "output": "<some output>",
          "error": "",
          "startTime": "2023-06-15T20:48:41.4641785+00:00",
          "endTime": "2023-06-15T20:48:41.4641785+00:00"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExecutionState	Stan wykonywania skryptu.
ExtensionsResourceStatus	Stan widoku wystąpienia.
ExtensionsStatusLevelTypes	Kod poziomu.
MachineRunCommand	Opisuje polecenie uruchamiania
MachineRunCommandInstanceView	Widok wystąpienia polecenia uruchamiania maszyny.
MachineRunCommandScriptSource	Opisuje źródła skryptów do uruchamiania polecenia. Użyj tylko jednego skryptu, scriptUri, commandId.
MachineRunCommandsListResult	Opisuje wynik listy uruchomień poleceń.
RunCommandInputParameter	Opisuje właściwości 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.
systemData	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	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	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	ErrorDetail	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	ExtensionsStatusLevelTypes	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	RunCommandManagedIdentity		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	MachineRunCommandInstanceView		Widok wystąpienia polecenia uruchamiania maszyny.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		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	RunCommandInputParameter[]		Parametry używane przez skrypt.
properties.protectedParameters	RunCommandInputParameter[]		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	MachineRunCommandScriptSource		Źródło skryptu polecenia run.
properties.timeoutInSeconds	integer		Limit czasu w sekundach do wykonania polecenia uruchomienia.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
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	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	ExtensionsResourceStatus[]	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	RunCommandManagedIdentity	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.

MachineRunCommandsListResult

Opisuje wynik listy uruchomień poleceń.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony poleceń uruchamiania. Wywołaj metodę ListNext(), aby pobrać następną stronę poleceń uruchamiania.
value	MachineRunCommand[]	Lista poleceń uruchamiania

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	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	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Share via