AzureResourceManagerTemplateDeployment@3 – Tarefa de implantação de modelo do ARM v3

Use essa tarefa para implantar um modelo do ARM (Azure Resource Manager) em todos os escopos de implantação.

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template link. 
    #csmParametersFileLink: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template parameters link. 
    #csmFile: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template. 
    #csmParametersFile: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template link. 
    #csmParametersFileLink: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file. Template parameters link. 
    #csmFile: # string. Required when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template. 
    #csmParametersFile: # string. Optional. Use when (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.

de escopo de implantação deploymentScope -
string. Necessário. Valores permitidos: Management Group, Subscription, Resource Group. Valor padrão: Resource Group.

O escopo da implantação. Saiba mais sobre escopos de implantação.

azureResourceManagerConnection - de conexão do Azure Resource Manager
Alias de entrada: ConnectedServiceName. string. Necessário.

Especifica a conexão de serviço do Azure Resource Manager com acesso ao escopo de implantação selecionado.

de assinatura do subscriptionId -
Alias de entrada: subscriptionName. string. Necessário quando deploymentScope != Management Group.

Especifica a assinatura do Azure.

de Ação action -
string. Necessário quando deploymentScope = Resource Group. Valores permitidos: Create Or Update Resource Group, DeleteRG (Excluir grupo de recursos). Valor padrão: Create Or Update Resource Group.

A ação a ser executada nos recursos ou no grupo de recursos do Azure.

resourceGroupName - grupo de recursos
string. Necessário quando deploymentScope = Resource Group.

Fornece o nome de um grupo de recursos.

de Localização location -
string. Necessário quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Escopos de implantação do Grupo de Recursos: o local para implantar o grupo de recursos. Se o grupo de recursos já existir na assinatura do Azure, esse valor será ignorado. Outros escopos de implantação: o local para armazenar metadados de implantação.

templateLocation - local do modelo
string. Necessário quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valores permitidos: Linked artifact, URL of the file. Valor padrão: Linked artifact.

O local dos arquivos JSON modelo e parâmetros. Escolha artefato vinculado se os arquivos fizerem parte dos artefatos de código/build vinculados. Para artefatos vinculados, você também pode especificar o caminho para um arquivo Bicep. Escolha URL do arquivo se os arquivos JSON estiverem localizados em qualquer URL http/https acessível publicamente. Para usar um arquivo armazenado em uma conta de armazenamento privada, recupere e inclua o token SAS (assinatura de acesso compartilhado) na URL do modelo. Exemplo: <blob_storage_url>/template.json?. Para carregar um arquivo de parâmetros em uma conta de armazenamento e gerar um token SAS, você pode usar tarefa de cópia de arquivo do Azure ou seguir as etapas usando do PowerShell ou CLI do Azure.

de link do modelo de csmFileLink -
string. Necessário quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Especifica a URL do arquivo de modelo. Um exemplo de URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Para implantar um modelo armazenado em uma conta de armazenamento privada, recupere e inclua o token SAS (assinatura de acesso compartilhado) na URL do modelo. Exemplo: <blob_storage_url>/template.json?<SAStoken>. Para carregar um arquivo de modelo (ou um modelo vinculado) em uma conta de armazenamento e gerar um token SAS, use a tarefa de cópia de arquivo do Azure ou siga as etapas usando do PowerShell ou CLI do Azure.

Para exibir os parâmetros de modelo em uma grade, clique em ... ao lado da caixa de texto de parâmetros de modelo de substituição. Esse recurso requer que as regras cors estejam habilitadas na origem. Se os modelos estiverem em um blob de armazenamento do Azure, consulte de compartilhamento de recursos entre origens para habilitar o CORS.

link de parâmetros do modelo de csmParametersFileLink -
string. Opcional. Use quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = URL of the file.

Especifica a URL do arquivo de parâmetros. Um exemplo de URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Para usar um arquivo armazenado em uma conta de armazenamento privada, recupere e inclua o token SAS (assinatura de acesso compartilhado) na URL do modelo. Exemplo: <blob_storage_url>/template.json?<SAStoken>. Para carregar um arquivo de modelo (ou um modelo vinculado) em uma conta de armazenamento e gerar um token SAS, use a tarefa de cópia de arquivo do Azure ou siga as etapas usando do PowerShell ou CLI do Azure.

Para exibir os parâmetros de modelo em uma grade, clique em ... ao lado da caixa de texto Substituir parâmetros de modelo. Esse recurso requer que as regras cors estejam habilitadas na origem. Se os modelos estiverem em um blob de armazenamento do Azure, consulte de compartilhamento de recursos entre origens para habilitar o CORS.

de modelo de csmFile -
string. Necessário quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Especifica o caminho ou um padrão que aponta para o modelo do Azure Resource Manager. Saiba mais sobre modelos do Azure Resource Manager. Para começar imediatamente, use este modelo de exemplo. Dá suporte a arquivos Bicep quando a versão da CLI do Azure > 2.20.0.

parâmetros de modelo de csmParametersFile -
string. Opcional. Use quando (action = Create Or Update Resource Group || deploymentScope != Resource Group) && templateLocation = Linked artifact.

Especifique o caminho ou um padrão apontando para o arquivo de parâmetros para o modelo do Azure Resource Manager. Dá suporte arquivos Bicep Param quando a versão da CLI do Azure > 2.47.0.

overrideParameters - Substituir parâmetros de modelo
string. Opcional. Use quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Especifica os parâmetros de modelo a serem substituídos.

Para exibir os parâmetros de modelo em uma grade, clique em ... ao lado da caixa de texto Substituir Parâmetros. Esse recurso requer que as regras cors estejam habilitadas na origem. Se os modelos estiverem no blob de armazenamento do Azure, faça referência a essa cadeia de caracteres para habilitar o CORS ou digite os parâmetros de modelo a serem substituídos na caixa de texto.

Exemplo: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

Se o valor do parâmetro tiver várias palavras, coloque as palavras entre aspas, mesmo se você estiver passando o valor usando variáveis. Por exemplo, -name "parameter value" -name2 "$(var)".

Se o parâmetro que você está substituindo for um objeto, você poderá fornecer um valor usando um objeto JSON com cadeia de caracteres de linha única. Por exemplo, para substituir um parâmetro chamado settings que tem duas propriedades, você pode usar o seguinte formato: -settings "{\"key1\": \"value1\", \"key2\": \"value2\"}".

deploymentMode - modo de implantação
string. Necessário quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valores permitidos: Incremental, Complete, Validation (somente validação). Valor padrão: Incremental.

O modo Incremental manipula implantações como atualizações incrementais para o grupo de recursos. Ele deixa recursos inalterados que existem no grupo de recursos, mas não são especificados no modelo.

Complete modo exclui recursos que não estão em seu modelo. O modo completo leva relativamente mais tempo do que o modo incremental. Se a tarefa atingir o tempo limite, considere aumentar o tempo limite ou mudar para o modo de Incremental.

deploymentName - nome da implantação
string. Opcional. Use quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Especifica o nome da implantação do grupo de recursos a ser criada.

saídas de implantação deploymentOutputs -
string. Opcional. Use quando action = Create Or Update Resource Group || deploymentScope != Resource Group.

Fornece um nome para a variável para a variável de saída, que contém a seção de saídas do objeto de implantação atual no formato de cadeia de caracteres. Você pode usar o cmdlet ConvertFrom-Json PowerShell para analisar o objeto JSON e acessar os valores de saída individuais. Saiba mais sobre saídas de implantação.

detalhes da entidade de serviço do addSpnToEnvironment - Access em parâmetros de substituição
boolean. Opcional. Use quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valor padrão: false.

Adiciona a ID da entidade de serviço e a chave do ponto de extremidade do Azure escolhido para ser o ambiente de execução do script. As variáveis $servicePrincipalId e $servicePrincipalKey podem estar em parâmetros de substituição, como -key $servicePrincipalKey.

useWithoutJSON - Usar valores de saída individuais sem JSON. Stringify aplicado
boolean. Opcional. Use quando action = Create Or Update Resource Group || deploymentScope != Resource Group. Valor padrão: false.

Valores de saída individuais estão sendo convertidos via JSON. Stringify por padrão. Se você quiser usar os valores de saída como estão sem convertê-los via JSON. Stringify, habilite essa opção. Para obter mais detalhes, consulte este.

Nenhum.