Machine Run Commands - Create Or Update

Riferimento

Servizio:: Hybrid Compute

Versione API:: 2024-05-20-preview

Operazione per creare o aggiornare un comando di esecuzione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
machineName	path	True	string	Nome della macchina ibrida. Criterio di espressione regolare: `[a-zA-Z0-9-_\.]+`
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
runCommandName	path	True	string	Nome del comando di esecuzione. Criterio di espressione regolare: `[a-zA-Z0-9-_\.]+`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui vive la risorsa
properties.asyncExecution		boolean	facoltativo. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto nel caso di identità assegnata dal sistema. Assicurarsi che l'identità gestita sia stata assegnata al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore dati BLOB di archiviazione". Nel caso dell'identità assegnata dall'utente, assicurarsi di aggiungerlo sotto l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, fare riferimento https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori di script. Usare un URI di firma di accesso condiviso con lettura, accodamento, creazione, accesso in scrittura O usare l'identità gestita per fornire l'accesso alla macchina virtuale al BLOB. Fare riferimento al parametro errorBlobManagedIdentity.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto nel caso di identità assegnata dal sistema. Assicurarsi che l'identità gestita sia stata assegnata al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore dati BLOB di archiviazione". Nel caso dell'identità assegnata dall'utente, assicurarsi di aggiungerlo sotto l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, fare riferimento https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri		string	Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, accodamento, creazione, accesso in scrittura O usare l'identità gestita per fornire l'accesso alla macchina virtuale al BLOB. Fare riferimento al parametro outputBlobManagedIdentity.
properties.parameters		RunCommandInputParameter[]	Parametri utilizzati dallo script.
properties.protectedParameters		RunCommandInputParameter[]	Parametri utilizzati dallo script.
properties.runAsPassword		string	Specifica la password dell'account utente nel computer durante l'esecuzione del comando di esecuzione.
properties.runAsUser		string	Specifica l'account utente nel computer durante l'esecuzione del comando di esecuzione.
properties.source		MachineRunCommandScriptSource	Origine dello script del comando di esecuzione.
properties.timeoutInSeconds		integer	Timeout in secondi per eseguire il comando di esecuzione.
tags		object	Tag di risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	MachineRunCommand	Risorsa aggiornata
201 Created	MachineRunCommand	Data di creazione Intestazioni Location: string Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

MachineRunCommand

Risorsa aggiornata

201 Created

MachineRunCommand

Data di creazione

Intestazioni

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

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or Update a Run Command

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands/myRunCommand?api-version=2024-05-20-preview

{
  "location": "eastus2",
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

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

Status code:: 201

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

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ExecutionState	Stato di esecuzione dello script.
ExtensionsResourceStatus	Stato della visualizzazione dell'istanza.
ExtensionsStatusLevelTypes	Codice di livello.
MachineRunCommand	Descrive un comando Esegui
MachineRunCommandInstanceView	Visualizzazione dell'istanza di un comando di esecuzione del computer.
MachineRunCommandScriptSource	Vengono descritte le origini dello script per il comando run. Usare solo uno script, scriptUri, commandId.
RunCommandInputParameter	Descrive le proprietà di un parametro di comando di esecuzione.
RunCommandManagedIdentity	Contiene clientId o objectId (usare solo uno, non entrambi) di un'identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione usato in Esegui comando. Usa un oggetto RunCommandManagedIdentity vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista nel caso di scriptUri e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione" con il BLOB scriptUri e "Collaboratore dati BLOB di archiviazione" per i BLOB di accodamento(outputBlobUri, errorBlobUri). In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ExecutionState

Stato di esecuzione dello script.

Nome	Tipo	Descrizione
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

ExtensionsResourceStatus

Stato della visualizzazione dell'istanza.

Nome	Tipo	Descrizione
code	string	Codice di stato.
displayStatus	string	Etichetta localizzabile breve per lo stato.
level	ExtensionsStatusLevelTypes	Codice di livello.
message	string	Messaggio di stato dettagliato, inclusi gli avvisi e i messaggi di errore.
time	string	Ora dello stato.

ExtensionsStatusLevelTypes

Codice di livello.

Nome	Tipo	Descrizione
Error	string
Info	string
Warning	string

MachineRunCommand

Descrive un comando Esegui

Nome	Tipo	valore predefinito	Descrizione
id	string		ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Posizione geografica in cui risiede la risorsa
name	string		nome della risorsa.
properties.asyncExecution	boolean	False	facoltativo. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura o uso dell'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		Visualizzazione dell'istanza del comando di esecuzione del computer.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura o uso dell'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parametri utilizzati dallo script.
properties.protectedParameters	RunCommandInputParameter[]		Parametri utilizzati dallo script.
properties.provisioningState	string		Stato di provisioning, che viene visualizzato solo nella risposta.
properties.runAsPassword	string		Specifica la password dell'account utente nel computer durante l'esecuzione del comando run.
properties.runAsUser	string		Specifica l'account utente nel computer durante l'esecuzione del comando run.
properties.source	MachineRunCommandScriptSource		Origine dello script del comando di esecuzione.
properties.timeoutInSeconds	integer		Timeout in secondi per eseguire il comando run.
systemData	systemData		Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object		Tag delle risorse.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

Visualizzazione dell'istanza di un comando di esecuzione del computer.

Nome	Tipo	Descrizione
endTime	string	Ora di fine dello script.
error	string	Flusso di errori dello script.
executionMessage	string	Comunicare gli errori di configurazione dello script o i messaggi di esecuzione.
executionState	ExecutionState	Stato di esecuzione dello script.
exitCode	integer	Codice di uscita restituito dall'esecuzione dello script.
output	string	Flusso di output dello script.
startTime	string	Ora di inizio dello script.
statuses	ExtensionsResourceStatus[]	Informazioni sullo stato.

MachineRunCommandScriptSource

Vengono descritte le origini dello script per il comando run. Usare solo uno script, scriptUri, commandId.

Nome	Tipo	Descrizione
commandId	string	Specifica il commandId dello script predefinito predefinito.
script	string	Specifica il contenuto dello script da eseguire nel computer.
scriptUri	string	Specifica il percorso di download dello script. Può trattarsi di un URI di firma di accesso condiviso di un BLOB di archiviazione di Azure con accesso in lettura o URI pubblico.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso a scriptUri in caso di BLOB di archiviazione di Azure. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

RunCommandInputParameter

Descrive le proprietà di un parametro di comando di esecuzione.

Nome	Tipo	Descrizione
name	string	Nome del parametro del comando di esecuzione.
value	string	Valore del parametro del comando run.

RunCommandManagedIdentity

Contiene clientId o objectId (usare solo uno, non entrambi) di un'identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione usato in Esegui comando. Usa un oggetto RunCommandManagedIdentity vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista nel caso di scriptUri e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione" con il BLOB scriptUri e "Collaboratore dati BLOB di archiviazione" per i BLOB di accodamento(outputBlobUri, errorBlobUri). In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Nome	Tipo	Descrizione
clientId	string	ID client (valore GUID) dell'identità gestita assegnata dall'utente. ObjectId non deve essere usato se specificato.
objectId	string	ID oggetto (valore GUID) dell'identità gestita assegnata dall'utente. ClientId non deve essere usato se specificato.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Machine Run Commands - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

Create or Update a Run Command

Sample request

Sample response

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

RunCommandInputParameter

RunCommandManagedIdentity

systemData

Risorse aggiuntive