Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-03-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    asyncExecution: bool
    errorBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    errorBlobUri: 'string'
    outputBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
}

Valores de propiedad

virtualMachineScaleSets/virtualMachines/runCommands

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
ubicación Ubicación de los recursos string (obligatorio)
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: virtualMachines
properties Describe las propiedades de un comando de ejecución de máquina virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nombre Descripción Valor
asyncExecution 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. bool
errorBlobManagedIdentity 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 RunCommandManagedIdentity
errorBlobUri 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. string
outputBlobManagedIdentity 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 RunCommandManagedIdentity
outputBlobUri 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. string
parámetros Parámetros usados por el script. RunCommandInputParameter[]
protectedParameters Parámetros usados por el script. RunCommandInputParameter[]
runAsPassword Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
runAsUser Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
source Origen del script de comando de ejecución. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tiempo de espera en segundos para ejecutar el comando run. int
treatFailureAsDeploymentFailure Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

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

RunCommandInputParameter

Nombre Descripción Value
name Nombre del parámetro de comando de ejecución. string (obligatorio)
value Valor del parámetro de comando run. string (obligatorio)

VirtualMachineRunCommandScriptSource

Nombre Descripción Valor
commandId Especifica un commandId del script integrado predefinido. string
script Especifica el contenido del script que se va a ejecutar en la máquina virtual. string
scriptUri 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. string
scriptUriManagedIdentity 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 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. RunCommandManagedIdentity

Definición de recursos de plantilla de ARM

El tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "asyncExecution": "bool",
    "errorBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "errorBlobUri": "string",
    "outputBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  }
}

Valores de propiedad

virtualMachineScaleSets/virtualMachines/runCommands

Nombre Descripción Value
type Tipo de recurso 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion La versión de la API de recursos '2023-03-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
ubicación Ubicación de los recursos string (obligatorio)
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties Describe las propiedades de un comando de ejecución de máquina virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nombre Descripción Valor
asyncExecution 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. bool
errorBlobManagedIdentity 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 a la identidad administrada se le ha concedido acceso 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 RunCommandManagedIdentity
errorBlobUri 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. string
outputBlobManagedIdentity 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 a la identidad administrada se le ha concedido acceso 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 RunCommandManagedIdentity
outputBlobUri 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. string
parámetros Parámetros usados por el script. RunCommandInputParameter[]
protectedParameters Parámetros usados por el script. RunCommandInputParameter[]
runAsPassword Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
runAsUser Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
source Origen del script de comando de ejecución. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tiempo de espera en segundos para ejecutar el comando run. int
treatFailureAsDeploymentFailure Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

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

RunCommandInputParameter

Nombre Descripción Value
name Nombre del parámetro de comando run. string (obligatorio)
value Valor del parámetro del comando run. string (obligatorio)

VirtualMachineRunCommandScriptSource

Nombre Descripción Valor
commandId Especifica un commandId de script integrado predefinido. string
script Especifica el contenido del script que se va a ejecutar en la máquina virtual. string
scriptUri 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. string
scriptUriManagedIdentity 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 más información sobre la identidad administrada y Ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      errorBlobUri = "string"
      outputBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  })
}

Valores de propiedad

virtualMachineScaleSets/virtualMachines/runCommands

Nombre Descripción Value
type Tipo de recurso "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01"
name El nombre del recurso string (obligatorio)
ubicación Ubicación de los recursos string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: virtualMachines
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta.
properties Describe las propiedades de un comando de ejecución de máquina virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nombre Descripción Valor
asyncExecution 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. bool
errorBlobManagedIdentity 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 a la identidad administrada se le ha concedido acceso 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 RunCommandManagedIdentity
errorBlobUri 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. string
outputBlobManagedIdentity 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 a la identidad administrada se le ha concedido acceso 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 RunCommandManagedIdentity
outputBlobUri 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. string
parámetros Parámetros usados por el script. RunCommandInputParameter[]
protectedParameters Parámetros usados por el script. RunCommandInputParameter[]
runAsPassword Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
runAsUser Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run. string
source Origen del script de comando de ejecución. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tiempo de espera en segundos para ejecutar el comando run. int
treatFailureAsDeploymentFailure Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

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

RunCommandInputParameter

Nombre Descripción Value
name Nombre del parámetro de comando de ejecución. string (obligatorio)
value Valor del parámetro de comando run. string (obligatorio)

VirtualMachineRunCommandScriptSource

Nombre Descripción Valor
commandId Especifica un commandId del script integrado predefinido. string
script Especifica el contenido del script que se va a ejecutar en la máquina virtual. string
scriptUri 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. string
scriptUriManagedIdentity 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 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. RunCommandManagedIdentity