AzureFunctionApp@2 – tarefa implantar Azure Functions v2

Syntax

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # 'DOTNET|6.0' | 'DOTNET-ISOLATED|6.0' | 'DOTNET-ISOLATED|7.0' | 'DOTNET-ISOLATED|8.0' | 'JAVA|8' | 'JAVA|11' | 'JAVA|17' | 'JAVA|21' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'NODE|20' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10' | 'PYTHON|3.11'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # 'DOTNET|2.2' | 'DOTNET|3.1' | 'DOTNET|6.0' | 'DOTNET-ISOLATED|7.0' | 'JAVA|8' | 'JAVA|11' | 'NODE|8' | 'NODE|10' | 'NODE|12' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'PYTHON|3.6' | 'PYTHON|3.7' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

Entradas

Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Comentários

A tarefa Implantação de Funções do Azure é usada para atualizar Azure Functions para implantar o Functions no Azure. A tarefa funciona em agentes do Azure Pipelines multiplataforma que executam o Windows, Linux ou Mac e usa as tecnologias de implantação subjacentes das APIs REST RunFromPackage, Zip Deploy e Kudu.

A tarefa funciona para o Azure Functions idiomas com suporte.

Pré-requisitos para a tarefa

Os pré-requisitos a seguir precisam ser configurados nos computadores de destino para que a tarefa funcione corretamente.

Azure Function

A tarefa é usada para implantar um projeto Azure Functions em uma Função do Azure existente. O aplicativo de funções do Azure deve existir antes de executar a tarefa. O Aplicativo de Funções do Azure pode ser criado a partir do portal do Azure. Como alternativa, a tarefa Azure PowerShell pode ser usada para executar scripts do PowerShell do AzureRM para provisionar e configurar o aplicativo de funções do Azure.

A tarefa pode ser usada para implantar Azure Functions (Windows/Linux).

Assinatura do Azure

Para implantar no Azure, uma assinatura do Azure precisa ser vinculada ao Azure Pipelines usando a guia Serviços na seção Administração de Conta. Adicione a assinatura do Azure a ser usada na definição Compilar ou Release Management abrindo a tela Administração de Conta (ícone de engrenagem no canto superior direito da tela) e clique na Guia Serviços.

Create o ponto de extremidade de serviço do ARM e use o tipo de ponto de extremidade Resource Manager do Azure. Para obter mais detalhes, siga as etapas listadas no link aqui.

A tarefa não funciona com o ponto de extremidade de serviço Clássico do Azure e não listará essas conexões nos parâmetros da tarefa.

Métodos de implantação

Vários métodos de implantação estão disponíveis nesta tarefa.

Para alterar a opção de implantação baseada em pacote em uma tarefa de designer, expanda Opções adicionais de implantação e habilite Selecionar Método de Implantação.

Com base no tipo do Serviço de Aplicativo do Azure e do agente do Azure Pipelines, a tarefa usa uma tecnologia de implantação adequada. As tecnologias de implantação usadas pelas tarefas são as seguintes:

• API REST do Kudu
• Implantação de Zip
• Execução por Meio de Pacote

Por padrão, a tarefa tenta selecionar a tecnologia de implantação apropriada com base no pacote de entrada, no tipo de Serviço de Aplicativo e no sistema operacional do agente.

• Se um script pós-implantação for fornecido, use a Implantação de zip.
• Se o tipo de Serviço de Aplicativo for Aplicativo Web no Linux, use a Implantação de zip.
• Se um arquivo .war for fornecido, use Implantação de war.
• Se um arquivo .jar for fornecido, use Executar do zip.
• Para todas as outras tarefas, use Executar do Pacote (via Zip Deploy).

Em um agente não Windows (para qualquer tipo de Serviço de Aplicativo), a tarefa depende da API REST do Kudu para implantar o aplicativo Web.

API REST do Kudu

A API REST do Kudu funciona em agentes de automação do Windows e do Linux quando o destino é um Aplicativo Web no Windows, um Aplicativo Web no Linux (origem interna) ou um aplicativo de funções. A tarefa usa o Kudu para copiar arquivos para o Serviço de Aplicativo do Azure.

Implantação de zip

A Implantação de zip cria um pacote de implantação .zip do pacote ou pasta escolhido. Em seguida, ela implanta o conteúdo do arquivo na pasta wwwroot do aplicativo de funções chamado Serviço de Aplicativo no Azure. Essa opção substitui todo o conteúdo existente na pasta wwwroot. Para obter mais informações, confira Implantação de zip para o Azure Functions.

Execução a partir do pacote

Ao usar Executar do Pacote, cria-se o mesmo pacote de implantação que a Implantação de zip. Em vez de implantar arquivos na pasta wwwroot, o runtime do Functions monta o pacote inteiro. Ao usar essa opção, os arquivos na pasta wwwroot tornam-se somente leitura. Para obter mais informações, consulte Executar o Azure Functions de um arquivo de pacote.

Solução de problemas

Erro: não foi possível buscar o token de acesso para o Azure. Verifique se a entidade de serviço usada é válida e não expirou.

A tarefa usa a entidade de serviço na conexão de serviço para autenticar com o Azure. Se a entidade de serviço tiver expirado ou não tiver permissões para o Serviço de Aplicativo, a tarefa falhará com esse erro. Verifique a validade da entidade de serviço usada e se ela está presente no registro do aplicativo. Para obter mais informações, confira Usar o controle de acesso baseado em função para gerenciar o acesso aos recursos da sua assinatura do Azure. Esta postagem no blog também contém mais informações sobre como usar a autenticação da entidade de serviço.

Erro de SSL

