Machine Run Commands - Update

Referenz

Dienst:: Hybrid Compute

API-Version:: 2024-05-20-preview

Der Vorgang zum Aktualisieren des Ausführungsbefehls.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}?api-version=2024-05-20-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
machineName	path	True	string	Der Name des Hybridcomputers. RegEx-Muster: `[a-zA-Z0-9-_\.]+`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
runCommandName	path	True	string	Der Name des Ausführungsbefehls. RegEx-Muster: `[a-zA-Z0-9-_\.]+`
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
tags	object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	MachineRunCommand	OK
202 Accepted		HTTP 202 (akzeptiert), wenn der Vorgang erfolgreich gestartet wurde und asynchron abgeschlossen wird. Header Location: string Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Name

Typ

Beschreibung

200 OK

MachineRunCommand

202 Accepted

HTTP 202 (akzeptiert), wenn der Vorgang erfolgreich gestartet wurde und asynchron abgeschlossen wird.

Header

Location: string
Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Update a Run Command

Sample request

HTTP

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

Status code:: 200

{
  "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"
    }
  }
}

Status code:: 202

Location: {callbackUrl}
Retry-After: 200
Azure-AsyncOperation: {callbackUri}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
ExecutionState	Skriptausführungsstatus.
ExtensionsResourceStatus	Status der Instanzansicht.
ExtensionsStatusLevelTypes	Der Ebenencode.
MachineRunCommand	Beschreibt einen Run-Befehl.
MachineRunCommandInstanceView	Die Instanzansicht eines Computerausführungsbefehls.
MachineRunCommandScriptSource	Beschreibt die Skriptquellen für den Befehl "ausführen". Verwenden Sie nur eine von script, scriptUri, commandId.
MachineRunCommandUpdate	Beschreibt ein Computererweiterungsupdate.
RunCommandInputParameter	Beschreibt die Eigenschaften eines Run-Befehlsparameters.
RunCommandManagedIdentity	Enthält clientId oder objectId (verwenden Sie nur eine, nicht beide) einer benutzerseitig zugewiesenen verwalteten Identität, die Zugriff auf das Speicherblob hat, das in Run Command verwendet wird. Verwenden Sie bei systemseitig zugewiesener Identität ein leeres RunCommandManagedIdentity-Objekt. Stellen Sie sicher, dass das Azure Storage-Blob im Fall von scriptUri vorhanden ist und die verwaltete Identität Zugriff auf den Blobcontainer mit der Rollenzuweisung "Storage Blob Data Reader" mit scriptUri blob und "Storage Blob Data Contributor" für Anfügen von Blobs (outputBlobUri, errorBlobUri) erhalten hat. Im Fall einer vom Benutzer zugewiesenen Identität müssen Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ExecutionState

Skriptausführungsstatus.

Name	Typ	Beschreibung
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

ExtensionsResourceStatus

Status der Instanzansicht.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	ExtensionsStatusLevelTypes	Der Ebenencode.
message	string	Die ausführliche Statusmeldung, einschließlich Warnungen und Fehlermeldungen.
time	string	Die Zeit des Status.

ExtensionsStatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

MachineRunCommand

Beschreibt einen Run-Befehl.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.asyncExecution	boolean	False	Optional. Wenn dieser Wert auf TRUE festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird, und es wird nicht auf den Abschluss des Skripts gewartet.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf das Storage-Blob errorBlobUri hat. Verwenden Sie bei systemseitig zugewiesener Identität ein leeres Objekt. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Mitwirkender an Storage-Blobdaten" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Gibt das Azure Storage-Blob an, in das der Skriptfehlerstream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff, ODER verwenden Sie eine verwaltete Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter errorBlobManagedIdentity-Parameter.
properties.instanceView	MachineRunCommandInstanceView		Die Befehlsinstanzansicht des Computers.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf das OutputBlobUri-Speicherblob hat. Verwenden Sie bei systemseitig zugewiesener Identität ein leeres Objekt. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Mitwirkender an Storage-Blobdaten" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Gibt das Azure Storage-Blob an, in das der Skriptausgabestream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff, ODER verwenden Sie eine verwaltete Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter outputBlobManagedIdentity-Parameter.
properties.parameters	RunCommandInputParameter[]		Die vom Skript verwendeten Parameter.
properties.protectedParameters	RunCommandInputParameter[]		Die vom Skript verwendeten Parameter.
properties.provisioningState	string		Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.runAsPassword	string		Gibt das Kennwort für das Benutzerkonto auf dem Computer an, wenn der Befehl "run" ausgeführt wird.
properties.runAsUser	string		Gibt das Benutzerkonto auf dem Computer an, wenn der Ausführungsbefehl ausgeführt wird.
properties.source	MachineRunCommandScriptSource		Die Quelle des Ausführungsbefehlsskripts.
properties.timeoutInSeconds	integer		Das Timeout in Sekunden zum Ausführen des Ausführungsbefehls.
systemData	systemData		Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

