Skip to content

Latest commit

 

History

History
231 lines (187 loc) · 8.18 KB

azure-web-app-container-v1.md

File metadata and controls

231 lines (187 loc) · 8.18 KB
title description ms.date monikerRange
AzureWebAppContainer@1 - Azure Web App for Containers v1 task
Deploy containers to Azure App Service.
05/14/2024
>=azure-pipelines-2019.1

AzureWebAppContainer@1 - Azure Web App for Containers v1 task

:::moniker range=">=azure-pipelines-2019.1"

This task deploys containers to Azure App Service.

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2019.1"

# Azure Web App for Containers v1
# Deploy containers to Azure App Service.
- task: AzureWebAppContainer@1
  inputs:
    azureSubscription: # string. Required. Azure subscription. 
    appName: # string. Required. App name. 
    #deployToSlotOrASE: false # boolean. 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.
    #containers: # string. Alias: imageName. Image name. 
    #multicontainerConfigFile: # string. Configuration File. 
    #containerCommand: # string. Startup command. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
    #configurationStrings: # string. Configuration settings.

:::moniker-end

Inputs

:::moniker range=">=azure-pipelines-2019.1"

azureSubscription - Azure subscription
string. Required.

The name of the Azure Resource Manager subscription for the deployment.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

appName - App name
string. Required.

Specifies the name of an existing Azure App Service. Only app services based on the selected app type will be listed.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

deployToSlotOrASE - Deploy to Slot or App Service Environment
boolean. Default value: false.

Selects the option to deploy to an existing deployment slot or an Azure App Service Environment.
For both targets, the task needs a resource group name.
If the deployment target is a slot, the default is the production slot. Any other existing slot name can also be provided.
If the deployment target is an Azure App Service Environment, leave the slot name as production, and specify the resource group name.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

resourceGroupName - Resource group
string. Required when deployToSlotOrASE = true.

The resource group name is required when the deployment target is either a deployment slot or an Azure App Service Environment.
Specifies the Azure resource group that contains the Azure App Service indicated above.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

slotName - Slot
string. Required when deployToSlotOrASE = true. Default value: production.

Specifies an existing slot, excluding the production slot.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

containers - Image name
Input alias: imageName. string.

Specifies the fully qualified container image name. For example, myregistry.azurecr.io/nginx:latest or python:3.7.2-alpine/.
For a multi-container scenario, multiple container image names can be provided.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

multicontainerConfigFile - Configuration File
string.

The path of the Docker-Compose file. Must be a fully qualified path or a path relative to the default working directory.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

containerCommand - Startup command
string.

Specifies the start up command.
For example:
dotnet run
dotnet filename.dll


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

appSettings - App settings
string.

Edits the web app application settings using the syntax -key value (for example: -Port 5000 -RequestTimeout 5000 -WEBSITE_TIME_ZONE). A value containing spaces should be enclosed in double quotes (for example: "Eastern Standard Time").


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

configurationStrings - Configuration settings
string.

Edits the web app application settings using the syntax -key value (for example: -phpVersion 5.6 -linuxFxVersion: node|6.11). A value containing spaces should be enclosed in double quotes.


:::moniker-end

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

:::moniker range=">=azure-pipelines-2019.1"

This task defines the following output variables, which you can consume in downstream steps, jobs, and stages.

AppServiceApplicationUrl
The application URL of the selected Azure App Service.

:::moniker-end

Requirements

:::moniker range=">=azure-pipelines-2019.1"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 2.104.1 or greater
Task category Deploy

:::moniker-end