AzureRmWebAppDeployment@3 – Tarefa de implantação do Serviço de Aplicativo do Azure v3

Use essa tarefa para implantar no Serviço de Aplicativo do Azure um aplicativo Web, móvel ou de API usando Docker, Java, .NET, .NET Core, Node.js, PHP, Python ou Ruby.

Esta versão da tarefa foi preterida; use AzureRmWebAppDeployment@4 para aproveitar os recursos mais recentes, como de federação de identidade de carga de trabalho.

Use essa tarefa para implantar no Serviço de Aplicativo do Azure um aplicativo Web, móvel ou de API usando Docker, Java, .NET, .NET Core, Node.js, PHP, Python ou Ruby.

# Azure App Service deploy v3
# Deploy to Azure App Service a web, mobile, or API app using Docker, Java, .NET, .NET Core, Node.js, PHP, Python, or Ruby.
- task: AzureRmWebAppDeployment@3
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    appType: 'app' # 'app' | 'applinux' | 'functionapp' | 'api' | 'mobileapp'. Alias: WebAppKind. Required. App type. Default: app.
    WebAppName: # string. Required. App Service name. 
    #DeployToSlotFlag: false # boolean. Optional. Use when WebAppKind != "". Deploy to slot. Default: false.
    #ResourceGroupName: # string. Required when DeployToSlotFlag = true. Resource group. 
    #SlotName: # string. Required when DeployToSlotFlag = true. Slot. 
    #ImageSource: 'Registry' # 'Registry' | 'Builtin'. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Image Source. Default: Registry.
    #AzureContainerRegistry: # string. Required when ImageSource = AzureContainerRegistry. Registry. 
    #AzureContainerRegistryLoginServer: # string. Optional. Use when ImageSource = invalidimagesource. Registry Login Server Name. 
    #AzureContainerRegistryImage: # string. Required when ImageSource = AzureContainerRegistry. Image. 
    #AzureContainerRegistryTag: # string. Optional. Use when ImageSource = AzureContainerRegistry. Tag. 
    #DockerRepositoryAccess: 'public' # 'private' | 'public'. Required when ImageSource = invalidImage. Repository Access. Default: public.
    #dockerRegistryConnection: # string. Alias: RegistryConnectedServiceName. Required when DockerRepositoryAccess = private || ImageSource = PrivateRegistry. Registry Connection. 
    #PrivateRegistryImage: # string. Required when ImageSource = PrivateRegistry. Image. 
    #PrivateRegistryTag: # string. Optional. Use when ImageSource = PrivateRegistry. Tag. 
    #DockerNamespace: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Registry or Namespace. 
    #DockerRepository: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Image. 
    #DockerImageTag: # string. Optional. Use when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Tag. 
    #VirtualApplication: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Virtual application. 
    #Package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required when WebAppKind != linux && WebAppKind != applinux &&  WebAppKind != "". Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #packageForLinux: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Alias: BuiltinLinuxPackage. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #RuntimeStack: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Runtime Stack. 
    #StartupCommand: # string. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Startup command. 
  # Output
    #WebAppUri: # string. Optional. Use when WebAppKind != "". App Service URL. 
  # Post Deployment Action
    #ScriptType: # 'Inline Script' | 'File Path'. Optional. Use when WebAppKind != "". Deployment script type. 
    #InlineScript: ':: You can provide your deployment commands here. One command per line.' # string. Required when ScriptType == Inline Script && WebAppKind != "". Inline Script. Default: :: You can provide your deployment commands here. One command per line..
    #ScriptPath: # string. Required when ScriptType == File Path && WebAppKind != "". Deployment script path. 
  # File Transforms & Variable Substitution Options
    #GenerateWebConfig: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Generate Web.config. Default: false.
    #WebConfigParameters: # string. Required when GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Web.config parameters. 
    #enableXmlTransform: false # boolean. Alias: XmlTransformation. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML transformation. Default: false.
    #enableXmlVariableSubstitution: false # boolean. Alias: XmlVariableSubstitution. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML variable substitution. Default: false.
    #JSONFiles: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. JSON variable substitution. 
  # Application and Configuration Settings
    #AppSettings: # string. App settings. 
    #ConfigurationSettings: # string. Configuration settings. 
  # Additional Deployment Options
    #TakeAppOfflineFlag: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Take App Offline. Default: false.
    #UseWebDeploy: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Publish using Web Deploy. Default: false.
    #SetParametersFile: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". SetParameters file. 
    #RemoveAdditionalFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Remove additional files at destination. Default: false.
    #ExcludeFilesFromAppDataFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Exclude files from the App_Data folder. Default: false.
    #AdditionalArguments: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Additional arguments. 
    #RenameFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Rename locked files. Default: false.

azureSubscription - assinatura do Azure
Alias de entrada: ConnectedServiceName. string. Obrigatório

Especifique a assinatura do Azure Resource Manager para a implantação.

appType - tipo de aplicativo
Alias de entrada: WebAppKind. string. Obrigatório Valores permitidos: app (Aplicativo Web), applinux (Aplicativo Web Linux), functionapp (Aplicativo de Funções (Não Recomendado, Usar Tarefa do Azure Functions)), api (Aplicativo de API), mobileapp (Aplicativo Móvel). Valor padrão: app.

Especifique o tipo de aplicativo Web a ser implantado.

Observação: especifique o Aplicativo Web Linux para imagens de plataforma internas ou implantações personalizadas de imagem de contêiner.

appType - tipo de aplicativo
Alias de entrada: WebAppKind. string. Obrigatório Valores permitidos: app (Aplicativo Web), applinux (Aplicativo Web Linux), functionapp (Aplicativo de Funções), api (Aplicativo de API), mobileapp (Aplicativo Móvel). Valor padrão: app.

Especifique o tipo de aplicativo Web a ser implantado.

Observação: especifique o Aplicativo Web Linux para imagens de plataforma internas ou implantações personalizadas de imagem de contêiner.

WebAppName - nome do Serviço de Aplicativo
string. Obrigatório

Especifique o nome de um Serviço de Aplicativo do Azure existente. Os serviços de aplicativo com base no tipo de aplicativo selecionado só serão listados ao usar o assistente de tarefa.

DeployToSlotFlag - Implantar no slot
boolean. Opcional. Use quando WebAppKind != "". Valor padrão: false.

Use essa opção para implantar em um slot existente diferente do slot de produção. Se essa opção não estiver selecionada, o Serviço de Aplicativo do Azure será implantado no slot de produção.

ResourceGroupName - grupo de recursos
string. Necessário quando DeployToSlotFlag = true.

Especifique o grupo de recursos do Azure que contém o Serviço de Aplicativo do Azure especificado acima.

de slot do
string. Necessário quando DeployToSlotFlag = true.

Especifique um slot existente diferente do slot de produção.

de origem da imagem ImageSource -
string. Opcional. Use quando WebAppKind = applinux || WebAppKind = linux. Valores permitidos: Registry (Registro de Contêiner), Builtin (Imagem Interna). Valor padrão: Registry.

O Serviço de Aplicativo no Linux oferece duas opções diferentes para publicar seu aplicativo:

Implantação de imagem personalizada ou implantação de aplicativo com uma imagem de plataforma interna.

AzureContainerRegistry - do Registro
string. Necessário quando ImageSource = AzureContainerRegistry.

Um nome de domínio de nível superior global exclusivo para seu registro específico.

Observação: um nome de imagem totalmente qualificado será do formato: <registry>/<repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryLoginServer - nome do servidor de logon do Registro
string. Opcional. Use quando ImageSource = invalidimagesource.

Especifique um nome de servidor de logon do Registro de Contêiner do Azure.

AzureContainerRegistryImage - Imagem
string. Necessário quando ImageSource = AzureContainerRegistry.

O nome do repositório em que as imagens de contêiner são armazenadas.

Observação: um nome de imagem totalmente qualificado será do formato: <registry>/<repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryTag -
string. Opcional. Use quando ImageSource = AzureContainerRegistry.

Esse é o mecanismo que os registros usam para dar uma versão às imagens do Docker.

Observação: um nome de imagem totalmente qualificado será do formato: <registry>/<repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

DockerRepositoryAccess - de Acesso ao Repositório
string. Necessário quando ImageSource = invalidImage. Valores permitidos: private, public. Valor padrão: public.

Especifique o acesso ao repositório do Docker.

de Conexão do Registro dockerRegistryConnection -
Alias de entrada: RegistryConnectedServiceName. string. Necessário quando DockerRepositoryAccess = private || ImageSource = PrivateRegistry.

Especifique a conexão do Registro.

PrivateRegistryImage - Imagem
string. Necessário quando ImageSource = PrivateRegistry.

O nome do repositório em que as imagens de contêiner são armazenadas.

Observação: um nome de imagem totalmente qualificado será do formato: <registry><repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

PrivateRegistryTag -
string. Opcional. Use quando ImageSource = PrivateRegistry.

As marcas são o mecanismo que os registros usam para dar uma versão às imagens do Docker.

Observação: um nome de imagem totalmente qualificado será do formato: '<registry>/<repository>:<tag>'. Por exemplo, myregistry.azurecr.io/nginx:latest.

DockerNamespace - Registro ou namespace
string. Necessário quando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Um nome de domínio de nível superior global exclusivo para seu registro ou namespace específico.

Observação: um nome de imagem totalmente qualificado será do formato: <registry or namespace>/<repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

DockerRepository - Imagem
string. Necessário quando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

O nome do repositório em que as imagens de contêiner são armazenadas.

Observação: um nome de imagem totalmente qualificado será do formato: '<registry or namespace>/<repository>:<tag>. Por exemplo, myregistry.azurecr.io/nginx:latest.

DockerImageTag -
string. Opcional. Use quando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Esse é o mecanismo que os registros usam para dar uma versão às imagens do Docker.

Observação: um nome de imagem totalmente qualificado será do formato: '<registry or namespace>/<repository>:<tag>'. Por exemplo, myregistry.azurecr.io/nginx:latest.

VirtualApplication - aplicativo virtual
string. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Especifique o nome do Aplicativo Virtual que foi configurado no portal do Azure. A opção não é necessária para implantações na raiz do Serviço de Aplicativo.

pacote Package - ou de pasta
string. Necessário quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: $(System.DefaultWorkingDirectory)/**/*.zip.

O caminho do arquivo para o pacote ou uma pasta que contém o conteúdo do serviço de aplicativo gerado pelo MSBuild ou um arquivo zip compactado ou de guerra.

As variáveis são de build ede versão . caracteres curinga têm suporte.

Por exemplo, $(System.DefaultWorkingDirectory)/\*\*/\*.zip ou $(System.DefaultWorkingDirectory)/\*\*/\*.war.

pacote packageForLinux - ou de pasta
Alias de entrada: BuiltinLinuxPackage. string. Necessário quando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Valor padrão: $(System.DefaultWorkingDirectory)/**/*.zip.

O caminho do arquivo para o pacote ou uma pasta que contém o conteúdo do serviço de aplicativo gerado pelo MSBuild ou um arquivo zip compactado ou de guerra.

As variáveis são de build ede versão . caracteres curinga têm suporte.

Por exemplo, $(System.DefaultWorkingDirectory)/\*\*/\*.zip ou $(System.DefaultWorkingDirectory)/\*\*/\*.war.

RuntimeStack - de pilha de runtime
string. Necessário quando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin.

Especifique a estrutura e a versão.

de comando de inicialização do
string. Opcional. Use quando WebAppKind = applinux || WebAppKind = linux.

Especifique o comando de inicialização.

de URL do Serviço de Aplicativo WebAppUri -
string. Opcional. Use quando WebAppKind != "".

Especifique um nome para a variável de saída gerada para a URL do Serviço de Aplicativo do Azure. A variável pode ser usada em tarefas subsequentes.

ScriptType - tipo de script de implantação
string. Opcional. Use quando WebAppKind != "". Valores permitidos: Inline Script, File Path (caminho do arquivo de script).

Personaliza a implantação fornecendo um script que será executado no serviço de Aplicativo do Azure depois que a tarefa tiver concluído a implantação com êxito. Por exemplo, isso pode restaurar pacotes para aplicativos Node, PHP e Python. Saiba mais sobre de Implantação do Serviço de Aplicativo do Azure.

InlineScript - script embutido
string. Necessário quando ScriptType == Inline Script && WebAppKind != "". Valor padrão: :: You can provide your deployment commands here. One command per line..

ScriptPath - caminho de script de implantação
string. Necessário quando ScriptType == File Path && WebAppKind != "".

GenerateWebConfig - gerar Web.config
boolean. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor padrão: false.

Um Web.config padrão será gerado e implantado no Serviço de Aplicativo do Azure se o aplicativo não tiver um. Os valores em web.config podem ser editados e variam de acordo com a estrutura do aplicativo. Por exemplo, para o aplicativo node.js, web.config terá valores de arquivo de inicialização e módulo iis_node. Saiba mais sobre de Implantação do Serviço de Aplicativo do Azure.

parâmetros WebConfigParameters - Web.config
string. Necessário quando GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Edita valores como arquivos de inicialização no arquivo de web.config gerado. Esse recurso de edição é apenas para o web.configgerado. Saiba mais sobre de Implantação do Serviço de Aplicativo do Azure.

configurações do aplicativo AppSettings -
string.

Edita as configurações do aplicativo Web seguindo a sintaxe -key valor. Os valores que contêm espaços devem ser colocados entre aspas duplas. Exemplos: -Port 5000-RequestTimeout 5000-WEBSITE_TIME_ZONE"Eastern Standard Time".

configurações de configuração ConfigurationSettings -
string.

Edita as configurações de aplicativo Web seguindo a sintaxe -key valor. Os valores que contêm espaços devem ser colocados entre aspas duplas.

Exemplos: -phpVersion 5.6-linuxFxVersion: node|6.11.

TakeAppOfflineFlag - levar o aplicativo offline
boolean. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: false.

Use essa opção para colocar o Serviço de Aplicativo do Azure offline colocando um arquivo app_offline.htm no diretório raiz do Serviço de Aplicativo antes do início da operação de sincronização. O arquivo será removido após a conclusão da operação de sincronização com êxito.

UseWebDeploy - Publicar usando de Implantação da Web
boolean. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: false.

Publish using Web Deploy opções têm suporte somente ao usar o agente do Windows. Em outras plataformas, a tarefa depende de APIs REST do Kudu para implantar o Serviço de Aplicativo do Azure e as opções a seguir não têm suporte.

SetParametersFile - de arquivo SetParameters
string. Opcional. Use quando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

O local do arquivo SetParameters.xml a ser usado.

RemoveAdditionalFilesFlag - Remover arquivos adicionais no destino
boolean. Opcional. Use quando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: false.

Use essa opção para excluir arquivos no Serviço de Aplicativo do Azure que não têm arquivos correspondentes no pacote ou pasta do Serviço de Aplicativo.

Observação: isso também removerá todos os arquivos relacionados a qualquer extensão instalada neste Serviço de Aplicativo do Azure. Para evitar isso, marque a caixa de seleção Exclude files from App_Data folder.

ExcludeFilesFromAppDataFlag - Excluir arquivos da pasta App_Data
boolean. Opcional. Use quando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: false.

Use essa opção para impedir que arquivos na pasta App_Data sejam implantados/excluídos do Serviço de Aplicativo do Azure.

AdditionalArguments - argumentos adicionais
string. Opcional. Use quando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Os argumentos adicionais de Implantação da Web após a sintaxe -key:value.

Elas serão aplicadas ao implantar o Serviço de Aplicativo do Azure. Exemplos: -disableLink:AppPoolExtension-disableLink:ContentExtension.

Veja mais exemplos de configurações de operação de implantação da Web .

RenameFilesFlag - Renomear arquivos bloqueados
boolean. Opcional. Use quando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor padrão: false.

Use essa opção para habilitar o sinalizador msdeploy MSDEPLOY_RENAME_LOCKED_FILES=1 nas configurações do aplicativo do Serviço de Aplicativo do Azure. A opção permite que o msdeploy renomeie arquivos bloqueados bloqueados durante a implantação do aplicativo.

enableXmlTransform - de transformação XML
Alias de entrada: XmlTransformation. boolean. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor padrão: false.

As transformações de configuração serão executadas para *.Release.config e *.<EnvironmentName>.config no *.config file.

As transformações de configuração serão executadas antes da Substituição variável.

As transformações XML têm suporte apenas para a plataforma Windows.

enableXmlVariableSubstitution - de substituição de variável XML
Alias de entrada: XmlVariableSubstitution. boolean. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor padrão: false.

As variáveis definidas no pipeline de build ou lançamento serão correspondidas às entradas key ou name nas seções appSettings, applicationSettingse connectionStrings de qualquer arquivo de configuração e parameters.xml. A Substituição de Variável é executada após transformações de configuração.

Observação: se as mesmas variáveis forem definidas no pipeline de lançamento e no ambiente, as variáveis de ambiente substituirão as variáveis de pipeline de versão.

JSONFiles - de substituição de variável JSON
string. Opcional. Use quando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Fornece uma nova lista separada por linhas de arquivos JSON para substituir os valores de variável. Os nomes de arquivos devem ser fornecidos em relação à pasta raiz.

Para substituir variáveis JSON aninhadas ou hierárquicas, especifique-as usando expressões JSONPath.

Por exemplo, para substituir o valor de ConnectionString no exemplo abaixo, você precisa definir uma variável como Data.DefaultConnection.ConnectionString no pipeline de build/versão (ou no ambiente do pipeline de lançamento).

{
  "Data": {
    "DefaultConnection": {
      "ConnectionString": "Server=(localdb)\SQLEXPRESS;Database=MyDB;Trusted_Connection=True"
    }
  }
}

A Substituição de Variável é executada após transformações de configuração.

Observação: as variáveis de pipeline são excluídas na substituição.

Nenhum.

Resolução de problemas

Não consigo implantar na Web em meu Serviço de Aplicativo do Azure usando a autenticação da ID do Microsoft Entra do meu agente do Windows

A tarefa de implantação do Serviço de Aplicativo do Azure dá suporte à conexão ao Microsoft Azure com uma conexão de serviço ARM usando a ID do Microsoft Entra, a menos que as três condições a seguir estejam presentes:

• Você está usando o formato de pacote de implantação da Web em um agente do Windows
• Seu agente está em execução com uma versão mais antiga do msdeploy.exe (por exemplo, ao usar o windows-2019 imagem do agente hospedado)
• A autenticação básica está desabilitada para o Serviço de Aplicativo do Azure

Se essas três condições estiverem presentes, você receberá um erro como App Service is configured to not use basic authentication. This requires Web Deploy msdeploy.exe version 7.1.7225.2108 or higher. You need a version of Visual Studio that includes an updated version of msdeploy.exe. For more information, visit https://aka.ms/azdo-webapp-msdeploy.

Para resolver esse problema, você pode escolher entre as opções a seguir, em ordem de preferência.

1. Atualize a imagem do agente. Se você estiver usando agentes hospedados, passe de windows-2019 para windows-2022 (ou mais recentes do Windows). Se você estiver usando agentes auto-hospedados, instale o Visual Studio 2022 no agente para obter uma versão mais recente do msdeploy.exe.
2. Se você depender de uma imagem de agente mais antiga e não puder atualizar o agente para o pipeline, considere dividir o trabalho para que a tarefa de implantação do Serviço de Aplicativo do Azure seja executada no windows-2022 (ou mais recente do Windows).
3. Se nenhuma dessas opções for possível, você poderá habilitar de autenticação básica para o Serviço de Aplicativo do Azure.