Die Instanzansicht eines Computerausführungsbefehls.

Name	Typ	Beschreibung
endTime	string	Skriptendzeit.
error	string	Skriptfehlerstream.
executionMessage	string	Kommunizieren von Skriptkonfigurationsfehlern oder Ausführungsmeldungen.
executionState	ExecutionState	Skriptausführungsstatus.
exitCode	integer	Exitcode, der von der Skriptausführung zurückgegeben wird.
output	string	Skriptausgabestream.
startTime	string	Skriptstartzeit.
statuses	ExtensionsResourceStatus[]	Die Statusinformationen.

MachineRunCommandScriptSource

Beschreibt die Skriptquellen für den Befehl "ausführen". Verwenden Sie nur eine von script, scriptUri, commandId.

Name	Typ	Beschreibung
commandId	string	Gibt die commandId des vordefinierten integrierten Skripts an.
script	string	Gibt den Skriptinhalt an, der auf dem Computer ausgeführt werden soll.
scriptUri	string	Gibt den Speicherort für den Skriptdownload an. Dabei kann es sich entweder um einen SAS-URI eines Azure Storage-Blobs mit Lesezugriff oder um einen öffentlichen URI handeln.
scriptUriManagedIdentity	RunCommandManagedIdentity	Benutzerseitig zugewiesene verwaltete Identität, die im Fall eines Azure Storage-Blobs Zugriff auf scriptUri hat. Verwenden Sie bei systemseitig zugewiesener Identität ein leeres Objekt. Stellen Sie sicher, dass das Azure Storage-Blob vorhanden ist und die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Reader" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.

MachineRunCommandUpdate

Beschreibt ein Computererweiterungsupdate.

Name	Typ	Beschreibung
tags	object	Ressourcentags

RunCommandInputParameter

Beschreibt die Eigenschaften eines Run-Befehlsparameters.

Name	Typ	Beschreibung
name	string	Der Name des Run-Befehlsparameters.
value	string	Der Wert des Befehlsparameters run.

RunCommandManagedIdentity

Enthält clientId oder objectId (verwenden Sie nur eine, nicht beide) einer benutzerseitig zugewiesenen verwalteten Identität, die Zugriff auf das Speicherblob hat, das in Run Command verwendet wird. Verwenden Sie bei systemseitig zugewiesener Identität ein leeres RunCommandManagedIdentity-Objekt. Stellen Sie sicher, dass das Azure Storage-Blob im Fall von scriptUri vorhanden ist und die verwaltete Identität Zugriff auf den Blobcontainer mit der Rollenzuweisung "Storage Blob Data Reader" mit scriptUri blob und "Storage Blob Data Contributor" für Anfügen von Blobs (outputBlobUri, errorBlobUri) erhalten hat. Im Fall einer vom Benutzer zugewiesenen Identität müssen Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.

Name	Typ	Beschreibung
clientId	string	Client-ID (GUID-Wert) der benutzerseitig zugewiesenen verwalteten Identität. ObjectId sollte nicht verwendet werden, wenn dies angegeben ist.
objectId	string	Objekt-ID (GUID-Wert) der benutzerseitig zugewiesenen verwalteten Identität. ClientId sollte nicht verwendet werden, wenn dies angegeben ist.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Machine Run Commands - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Update a Run Command

Sample request

Sample response

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

MachineRunCommandUpdate

RunCommandInputParameter

RunCommandManagedIdentity

systemData

Zusätzliche Ressourcen