AzureRmWebAppDeployment@3 – Azure App Service distribuera v3-uppgift

Använd den här uppgiften för att distribuera för att Azure App Service en webb-, mobil- eller API-app med Docker, Java, .NET, .NET Core, Node.js, PHP, Python eller Ruby.

Anteckning

Använd AzureFunctionApp@1 för att distribuera Azure Functions appar.

Syntax

# 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.

Indata

azureSubscription - Azure-prenumeration
Indataalias: ConnectedServiceName. string. Krävs.

Ange Azure Resource Manager-prenumerationen för distributionen.

appType - Apptyp
Indataalias: WebAppKind. string. Krävs. Tillåtna värden: app (webbapp), applinux (Linux-webbapp), functionapp (funktionsapp (rekommenderas inte, använd Azure Functions uppgift)), api (API-app) mobileapp (mobilapp). Standardvärde: app.

Ange vilken typ av webbapp som ska distribueras.

Obs! Ange Linux-webbapp för inbyggda plattformsavbildningar eller anpassade distributioner av containeravbildningar.

WebAppName - App Service namn
string. Krävs.

Ange namnet på en befintlig Azure App Service. Apptjänster baserat på den valda apptypen visas bara när du använder uppgiften assistent.

DeployToSlotFlag - Distribuera till plats
boolean. Valfritt. Använd när WebAppKind != "". Standardvärde: false.

Använd det här alternativet om du vill distribuera till ett annat befintligt fack än produktionsplatsen. Om det här alternativet inte är markerat distribueras Azure App Service till produktionsplatsen.

ResourceGroupName - Resursgrupp
string. Krävs när DeployToSlotFlag = true.

Ange den Azure-resursgrupp som innehåller Azure App Service som anges ovan.

SlotName - Slot
string. Krävs när DeployToSlotFlag = true.

Ange en annan plats än produktionsplatsen.

ImageSource - Bildkälla
string. Valfritt. Använd när WebAppKind = applinux || WebAppKind = linux. Tillåtna värden: Registry (Container Registry), Builtin (inbyggd avbildning). Standardvärde: Registry.

App Service på Linux erbjuder två olika alternativ för att publicera ditt program:

Anpassad avbildningsdistribution eller appdistribution med en inbyggd plattformsbild.

AzureContainerRegistry - Registret
string. Krävs när ImageSource = AzureContainerRegistry.

Ett globalt unikt domännamn på den översta nivån för ditt specifika register.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet: <registry>/<repository>:.<tag> Till exempel myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryLoginServer - Namn på registerinloggningsserver
string. Valfritt. Använd när ImageSource = invalidimagesource.

Ange ett inloggningsservernamn för Azure-containerregistret.

AzureContainerRegistryImage - Bild
string. Krävs när ImageSource = AzureContainerRegistry.

Namnet på lagringsplatsen där containeravbildningarna lagras.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet: <registry>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

AzureContainerRegistryTag - Etiketten
string. Valfritt. Använd när ImageSource = AzureContainerRegistry.

Det här är den mekanism som register använder för att ge Docker-avbildningar en version.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet: <registry>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

DockerRepositoryAccess - Åtkomst till lagringsplats
string. Krävs när ImageSource = invalidImage. Tillåtna värden: private, public. Standardvärde: public.

Ange åtkomst till Docker-lagringsplatsen.

dockerRegistryConnection - Registeranslutning
Indataalias: RegistryConnectedServiceName. string. Krävs när DockerRepositoryAccess = private || ImageSource = PrivateRegistry.

Ange registeranslutningen.

PrivateRegistryImage - Bild
string. Krävs när ImageSource = PrivateRegistry.

Namnet på lagringsplatsen där containeravbildningarna lagras.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet: <registry><repository>:<tag>. Till exempelmyregistry.azurecr.io/nginx:.latest

PrivateRegistryTag - Etiketten
string. Valfritt. Använd när ImageSource = PrivateRegistry.

Taggar är den mekanism som register använder för att ge Docker-avbildningar en version.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet :<registry>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

DockerNamespace - Register eller namnområde
string. Krävs när WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Ett globalt unikt domännamn på den översta nivån för ditt specifika register eller namnområde.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet: <registry or namespace>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

DockerRepository - Bild
string. Krävs när WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Namnet på lagringsplatsen där containeravbildningarna lagras.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet:<registry or namespace>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

DockerImageTag - Etiketten
string. Valfritt. Använd när WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Det här är den mekanism som register använder för att ge Docker-avbildningar en version.

Obs! Ett fullständigt kvalificerat avbildningsnamn kommer att ha formatet :<registry or namespace>/<repository>:.<tag> Till exempelmyregistry.azurecr.io/nginx:.latest

VirtualApplication - Virtuellt program
string. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Ange namnet på det virtuella program som har konfigurerats i Azure Portal. Alternativet krävs inte för distributioner till App Service-roten.

Package - Paket eller mapp
string. Krävs när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: $(System.DefaultWorkingDirectory)/**/*.zip.

Filsökvägen till paketet eller en mapp som innehåller apptjänstinnehåll som genereras av MSBuild eller en komprimerad zip- eller war-fil.

Variabler är Build och Release. Jokertecken stöds.

Exempel: $(System.DefaultWorkingDirectory)/\*\*/\*.zip eller $(System.DefaultWorkingDirectory)/\*\*/\*.war.

packageForLinux - Paket eller mapp
Indataalias: BuiltinLinuxPackage. string. Krävs när WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Standardvärde: $(System.DefaultWorkingDirectory)/**/*.zip.

Filsökvägen till paketet eller en mapp som innehåller apptjänstinnehåll som genereras av MSBuild eller en komprimerad zip- eller war-fil.

Variabler är Build och Release. Jokertecken stöds.

Exempel: $(System.DefaultWorkingDirectory)/\*\*/\*.zip eller $(System.DefaultWorkingDirectory)/\*\*/\*.war.

RuntimeStack - Körningsstack
string. Krävs när WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin.

Ange ramverket och versionen.

StartupCommand - Startkommando
string. Valfritt. Använd när WebAppKind = applinux || WebAppKind = linux.

Ange startkommandot.

WebAppUri - App Service URL
string. Valfritt. Använd när WebAppKind != "".

Ange ett namn för utdatavariabeln som genereras för URL:en för Azure App Service. Variabeln kan användas i efterföljande uppgifter.

ScriptType - Typ av distributionsskript
string. Valfritt. Använd när WebAppKind != "". Tillåtna värden: Inline Script, File Path (Sökväg till skriptfil).

Anpassar distributionen genom att tillhandahålla ett skript som ska köras på Azure App-tjänsten när uppgiften har slutfört distributionen. Detta kan till exempel återställa paket för Node-, PHP- och Python-program. Läs mer om Azure App Service distribution.

InlineScript - Infogat skript
string. Krävs när ScriptType == Inline Script && WebAppKind != "". Standardvärde: :: You can provide your deployment commands here. One command per line..

ScriptPath - Sökväg till distributionsskript
string. Krävs när ScriptType == File Path && WebAppKind != "".

GenerateWebConfig - Generera Web.config
boolean. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Standardvärde: false.

En standard Web.config genereras och distribueras till Azure App Service om programmet inte har någon. Värdena i web.config kan redigeras och variera beroende på programramverket. För programmet web.config har till exempel node.js startfil- och iis_node modulvärden. Läs mer om Azure App Service distribution.

WebConfigParameters - Web.config parametrar
string. Krävs när GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Redigerar värden som startfiler i den genererade web.config filen. Den här redigeringsfunktionen är bara för den genererade web.config. Läs mer om Azure App Service distribution.

AppSettings - Appinställningar
string.

Redigerar webbappens programinställningar enligt syntax -key-värdet . Värden som innehåller blanksteg ska omges av dubbla citattecken. Exempel: -Port 5000-WEBSITE_TIME_ZONE-RequestTimeout 5000"Eastern Standard Time".

ConfigurationSettings - Konfigurationsinställningar
string.

Redigerar konfigurationsinställningar för webbappar enligt syntaxvärdet -key . Värden som innehåller blanksteg ska omges av dubbla citattecken.

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

TakeAppOfflineFlag - Ta appen offline
boolean. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: false.

Använd det här alternativet om du vill ta Azure App Service offline genom att placera en app_offline.htm fil i rotkatalogen för App Service innan synkroniseringen påbörjas. Filen tas bort när synkroniseringen har slutförts.

UseWebDeploy - Publicera med webbdistribution
boolean. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: false.

Publish using Web Deploy alternativ stöds endast när du använder Windows-agenten. På andra plattformar förlitar sig uppgiften på Kudu REST API:er för att distribuera Azure App Service och följande alternativ stöds inte.

SetParametersFile - SetParameters-fil
string. Valfritt. Använd när UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Platsen för filen som SetParameters.xml ska användas.

RemoveAdditionalFilesFlag - Ta bort ytterligare filer på målet
boolean. Valfritt. Använd när UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: false.

