Compartilhar via

Microsoft.Compute virtualMachines/runCommands 2023-07-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso virtualMachines/runCommands pode ser implantado com operações direcionadas:

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

Formato de recurso

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

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2023-07-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.Compute/virtualMachines/runCommands

Nome Descrição Valor
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico do recurso do tipo: virtualMachines
Propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. virtualMachineRunCommandProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

ResourceTags

Nome Descrição Valor

RunCommandInputParameter

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

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá ser usado se isso for fornecido. corda
objectId ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido. corda

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script. Bool
errorBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity. corda
Parâmetros Os parâmetros usados pelo script. runCommandInputParameter[]
protectedParameters Os parâmetros usados pelo script. runCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando de execução. corda
runAsUser Especifica a conta de usuário na VM ao executar o comando de execução. corda
fonte A origem do script de comando de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script interno predefinido. corda
roteiro Especifica o conteúdo do script a ser executado na VM. corda
scriptUri Especifica o local de download do script. Pode ser um URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. corda
scriptUriManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso de blob de armazenamento do Azure. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados do Blob de Armazenamento". No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
do GitLab Omnibus Esse modelo simplifica a implantação do GitLab Omnibus em uma Máquina Virtual com um DNS público, aproveitando o DNS do IP público. Ele utiliza o tamanho da instância Standard_F8s_v2, que se alinha à arquitetura de referência e dá suporte a até 1.000 usuários (20 RPS). A instância é pré-configurada para usar HTTPS com um certificado Let's Encrypt para conexões seguras.
Assinatura do SharePoint/2019/2016 totalmente configurado Crie um DC, um SQL Server 2022 e de 1 a 5 servidores que hospedam uma assinatura do SharePoint /2019/2016 farm com uma configuração abrangente, incluindo autenticação confiável, perfis de usuário com sites pessoais, uma confiança OAuth (usando um certificado), um site IIS dedicado para hospedar suplementos de alta confiança, etc... A versão mais recente dos principais softwares (incluindo Fiddler, vscode, np++, 7zip, ULS Viewer) está instalada. Os computadores do SharePoint têm ajustes adicionais para torná-los imediatamente utilizáveis (ferramentas de administração remota, políticas personalizadas para Edge e Chrome, atalhos etc...).

Definição de recurso de modelo do ARM

O tipo de recurso virtualMachines/runCommands pode ser implantado com operações direcionadas:

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

Formato de recurso

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

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2023-07-01",
  "name": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.Compute/virtualMachines/runCommands

Nome Descrição Valor
apiVersion A versão da API '2023-07-01'
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. virtualMachineRunCommandProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Compute/virtualMachines/runCommands'

ResourceTags

Nome Descrição Valor

RunCommandInputParameter

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

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá ser usado se isso for fornecido. corda
objectId ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido. corda

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script. Bool
errorBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity. corda
Parâmetros Os parâmetros usados pelo script. runCommandInputParameter[]
protectedParameters Os parâmetros usados pelo script. runCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando de execução. corda
runAsUser Especifica a conta de usuário na VM ao executar o comando de execução. corda
fonte A origem do script de comando de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script interno predefinido. corda
roteiro Especifica o conteúdo do script a ser executado na VM. corda
scriptUri Especifica o local de download do script. Pode ser um URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. corda
scriptUriManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso de blob de armazenamento do Azure. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados do Blob de Armazenamento". No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Exemplos de uso

Modelos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
do GitLab Omnibus

Implantar no Azure 		Esse modelo simplifica a implantação do GitLab Omnibus em uma Máquina Virtual com um DNS público, aproveitando o DNS do IP público. Ele utiliza o tamanho da instância Standard_F8s_v2, que se alinha à arquitetura de referência e dá suporte a até 1.000 usuários (20 RPS). A instância é pré-configurada para usar HTTPS com um certificado Let's Encrypt para conexões seguras.
Assinatura do SharePoint/2019/2016 totalmente configurado

Implantar no Azure 		Crie um DC, um SQL Server 2022 e de 1 a 5 servidores que hospedam uma assinatura do SharePoint /2019/2016 farm com uma configuração abrangente, incluindo autenticação confiável, perfis de usuário com sites pessoais, uma confiança OAuth (usando um certificado), um site IIS dedicado para hospedar suplementos de alta confiança, etc... A versão mais recente dos principais softwares (incluindo Fiddler, vscode, np++, 7zip, ULS Viewer) está instalada. Os computadores do SharePoint têm ajustes adicionais para torná-los imediatamente utilizáveis (ferramentas de administração remota, políticas personalizadas para Edge e Chrome, atalhos etc...).

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso virtualMachines/runCommands pode ser implantado com operações direcionadas:

  • Grupo de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2023-07-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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

Microsoft.Compute/virtualMachines/runCommands

Nome Descrição Valor
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: virtualMachines
Propriedades Descreve as propriedades de um comando de execução de Máquina Virtual. virtualMachineRunCommandProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Compute/virtualMachines/runCommands@2023-07-01"

ResourceTags

Nome Descrição Valor

RunCommandInputParameter

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

RunCommandManagedIdentity

Nome Descrição Valor
clientId ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá ser usado se isso for fornecido. corda
objectId ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido. corda

VirtualMachineRunCommandProperties

Nome Descrição Valor
asyncExecution Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script. Bool
errorBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity. corda
Parâmetros Os parâmetros usados pelo script. runCommandInputParameter[]
protectedParameters Os parâmetros usados pelo script. runCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando de execução. corda
runAsUser Especifica a conta de usuário na VM ao executar o comando de execução. corda
fonte A origem do script de comando de execução. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando de execução. int
treatFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Nome Descrição Valor
commandId Especifica um commandId de script interno predefinido. corda
roteiro Especifica o conteúdo do script a ser executado na VM. corda
scriptUri Especifica o local de download do script. Pode ser um URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. corda
scriptUriManagedIdentity Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso de blob de armazenamento do Azure. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor de Dados do Blob de Armazenamento". No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity