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

  • Artigo

Definição de recurso do Bicep

O tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-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 propriedade

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
localização Localização do recurso cadeia (obrigatório)
etiquetas Etiquetas de recursos Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: virtualMachines
propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará que o script seja concluído. bool
errorBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity. string
outputBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de saída do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity. string
parâmetros Os parâmetros utilizados pelo script. RunCommandInputParameter[]
protectedParameters Os parâmetros utilizados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a palavra-passe da conta de utilizador na VM ao executar o comando executar. string
runAsUser Especifica a conta de utilizador na VM ao executar o comando executar. string
source A origem do script de comandos de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se estiver definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Com Falhas. Se definido como falso, ProvisioningState só refletiria se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a vista de instância do comando executar em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID de cliente (valor GUID) da identidade gerida atribuída pelo utilizador. O ObjectId não deve ser utilizado se for fornecido. string
objectId ID do Objeto (valor GUID) da identidade gerida atribuída pelo utilizador. O ClientId não deve ser utilizado se for fornecido. string

ExecutarCommandInputParameter

Nome Descrição Valor
name O nome do parâmetro de comando de execução. cadeia (obrigatório)
valor O valor do parâmetro de comando de execução. cadeia (obrigatório)

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script incorporado predefinido. string
script Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica a localização de transferência do script. Pode ser o URI de SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
scriptUriManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que o blob de armazenamento do Azure existe e que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Leitor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definição de recurso de modelo do ARM

O tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-07-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 propriedade

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
apiVersion A versão da API de recursos '2023-07-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 cadeia (obrigatório)
localização Localização do recurso cadeia (obrigatório)
etiquetas Etiquetas de recursos Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará pela conclusão do script. bool
errorBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity. string
outputBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de saída do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity. string
parâmetros Os parâmetros utilizados pelo script. RunCommandInputParameter[]
protectedParameters Os parâmetros utilizados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a palavra-passe da conta de utilizador na VM ao executar o comando executar. string
runAsUser Especifica a conta de utilizador na VM ao executar o comando executar. string
source A origem do script de comandos de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se estiver definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Com Falhas. Se definido como falso, ProvisioningState só refletiria se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a vista de instância do comando executar em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID de cliente (valor GUID) da identidade gerida atribuída pelo utilizador. ObjectId não deve ser utilizado se for fornecido. string
objectId ID do objeto (valor GUID) da identidade gerida atribuída pelo utilizador. ClientId não deve ser utilizado se for fornecido. string

RunCommandInputParameter

Nome Descrição Valor
name O nome do parâmetro de comando de execução. cadeia (obrigatório)
valor O valor do parâmetro de comando executar. cadeia (obrigatório)

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script incorporado predefinido. string
script Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica a localização de transferência do script. Pode ser o URI de SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
scriptUriManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que o blob de armazenamento do Azure existe e que a identidade gerida tem acesso ao contentor do blob com a atribuição da função "Leitor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso virtualMachineScaleSets/virtualMachines/runCommands pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-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 propriedade

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01"
name O nome do recurso cadeia (obrigatório)
localização Localização do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: virtualMachines
etiquetas Etiquetas de recursos Dicionário de nomes e valores de etiquetas.
propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará que o script seja concluído. bool
errorBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity. string
outputBlobManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de saída do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity. string
parâmetros Os parâmetros utilizados pelo script. RunCommandInputParameter[]
protectedParameters Os parâmetros utilizados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a palavra-passe da conta de utilizador na VM ao executar o comando executar. string
runAsUser Especifica a conta de utilizador na VM ao executar o comando executar. string
source A origem do script de comandos de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se estiver definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Com Falhas. Se definido como falso, ProvisioningState só refletiria se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a vista de instância do comando executar em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID de cliente (valor GUID) da identidade gerida atribuída pelo utilizador. ObjectId não deve ser utilizado se for fornecido. string
objectId ID do objeto (valor GUID) da identidade gerida atribuída pelo utilizador. ClientId não deve ser utilizado se for fornecido. string

RunCommandInputParameter

Nome Descrição Valor
name O nome do parâmetro de comando de execução. cadeia (obrigatório)
valor O valor do parâmetro de comando executar. cadeia (obrigatório)

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script incorporado predefinido. string
script Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica a localização de transferência do script. Pode ser o URI de SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
scriptUriManagedIdentity Identidade gerida atribuída pelo utilizador que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Confirme que o blob de armazenamento do Azure existe e que a identidade gerida tem acesso ao contentor do blob com a atribuição da função "Leitor de Dados do Blob de Armazenamento". No caso da identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity