Microsoft.Compute virtualMachines/runCommands 2023-03-01

• Mais recente
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 01-11-2022
• 2022-08-01
• 2022-03-01
• 01/11/2021
• 01/07/2021
• 2021-04-01
• 2021-03-01
• 2020-12-01

Definição de recurso do Bicep

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

• Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

resource symbolicname 'Microsoft.Compute/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 propriedade

virtualMachines/runCommands

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep.	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
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 o recurso do tipo: virtualMachines
properties	Descreve as propriedades de um comando de execução da Máquina Virtual.	VirtualMachineRunCommandProperties

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 no 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, adicione-a 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
errorBlobUri	Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso gerenciado 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 no 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, adicione-a 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 em que o fluxo de saída de script será carregado. Use um URI SAS com acesso gerenciado 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
parameters	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 executar.	string
runAsUser	Especifica a conta de usuário na VM ao executar o comando executar.	string
source	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, não indicaria se o script falhou em caso de falhas de script. Confira a exibição de 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

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.	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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Nome	Descrição	Valor
commandId	Especifica um commandId de script interno predefinido.	string
Script	Especifica o conteúdo do script a ser executado na VM.	string
scriptUri	Especifica o local de download do script. Ele pode ser o 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 do blob de armazenamento do Azure. Use um objeto vazio no 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, adicione-a 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

Assinatura do SharePoint / 2019 / 2016 / 2013 tudo configurado

Este modelo cria um farm de Assinatura do SharePoint/2019/2016/2013 com uma configuração extensa que levaria anos para ser executada manualmente, incluindo uma autenticação federada com o ADFS, uma relação de confiança OAuth, o serviço Perfis de Usuário e um aplicativo Web com duas zonas que contém vários conjuntos de sites baseados em caminho e nomeados por host. Nas máquinas virtuais do SharePoint, o Chocolatey é usado para instalar a versão mais recente do Bloco de Notas++, Visual Studio Code, Azure Data Studio, Fiddler, Visualizador ULS e 7-Zip.

Definição de recurso de modelo do ARM

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

• Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.Compute/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 propriedade

virtualMachines/runCommands

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.Compute/virtualMachines/runCommands'
apiVersion	A versão da API de recursos	'2023-03-01'
name	O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
properties	Descreve as propriedades de um comando de execução da Máquina Virtual.	VirtualMachineRunCommandProperties

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 no 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, adicione-a 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
errorBlobUri	Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso gerenciado 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 no 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, adicione-a 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 em que o fluxo de saída de script será carregado. Use um URI SAS com acesso gerenciado 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
parameters	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 executar.	string
runAsUser	Especifica a conta de usuário na VM ao executar o comando executar.	string
source	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, não indicaria se o script falhou em caso de falhas de script. Confira a exibição de 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

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.	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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Nome	Descrição	Valor
commandId	Especifica um commandId de script interno predefinido.	string
Script	Especifica o conteúdo do script a ser executado na VM.	string
scriptUri	Especifica o local de download do script. Ele pode ser o 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 do blob de armazenamento do Azure. Use um objeto vazio no 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, adicione-a 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

Assinatura do SharePoint / 2019 / 2016 / 2013 tudo configurado

Este modelo cria um farm de Assinatura do SharePoint/2019/2016/2013 com uma configuração extensa que levaria anos para ser executada manualmente, incluindo uma autenticação federada com o ADFS, uma relação de confiança OAuth, o serviço Perfis de Usuário e um aplicativo Web com duas zonas que contém vários conjuntos de sites baseados em caminho e nomeados por host. Nas máquinas virtuais do SharePoint, o Chocolatey é usado para instalar a versão mais recente do Bloco de Notas++, Visual Studio Code, Azure Data Studio, Fiddler, Visualizador ULS e 7-Zip.

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

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

• Grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/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 propriedade

virtualMachines/runCommands

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Compute/virtualMachines/runCommands@2023-03-01"
name	O nome do recurso	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: virtualMachines
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas.
properties	Descreve as propriedades de um comando de execução da Máquina Virtual.	VirtualMachineRunCommandProperties

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 no 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, adicione-a 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
errorBlobUri	Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso gerenciado 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 no 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, adicione-a 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 em que o fluxo de saída de script será carregado. Use um URI SAS com acesso gerenciado 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
parameters	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 executar.	string
runAsUser	Especifica a conta de usuário na VM ao executar o comando executar.	string
source	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, não indicaria se o script falhou em caso de falhas de script. Confira a exibição de 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

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.	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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Nome	Descrição	Valor
commandId	Especifica um commandId do script interno predefinido.	string
Script	Especifica o conteúdo do script a ser executado na VM.	string
scriptUri	Especifica o local de download 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 gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Use um objeto vazio no 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 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