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

Artigo
12/09/2024

Definição de recurso do Bicep

O tipo de recurso virtualMachineScaleSets/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 de log de alterações.

Formato de recurso

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-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/virtualMachineScaleSets/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 para recurso do tipo: virtualMachineScaleSets/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

Definição de recurso de modelo do ARM

O tipo de recurso virtualMachineScaleSets/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 de log de alterações.

Formato de recurso

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

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

Nome	Descrição	Valor
apiVersion	A versão da API	'2023-09-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/virtualMachineScaleSets/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

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

O tipo de recurso virtualMachineScaleSets/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 de log de alterações.

Formato de recurso

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

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

Compartilhar via

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

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

ResourceTags

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

ResourceTags

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Exemplos de uso

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

Formato de recurso

Valores de propriedade

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

ResourceTags

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Comentários

Recursos adicionais