AzureWebApp@1 – Azure Web App v1-uppgift

Den här uppgiften distribuerar en Azure Web App för Linux eller Windows.

Syntax

# Azure Web App v1
# Deploy an Azure Web App for Linux or Windows.
- task: AzureWebApp@1
  inputs:
    azureSubscription: # string. Required. Azure subscription. 
    appType: # 'webApp' | 'webAppLinux'. Required. App type. 
    appName: # string. Required. 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.
    #customDeployFolder: # string. Optional. Use when package EndsWith .war. Custom Deploy Folder. 
    #runtimeStack: # string. Optional. Use when appType = webAppLinux. Runtime stack. 
    #startUpCommand: # string. Optional. Use when appType = webAppLinux. Startup command. 
  # Application and Configuration Settings
    #customWebConfig: # string. Optional. Use when appType != webAppLinux && package NotEndsWith .war. Generate web.config parameters for Python, Node.js, Go and Java apps. 
    #appSettings: # string. App settings. 
    #configurationStrings: # string. Configuration settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar. Deployment method. Default: auto.
# Azure Web App v1
# Deploy an Azure Web App for Linux or Windows.
- task: AzureWebApp@1
  inputs:
    azureSubscription: # string. Required. Azure subscription. 
    appType: # 'webApp' | 'webAppLinux'. Required. App type. 
    appName: # string. Required. 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: # string. Optional. Use when appType = webAppLinux. Runtime stack. 
    #startUpCommand: # string. Optional. Use when appType = webAppLinux. Startup command. 
  # Application and Configuration Settings
    #customWebConfig: # string. Optional. Use when appType != webAppLinux && package NotEndsWith .war. Generate web.config parameters for Python, Node.js, Go and Java apps. 
    #appSettings: # string. App settings. 
    #configurationStrings: # string. Configuration settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar. Deployment method. Default: auto.

Indata

azureSubscription - Azure-prenumeration
string. Krävs.

Anger Azure Resource Manager-prenumerationsanslutningen för distributionen.


appType - Apptyp
string. Krävs. Tillåtna värden: webApp (Webbapp i Windows) webAppLinux (Webbapp i Linux).

Anger typen av Azure-webbapp.


appName - Appnamn
string. Krävs.

Anger namnet på en befintlig Azure App Service. Endast apptjänster som baseras på den valda apptypen visas.


deployToSlotOrASE - Distribuera till fack eller App Service-miljön
boolean. Valfritt. Använd när appType != "". Standardvärde: false.

Väljer alternativet för att distribuera till ett befintligt distributionsfack eller en Azure App Service Miljö.
För båda målen behöver uppgiften ett resursgruppsnamn.
Om distributionsmålet är en plats är standardinställningen produktionsplatsen. Alla andra befintliga facknamn kan också anges.
Om distributionsmålet är en Azure App Service Miljö lämnar du platsnamnet som "produktion" och anger resursgruppens namn.


resourceGroupName - Resursgrupp
string. Krävs när deployToSlotOrASE = true.

Resursgruppens namn krävs när distributionsmålet antingen är ett distributionsfack eller en Azure App Service miljö.
Anger den Azure-resursgrupp som innehåller de Azure App Service som anges ovan.


slotName - Slot
string. Krävs när deployToSlotOrASE = true. Standardvärde: production.

Anger ett befintligt fack, exklusive produktionsplatsen.


package - Paket eller mapp
string. Krävs. Standardvärde: $(System.DefaultWorkingDirectory)/**/*.zip.

Filsökvägen till paketet eller mappen som innehåller App Service innehåll som genereras av MSBuild, en komprimerad zip-fil eller en war-fil. Variabler (build release | ) och jokertecken stöds. Exempel: $(System.DefaultWorkingDirectory)/**/*.zip eller $(System.DefaultWorkingDirectory)/**/*.war.


customDeployFolder - Anpassad distributionsmapp
string. Valfritt. Använd när package EndsWith .war.

Anger det anpassade mappnamn som du vill distribuera till.
Om fältet är tomt distribueras paketet till <appname>.azurewebsites.net/<warpackagename>.
Om ROOT anges distribueras paketet till <appname>.azurewebsited.net.
I alla andra instanser distribueras den till <appname>.azurewebsited.net/<customWarName>.


runtimeStack - Körningsstack
string. Valfritt. Använd när appType = webAppLinux.

Webbapp i Linux erbjuder två olika alternativ för att publicera ditt program: distribution av anpassade avbildningar (Web App for Containers) och appdistribution med en inbyggd plattformsbild (Webbapp i Linux). Den här parametern är endast tillgänglig när Linux Web App väljs som en apptyp i aktiviteten.


startUpCommand - Startkommando
string. Valfritt. Använd när appType = webAppLinux.

Anger startkommandot.
Exempel:
dotnet run
dotnet filename.dll.


customWebConfig - Generera web.config parametrar för Python-, Node.js-, Go- och Java-appar
string. Valfritt. Använd när appType != webAppLinux && package NotEndsWith .war.

En standard-web.config genereras och distribueras till Azure App Service om programmet inte har någon. Värdena i web.config varierar beroende på programramverket, och de kan redigeras. För node.js-programmet har web.config till exempel en startfil och iis_node modulvärden. Den här redigeringsfunktionen gäller endast för den genererade web.config.


appSettings - Appinställningar
string.

Ange programinställningarna för webbappen med hjälp av syntaxen -key value (till exempel:-RequestTimeout 5000-Port 5000-WEBSITE_TIME_ZONE ). Omsluta värden som innehåller blanksteg med dubbla citattecken (till exempel: "Eastern Standard Time").


configurationStrings - Konfigurationsinställningar
string.

Ange konfigurationsinställningarna för webbappen med hjälp av syntaxen -key value (till exempel: -phpVersion 5.6-linuxFxVersion: node|6.11). Omsluta värden som innehåller blanksteg med dubbla citattecken.


deploymentMethod - Distributionsmetod
string. Krävs när appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar. Tillåtna värden: auto (Identifiera automatiskt), zipDeploy (Zip Deploy) runFromPackage (Kör från paket). Standardvärde: auto.

Välj distributionsmetod för appen. Godkända värden är auto, zipDeploy och runFromPackage.


Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Den här uppgiften definierar följande utdatavariabler, som du kan använda i underordnade steg, jobb och steg.

AppServiceApplicationUrl
Program-URL:en för den valda Azure App Service.

Kommentarer

Använd den här uppgiften för att distribuera webbprogram till Azure App Service.

Distributionsmetoder

Flera distributionsmetoder är tillgängliga i den här uppgiften. Auto är standardalternativet.

Om du vill ändra det paketbaserade distributionsalternativet i designeraktiviteten expanderar du Ytterligare distributionsalternativ och aktiverar Välj distributionsmetod.

Baserat på typen av Azure App Service och Azure Pipelines-agent väljer uppgiften en lämplig distributionsteknik. De olika distributionstekniker som används av uppgiften är:

  • Kudu REST API:er
  • Zip-distribution
  • RunFromPackage

Som standard försöker uppgiften välja lämplig distributionsteknik med tanke på indatapaketet, apptjänsttypen och agentoperativsystemet.

  • När apptjänsttypen är webbapp i Linux-appen använder du Zip Deploy
  • Om en War-fil tillhandahålls använder du War Deploy
  • Om en Jar-fil har angetts använder du Kör från-paketet
  • För alla andra använder du Kör från zip (via Zip Deploy)

På en icke-Windows-agent (för alla apptjänsttyper) förlitar sig uppgiften på Kudu REST-API:er för att distribuera webbappen.

Kudu REST API:er

Kudu REST-API:er fungerar på Windows- eller Linux-automatiseringsagenter när målet är Webbapp i Windows, Webbapp på Linux (inbyggd källa) eller Funktionsapp. Uppgiften använder Kudu för att kopiera filer till Azure App Service.

Zip-distribution

Skapar ett .zip distributionspaket för det valda paketet eller mappen. Filinnehållet distribueras sedan till mappen wwwroot för funktionsappen i Azure App Service. Det här alternativet skriver över allt befintligt innehåll i mappen wwwroot. Mer information finns i Zip-distribution för Azure Functions.

RunFromPackage

Skapar samma distributionspaket som Zip Deploy. Men i stället för att distribuera filer till wwwroot-mappen monteras hela paketet av Azure Functions-körningen. Med det här alternativet blir filer i mappen wwwroot skrivskyddade. Mer information finns i Kör dina Azure-funktioner från en paketfil.

Fel: Det gick inte att hämta åtkomsttoken för Azure. Kontrollera om tjänstens huvudnamn som används är giltigt och inte har upphört att gälla.

Uppgiften använder tjänstens huvudnamn i tjänstanslutningen för att autentisera med Azure. Om tjänstens huvudnamn har upphört att gälla eller inte har behörighet till App Service misslyckas uppgiften med det här felet. Kontrollera giltigheten för tjänstens huvudnamn som används och att det finns i appregistreringen. Mer information finns i Använda rollbaserad åtkomstkontroll för att hantera åtkomsten till dina Azure-prenumerationsresurser. Det här blogginlägget innehåller också mer information om hur du använder autentisering med tjänstens huvudnamn.

SSL-fel

Om du vill använda ett certifikat i App Service måste certifikatet signeras av en betrodd certifikatutfärdare. Om din webbapp visar fel i certifikatverifieringen, använder du förmodligen ett självsignerat certifikat. Ange en variabel med namnet VSTS_ARM_REST_IGNORE_SSL_ERRORS till värdet true i bygg- eller versionspipelinen för att lösa felet.

En version hänger sig en längre stund och misslyckas sedan

Det här problemet kan bero på otillräcklig kapacitet i din App Service plan. För att lösa det här problemet kan du skala upp App Service-instansen för att öka den tillgängliga processorn, RAM-minnet och diskutrymmet eller prova med en annan App Service plan.

5xx felkoder

Om du ser ett 5xx-felkontrollerar du statusen för din Azure-tjänst.

Azure-funktionen slutade plötsligt fungera

Azure Functions kan plötsligt sluta fungera om mer än ett år har gått sedan den senaste distributionen. Om du distribuerar med "RunFromPackage" i "deploymentMethod" genereras en SAS med ett förfallodatum på 1 år och anges som värdet "WEBSITE_RUN_FROM_PACKAGE" i programkonfigurationen. Azure Functions använder denna SAS för att referera till paketfilen för funktionskörning, så om SAS har upphört att gälla körs inte funktionen. Lös problemet genom att distribuera igen för att generera en SAS med ett förfallodatum på ett år.

Fel: Inget paket hittades med angivet mönster

Kontrollera om paketet som anges i aktiviteten har publicerats som en artefakt i kompileringen eller i ett tidigare skede och laddats ned i det aktuella jobbet.

Fel: Alternativet Publicera med zip-distribution stöds inte för msBuild-pakettypen

Webbpaket som skapas via MSBuild-aktiviteten (med standardargument) har en kapslad mappstruktur som endast kan distribueras korrekt av Web Deploy. Distributionsalternativet publish-to-zip kan inte användas för att distribuera dessa paket. Utför följande steg för att konvertera paketeringsstrukturen:

  1. I uppgiften Skapa lösning ändrar du MSBuild-argumenten till /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl="$(System.DefaultWorkingDirectory)\\WebAppContent":

    Skärmbild som visar värdena för build-lösningen.

  2. Lägg till en Arkiv-uppgift och ändra värdena enligt följande:

    1. Ändra rotmappen eller filen till arkivet till $(System.DefaultWorkingDirectory)\\WebAppContent.

    2. Avmarkera kryssrutan Prepend root folder name to archive paths (Förbered rotmappens namn för arkivsökvägar ):

      Skärmbild som visar arkivvärdena.

Vanliga frågor och svar

Vad är skillnaden mellan aktiviteterna AzureWebApp och AzureRmWebAppDeployment ?

Azure Web App-uppgiften (AzureWebApp) är det enklaste sättet att distribuera till en Azure-webbapp. Som standard sker distributionen till rotprogrammet i Azure-webbappen.