Se você quiser usar um certificado no Serviço de Aplicativo, o certificado precisará ser assinado por uma autoridade de certificação confiável. Se o seu aplicativo Web retorna erros de validação de certificado, você provavelmente está usando um certificado autoassinado. Defina uma variável chamada VSTS_ARM_REST_IGNORE_SSL_ERRORS para o valor true no pipeline de build ou lançamento para resolver o erro.

Uma versão fica parada por muito tempo e depois falha

Esse problema pode ser resultado de capacidade insuficiente em seu plano de Serviço de Aplicativo. Para resolver esse problema, você pode escalar verticalmente a instância do Serviço de Aplicativo para aumentar a CPU, a RAM e o espaço em disco disponíveis ou pode tentar um plano diferente do Serviço de Aplicativo.

Códigos de erro 5xx

Se você estiver vendo um erro 5xx, verifique o status do serviço do Azure.

O Azure Function parou de funcionar repentinamente

Azure Functions poderá parar de funcionar repentinamente se mais de um ano tiver passado desde a última implantação. Se você implantar com "RunFromPackage" em "deploymentMethod", uma SAS com uma data de validade de 1 ano será gerada e definida como o valor de "WEBSITE_RUN_FROM_PACKAGE" na configuração do aplicativo. Azure Functions usa essa SAS para fazer referência ao arquivo de pacote para execução da função, portanto, se a SAS tiver expirado, a função não será executada. Para resolve esse problema, implante novamente para gerar uma SAS com uma data de validade de um ano.

Erro: nenhum pacote encontrado com o padrão especificado

Verifique se o pacote mencionado na tarefa está publicado como um artefato na build ou em um estágio anterior e baixado no trabalho atual.

Erro: não há suporte para publicar usando a opção de implantação zip para o tipo de pacote msBuild

Os pacotes da Web criados com a tarefa MSBuild (com argumentos padrão) têm uma estrutura de pastas aninhada que só pode ser implantada corretamente pela Implantação da Web. A opção de implantação de publicação em zip não pode ser usada para implantar esses pacotes. Para converter a estrutura de empacotamento, siga estas etapas:

1. Na tarefa Solução de build, altere MSBuild Arguments para /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl="$(System.DefaultWorkingDirectory)\\WebAppContent":

   

2. Adicione uma tarefa Arquivar e altere os valores da seguinte maneira:

   1. Altere Pasta raiz ou documento para arquivar para $(System.DefaultWorkingDirectory)\\WebAppContent.

   2. Desmarque a caixa de seleção Prefixar nome da pasta raiz para caminhos de arquivo:

      

A implantação do aplicativo de funções no Windows foi bem-sucedida, mas o aplicativo não funciona

Esse problema poderá ocorrer se um arquivo web.config não estiver presente em seu aplicativo. Você pode adicionar um arquivo web.config à sua fonte ou gerar um automaticamente usando as Definições de Aplicativo e Configuração da tarefa.

1. Selecione a tarefa e acesse Gerar parâmetros web.config para aplicativos Python, Node.js, Go e Java:

   

2. Clique no botão de mais opções (...) em Gerar parâmetros web.config para aplicativos Python, Node.js, Go e Java para editar os parâmetros:

   

3. Selecione o tipo de aplicativo na lista Estrutura do aplicativo.

4. Selecione OK. Isso preencherá os parâmetros web.config necessários para gerar o arquivo web.config.

Perguntas frequentes

Como devo configurar minha conexão de serviço?

Essa tarefa exige uma conexão de serviço do Azure Resource Manager.

Como devo configurar a implantação de trabalho Web com o Application Insights?

Ao implantar em um Serviço de Aplicativo, se você tiver o Application Insights configurado e tiver habilitado Remove additional files at destination, também precisará habilitar Exclude files from the App_Data folder. Habilitar essa opção mantém a extensão do Application Insights em um estado seguro. Essa etapa é necessária porque o WebJob contínuo do Application Insights está instalado na pasta App_Data.

Como devo configurar meu agente se ele estiver por trás de um proxy enquanto estou implantando no Serviço de Aplicativo?

Se o agente auto-hospedado exigir um proxy Web, você poderá informar o agente sobre o proxy durante a configuração. Fazer isso possibilita que seu agente se conecte ao Azure Pipelines ou Azure DevOps Server por meio do proxy. Saiba mais sobre como executar um agente auto-hospedado por trás de um proxy Web.

Não consigo implantar em um Ambiente do Serviço de Aplicativo interno usando uma conexão de serviço Resource Manager do Azure e um agente hospedado pela Microsoft

Por design, um agente hospedado pela Microsoft não funcionará com um Ambiente do Serviço de Aplicativo. Em vez disso, você precisa configurar um agente privado em uma máquina virtual que esteja na mesma rede virtual que o Ambiente do Serviço de Aplicativo. Também defina uma zona DNS privada para habilitar a comunicação entre os recursos.

Exemplos

Aqui está um snippet YAML de exemplo que implanta funções do Azure no Windows:

variables:
  azureSubscription: Contoso
  # To ignore SSL error, uncomment the below variable
  # VSTS_ARM_REST_IGNORE_SSL_ERRORS: true

steps:
- task: AzureFunctionApp@2
  displayName: Azure Function App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: samplefunctionapp
    appType: functionApp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

Para implantar uma função no Linux, adicione o parâmetro appType e defina-o como appType: functionAppLinux. Se você não especificar um valor, o padrão será functionApp.

Para especificar explicitamente o método de implantação como Implantação de zip, adicione o parâmetro deploymentMethod: zipDeploy. Outro valor com suporte para esse parâmetro é runFromPackage. Se você não especificar um valor, o padrão será auto.

Para obter um passo a passo que mostra como criar um pipeline de CI/CD (integração contínua e entrega contínua), confira Compilar e implantar o Java no Azure Functions.

Requisitos