Machine Run Commands - List

Referencia

Servicio:: Hybrid Compute

Versión de la API:: 2024-05-20-preview

La operación para obtener todos los comandos de ejecución de una máquina que no es de Azure.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
machineName	path	True	string	Nombre de la máquina híbrida. Patrón de Regex: `[a-zA-Z0-9-_\.]+`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.
$expand	query		string	Expresión expand que se va a aplicar en la operación.

Respuestas

Nombre	Tipo	Description
200 OK	MachineRunCommandsListResult	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo 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	suplantación de su cuenta de usuario

Ejemplos

GET all Machine Run Commands

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

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	El 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.
MachineRunCommandsListResult	Describe el resultado de la lista ejecutar comandos.
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 el 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 relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ExecutionState

Estado de ejecución del script.

Nombre	Tipo	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

ExtensionsResourceStatus

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	El código de nivel.
message	string	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.
time	string	Hora del estado.

ExtensionsStatusLevelTypes

El código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

MachineRunCommand

Describe un comando Run

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo del 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 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, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual al blob. Consulte el parámetro errorBlobManagedIdentity.
properties.instanceView	MachineRunCommandInstanceView		Vista de instancia de 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 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, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual 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		Tiempo de espera en segundos para ejecutar el comando run.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object		Etiquetas del recurso.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MachineRunCommandInstanceView

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

Nombre	Tipo	Description
endTime	string	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	Código de salida devuelto de la ejecución del script.
output	string	Secuencia de salida del script.
startTime	string	Hora de inicio del script.
statuses	ExtensionsResourceStatus[]	Información de estado.

MachineRunCommandScriptSource

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 el caso del 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 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.

MachineRunCommandsListResult

Describe el resultado de la lista ejecutar comandos.

Nombre	Tipo	Description
nextLink	string	URI para capturar la página siguiente de comandos de ejecución. Llame a ListNext() con esto para capturar la página siguiente de comandos de ejecución.
value	MachineRunCommand[]	Lista de comandos de ejecución

RunCommandInputParameter

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

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

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 el 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 debe usarse 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

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	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	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