Partilhar via

Microsoft.Compute virtualMachines/runCommands 2023-07-01

  • Artigo

Definição de recursos do bíceps

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 log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachines/runCommands, adicione o seguinte Bíceps 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

Designação Descrição Valor
Localização Localização do recurso string (obrigatório)
Designação O nome do recurso string (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 para recurso do tipo: virtualMachines
propriedades Descreve as propriedades de um comando de execução de máquina virtual. VirtualMachineRunCommandProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Tags de Recursos

Designação Descrição Valor

RunCommandInputParameter

Designação Descrição Valor
Designação O nome do parâmetro do comando run. string (obrigatório)
valor O valor do parâmetro run command. string (obrigatório)

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Designação 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 sob a 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
erroBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity. string
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 sob a 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 onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity. string
Parâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
protectedParâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando run. string
runAsUser Especifica a conta de usuário na VM ao executar o comando run. string
fonte A origem do script de comando run. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando run. Int
tratarFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run 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 visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Designação Descrição Valor
commandId Especifica um commandId de script interno predefinido. string
guião Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica o local de download do script. Pode ser URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
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 de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a 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 início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
GitLab Omnibus Este 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 com a arquitetura de referência e suporta até 1000 usuários (20 RPS). A instância é pré-configurada para usar HTTPS com um certificado Let's Encrypt para conexões seguras.
SharePoint Subscription / 2019 / 2016 totalmente configurado Crie um DC, um SQL Server 2022 e de 1 a 5 servidor(es) hospedando um farm de Assinatura do SharePoint / 2019 / 2016 com uma configuração extensa, incluindo autenticação confiável, perfis de usuário com sites pessoais, uma relação de 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. As máquinas SharePoint têm ajustes finos adicionais para torná-las imediatamente utilizáveis (ferramentas de administração remota, políticas personalizadas para Edge e Chrome, atalhos, etc...).

Definição de recurso de modelo 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 log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachines/runCommands, adicione o seguinte JSON 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

Designação Descrição Valor
apiVersion A versão api '2023-07-01'
Localização Localização do recurso string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Descreve as propriedades de um comando de execução de máquina virtual. VirtualMachineRunCommandProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Compute/virtualMachines/runCommands'

Tags de Recursos

Designação Descrição Valor

RunCommandInputParameter

Designação Descrição Valor
Designação O nome do parâmetro do comando run. string (obrigatório)
valor O valor do parâmetro run command. string (obrigatório)

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Designação 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 sob a 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
erroBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity. string
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 sob a 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 onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity. string
Parâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
protectedParâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando run. string
runAsUser Especifica a conta de usuário na VM ao executar o comando run. string
fonte A origem do script de comando run. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando run. Int
tratarFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run 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 visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Designação Descrição Valor
commandId Especifica um commandId de script interno predefinido. string
guião Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica o local de download do script. Pode ser URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
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 de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a 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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
GitLab Omnibus

Implementar no Azure 		Este 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 com a arquitetura de referência e suporta até 1000 usuários (20 RPS). A instância é pré-configurada para usar HTTPS com um certificado Let's Encrypt para conexões seguras.
SharePoint Subscription / 2019 / 2016 totalmente configurado

Implementar no Azure 		Crie um DC, um SQL Server 2022 e de 1 a 5 servidor(es) hospedando um farm de Assinatura do SharePoint / 2019 / 2016 com uma configuração extensa, incluindo autenticação confiável, perfis de usuário com sites pessoais, uma relação de 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. As máquinas SharePoint têm ajustes finos adicionais para torná-las imediatamente utilizáveis (ferramentas de administração remota, políticas personalizadas para Edge e Chrome, atalhos, etc...).

Definição de recursos Terraform (provedor 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 log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Compute/virtualMachines/runCommands, adicione o seguinte Terraform 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

Designação Descrição Valor
Localização Localização do recurso string (obrigatório)
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: virtualMachines
propriedades Descreve as propriedades de um comando de execução de máquina virtual. VirtualMachineRunCommandProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Compute/virtualMachines/runCommands@2023-07-01"

Tags de Recursos

Designação Descrição Valor

RunCommandInputParameter

Designação Descrição Valor
Designação O nome do parâmetro do comando run. string (obrigatório)
valor O valor do parâmetro run command. string (obrigatório)

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Designação 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 sob a 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
erroBlobUri Especifica o blob de armazenamento do Azure onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity. string
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 sob a 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 onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity. string
Parâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
protectedParâmetros Os parâmetros usados pelo script. RunCommandInputParameter[]
runAsPassword Especifica a senha da conta de usuário na VM ao executar o comando run. string
runAsUser Especifica a conta de usuário na VM ao executar o comando run. string
fonte A origem do script de comando run. VirtualMachineRunCommandScriptSource
timeoutInSeconds O tempo limite em segundos para executar o comando run. Int
tratarFailureAsDeploymentFailure Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run 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 visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Designação Descrição Valor
commandId Especifica um commandId de script interno predefinido. string
guião Especifica o conteúdo do script a ser executado na VM. string
scriptUri Especifica o local de download do script. Pode ser URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público. string
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 de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a 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