Använd det här alternativet om du vill ta bort filer på Azure App Service som inte har några matchande filer i App Service-paketet eller mappen.

Obs! Detta tar också bort alla filer som är relaterade till alla tillägg som är installerade på den här Azure App Service. Om du vill förhindra detta markerar du kryssrutan Exclude files from App_Data folder .

ExcludeFilesFromAppDataFlag - Undanta filer från mappen App_Data
boolean. Valfritt. Använd när UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: false.

Använd det här alternativet för att förhindra att filer i App_Data mappen distribueras till/tas bort från Azure App Service.

AdditionalArguments - Ytterligare argument
string. Valfritt. Använd när UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

De ytterligare webdistributionsargumenten följer syntaxen -key:value.

Dessa tillämpas när du distribuerar Azure App Service. Exempel: -disableLink:AppPoolExtension-disableLink:ContentExtension.

Se fler exempel på inställningar för webbdistributionsåtgärd.

RenameFilesFlag - Byt namn på låsta filer
boolean. Valfritt. Använd när UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Standardvärde: false.

Använd det här alternativet om du vill aktivera msdeploy-flagga MSDEPLOY_RENAME_LOCKED_FILES=1 i Azure App Service programinställningar. Med alternativet kan msdeploy byta namn på låsta filer som är låsta under appdistributionen.

enableXmlTransform - XML-transformering
Indataalias: XmlTransformation. boolean. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Standardvärde: false.

Konfigurationstransformeringarna körs för *.Release.config och *.<EnvironmentName>.config på *.config file.

Konfigurationstransformeringar körs före variabelersättningen.

XML-transformeringar stöds endast för Windows-plattformen.

enableXmlVariableSubstitution - XML-variabelersättning
Indataalias: XmlVariableSubstitution. boolean. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Standardvärde: false.

Variabler som definierats i bygg- eller versionspipelinen matchas mot key posterna eller name i avsnitten appSettings, applicationSettingsoch connectionStrings i alla konfigurationsfiler och parameters.xml. Variabelersättning körs efter konfigurationstransformering.

Obs! Om samma variabler definieras i versionspipelinen och i miljön ersätter miljövariablerna versionspipelinevariablerna.

JSONFiles - JSON-variabelersättning
string. Valfritt. Använd när WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Innehåller en ny radavgränsad lista över JSON-filer som ersätter variabelvärdena. Filnamn ska anges i förhållande till rotmappen.

Om du vill ersätta JSON-variabler som är kapslade eller hierarkiska anger du dem med hjälp av JSONPath uttryck.

Om du till exempel vill ersätta värdet ConnectionString för i exemplet nedan måste du definiera en variabel som Data.DefaultConnection.ConnectionString i bygg-/versionspipelinen (eller versionspipelinens miljö).

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

Variabelersättning körs efter konfigurationstransformering.

Obs! Pipelinevariabler undantas i ersättning.

Kontrollalternativ för aktivitet

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

Utdatavariabler

Inga.

Kommentarer

Det finns en nyare version av den här uppgiften tillgänglig. Mer information finns i AzureRmWebAppDeployment@4.

Felsökning

Jag kan inte webbdistribuera till min Azure App Service med Microsoft Entra ID-autentisering från min Windows-agent

Den Azure App Service distributionsuppgiften stöder anslutning till Microsoft Azure med en ARM-tjänstanslutning med Microsoft Entra ID, såvida inte följande tre villkor finns:

• Du använder paketformatet Web Deploy på en Windows-agent
• Din agent körs med en äldre version av msdeploy.exe (till exempel när du använder den värdbaserade agentbilden windows-2019 )
• Grundläggande autentisering är inaktiverat för din Azure App Service

Om dessa tre villkor finns får du ett felmeddelande som 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.

För att lösa det här problemet kan du välja mellan följande alternativ i prioritetsordning.

1. Uppdatera agentbilden. Om du använder värdbaserade agenter flyttar du från windows-2019 till windows-2022 (eller windows-latest). Om du använder lokalt installerade agenter installerar du Visual Studio 2022 på agenten för att hämta en nyare version av msdeploy.exe.
2. Om du är beroende av en äldre agentbild och inte kan uppdatera agenten för din pipeline kan du överväga att dela upp jobbet så att Azure App Service distribuera aktiviteten körs på windows-2022 (eller windows-latest).
3. Om inget av dessa alternativ är möjligt kan du aktivera grundläggande autentisering för din Azure App Service.

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