Uppgiften Azure App Service Deploy (AzureRmWebAppDeployment) kan hantera fler anpassade scenarier, till exempel:

Anteckning

Filtransformeringar och variabelersättning stöds också av den separata filtransformeringsaktiviteten för användning i Azure Pipelines. Du kan använda filtransformeringsaktiviteten för att tillämpa filtransformeringar och variabelersättningar på alla konfigurations- och parameterfiler.

Distribution av webbappar i Windows lyckas, men appen fungerar inte

Det kan bero på att web.config inte finns i din app. Du kan antingen lägga till en web.config fil i källan eller generera en automatiskt med hjälp av program- och konfigurationsinställningar.

  • Klicka på uppgiften och gå till Generera web.config parametrar för Python-, Node.js-, Go- och Java-appar.

    Skärmbild av dialogrutan Generera web.config parametrar.

  • Klicka på knappen ... Mer för att redigera parametrarna.

    Skärmbild av listrutan.

  • Välj din programtyp i listrutan.

  • Klicka på OK. Då fylls de web.config parametrar som krävs för att generera web.config.

Distribution av webbappar i App Service-miljön (ASE) fungerar inte

  • Kontrollera att Azure DevOps-byggagenten finns på samma virtuella nätverk (undernätet kan vara annorlunda) som den interna Load Balancer (ILB) för ASE. Detta gör att agenten kan hämta kod från Azure DevOps och distribuera till ASE.
  • Om du använder Azure DevOps behöver agenten inte vara tillgänglig från Internet, men behöver bara utgående åtkomst för att ansluta till Azure DevOps-tjänsten.
  • Om du använder TFS/Azure DevOps Server distribueras i en Virtual Network kan agenten isoleras helt.
  • Byggagenten måste konfigureras med DNS-konfigurationen för den webbapp som den behöver distribuera till. De privata resurserna i Virtual Network har inte poster i Azure DNS, så detta måste läggas till i värdens fil på agentdatorn.
  • Om ett självsignerat certifikat används för ASE-konfigurationen -allowUntrusted måste alternativet anges i distributionsuppgiften för MSDeploy. Vi rekommenderar också att du anger variabeln VSTS_ARM_REST_IGNORE_SSL_ERRORS till true. Om ett certifikat från en certifikatutfärdare används för ASE-konfiguration bör detta inte vara nödvändigt.

Hur konfigurerar jag min tjänstanslutning?

Den här uppgiften kräver en Azure Resource Manager-tjänstanslutning.

Hur konfigurerar jag distribution av webbjobb med Application Insights?

När du distribuerar till en App Service måste du även aktivera Exclude files from the App_Data folderom du har konfigurerat Application Insights och har aktiverat Remove additional files at destination. Om du aktiverar det här alternativet hålls Application Insights-tillägget i ett säkert tillstånd. Det här steget krävs eftersom det kontinuerliga webbjobbet för Application Insights installeras i mappen App_Data.

Hur konfigurerar jag min agent om den finns bakom en proxy när jag distribuerar till App Service?

Om din lokala agent kräver en webbproxy kan du informera agenten om proxyn under konfigurationen. På så sätt kan din agent ansluta till Azure Pipelines eller Azure DevOps Server via proxyn. Läs mer om att köra en lokalt installerad agent bakom en webbproxy.

Exempel

Följande är ett exempel på ett YAML-kodfragment för att distribuera webbprogram till Azure Web App Service som körs i Windows.

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

steps:

- task: AzureWebApp@1
  displayName: Azure Web App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: samplewebapp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

Om du vill distribuera Web App i Linux lägger du till parametern appType och anger den till appType: webAppLinux.

Om du vill ange distributionsmetoden som Zip Deploy lägger du till parametern deploymentMethod: zipDeploy. Ett annat värde som stöds för den här parametern är runFromPackage.

Om det inte anges auto är standardvärdet.

Krav

Krav Beskrivning
Pipelinetyper YAML, klassisk version, klassisk version
Körs på Agent, DeploymentGroup
Krav Ingen
Funktioner Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar Valfri
Inställningsbara variabler Valfri
Agentversion 2.104.1 eller senare
Uppgiftskategori Distribuera