Machine Run Commands - Create Or Update

Servicio:: Hybrid Compute

Versión de la API:: 2025-01-13

Operación para crear o actualizar un comando de ejecución.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}?api-version=2025-01-13

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
machineName	path	True	string pattern: [a-zA-Z0-9-_\.]+	Nombre de la máquina híbrida.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
runCommandName	path	True	string pattern: [a-zA-Z0-9-_\.]+	Nombre del comando run.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
properties.asyncExecution		boolean	Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento errorBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro errorBlobManagedIdentity.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento outputBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.outputBlobUri		string	Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro outputBlobManagedIdentity.
properties.parameters		RunCommandInputParameter[]	Parámetros usados por el script.
properties.protectedParameters		RunCommandInputParameter[]	Parámetros usados por el script.
properties.runAsPassword		string	Especifica la contraseña de la cuenta de usuario en el equipo al ejecutar el comando run.
properties.runAsUser		string	Especifica la cuenta de usuario en el equipo al ejecutar el comando run.
properties.source		MachineRunCommandScriptSource	Origen del script de comando de ejecución.
properties.timeoutInSeconds		integer (int32)	Tiempo de espera en segundos para ejecutar el comando run.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	MachineRunCommand	Recurso actualizado
201 Created	MachineRunCommand	Creado Encabezados Location: string Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

MachineRunCommand

Recurso actualizado

201 Created

MachineRunCommand

Creado

Encabezados

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

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create or Update a Run Command

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands/myRunCommand?api-version=2025-01-13

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

Respuesta de muestra

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ExecutionState	Estado de ejecución del script.
ExtensionsResourceStatus	Estado de la vista de instancia.
ExtensionsStatusLevelTypes	Código de nivel.
MachineRunCommand	Describe un comando run
MachineRunCommandInstanceView	Vista de instancia de un comando de ejecución de máquina.
MachineRunCommandScriptSource	Describe los orígenes de script para ejecutar el comando . Use solo uno de script, scriptUri, commandId.
RunCommandInputParameter	Describe las propiedades de un parámetro de comando de ejecución.
RunCommandManagedIdentity	Contiene clientId o objectId (use solo uno, no ambos) de una identidad administrada asignada por el usuario que tenga acceso al blob de almacenamiento usado en Ejecutar comando. Use un objeto RunCommandManagedIdentity vacío en caso de identidad asignada por el sistema. Asegúrese de que el blob de Azure Storage existe en caso de scriptUri y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de Storage Blob" con scriptUri blob y "Colaborador de datos de Storage Blob" para Append blobs(outputBlobUri, errorBlobUri). En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ExecutionState

Enumeración

Estado de ejecución del script.

Valor	Description
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

ExtensionsResourceStatus

Object

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	ExtensionsStatusLevelTypes	Código de nivel.
message	string	Mensaje de estado detallado, incluido para alertas y mensajes de error.
time	string (date-time)	Hora del estado.

ExtensionsStatusLevelTypes

Enumeración

Código de nivel.

Valor	Description
Info
Warning
Error

MachineRunCommand

Object

Describe un comando run

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso
properties.asyncExecution	boolean	False	Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento errorBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		Vista de instancia del comando de ejecución de la máquina.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento outputBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parámetros usados por el script.
properties.protectedParameters	RunCommandInputParameter[]		Parámetros usados por el script.
properties.provisioningState	string		Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.runAsPassword	string		Especifica la contraseña de la cuenta de usuario en el equipo al ejecutar el comando run.
properties.runAsUser	string		Especifica la cuenta de usuario en el equipo al ejecutar el comando run.
properties.source	MachineRunCommandScriptSource		Origen del script de comando de ejecución.
properties.timeoutInSeconds	integer (int32)		Tiempo de espera en segundos para ejecutar el comando run.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object		Etiquetas de recursos.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

Object

Vista de instancia de un comando de ejecución de máquina.

Nombre	Tipo	Description
endTime	string (date-time)	Hora de finalización del script.
error	string	Secuencia de errores de script.
executionMessage	string	Comunicar errores de configuración de script o mensajes de ejecución.
executionState	ExecutionState	Estado de ejecución del script.
exitCode	integer (int32)	Código de salida devuelto desde la ejecución del script.
output	string	Secuencia de salida del script.
startTime	string (date-time)	Hora de inicio del script.
statuses	ExtensionsResourceStatus[]	Información de estado.

MachineRunCommandScriptSource

Object

Describe los orígenes de script para ejecutar el comando . Use solo uno de script, scriptUri, commandId.

Nombre	Tipo	Description
commandId	string	Especifica el commandId del script integrado predefinido.
script	string	Especifica el contenido del script que se va a ejecutar en la máquina.
scriptUri	string	Especifica la ubicación de descarga del script. Puede ser un URI de SAS de un blob de Azure Storage con acceso de lectura o URI público.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identidad administrada asignada por el usuario que tiene acceso a scriptUri en caso de blob de Azure Storage. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que existe el blob de Azure Storage y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de blobs de almacenamiento". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

RunCommandInputParameter

Object

Describe las propiedades de un parámetro de comando de ejecución.

Nombre	Tipo	Description
name	string	Nombre del parámetro del comando run.
value	string	Valor del parámetro del comando run.

RunCommandManagedIdentity

Object

Contiene clientId o objectId (use solo uno, no ambos) de una identidad administrada asignada por el usuario que tenga acceso al blob de almacenamiento usado en Ejecutar comando. Use un objeto RunCommandManagedIdentity vacío en caso de identidad asignada por el sistema. Asegúrese de que el blob de Azure Storage existe en caso de scriptUri y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de Storage Blob" con scriptUri blob y "Colaborador de datos de Storage Blob" para Append blobs(outputBlobUri, errorBlobUri). En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

Nombre	Tipo	Description
clientId	string	Id. de cliente (valor GUID) de la identidad administrada asignada por el usuario. ObjectId no se debe usar si se proporciona.
objectId	string	Id. de objeto (valor GUID) de la identidad administrada asignada por el usuario. ClientId no debe usarse si se proporciona.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Machine Run Commands - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create or Update a Run Command

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

RunCommandInputParameter

RunCommandManagedIdentity

systemData