This action is a wrapper for the Azure command line: az webapp deployment source config-zip. If you're having trouble using this action, or any of the Azure actions, please refer to the Azure command line reference.
The Deploy Azure Web App action is a premium action that can be used to deploy the files for a Web App to Azure.
Before deploying an Azure web app, you will need a Resource Group and an existing Web App. Generally, you would use the DotNet Publish Action, or MSBuild Action to copy the required files to a source directory for this action.
See also the Create Azure Web App Action and Delete Azure Web App Action.
A friendly name for this action (will be displayed in the actions workflow area).
Determines if this action will be run within the relevant stage.
The folder where the command line executable is run. This is optional and defaults to the workspace folder.
Generally you will need to log in to Azure before running this action and log out afterwards. If you have several Azure actions in a stage, you can avoid repeated logins by unchecking the Login action on all but the first Azure action and unchecking the Logout action on all but the last Azure action. The Authentication tab will be shown if either of these options is ticked.
The path to the zip file or directory to deploy to Azure. If a directory is entered, a temporary zip file will be created of all the files in the directory and its subdirectories and this will be deployed to Azure. [--src]
If this ticked, the web app is identified by its resource ID.
This field is visible only if the checkbox 'Use resource ID(s)' is ticked.
List of resource IDs of web apps to deploy to. One ID per line. [--ids]
This field is visible only if the checkbox 'Use resource ID(s)' is not ticked.
The name of web app to deploy to. [--name]
This field is visible only if the checkbox 'Use resource ID(s)' is not ticked.
The name of the resource group the web app is under. [--resource-group]
The version of the Azure command line to use. It is important that the agent has the correct version of the Azure command line installed for command provided.
The Using drop down is populated with any property collector whose namespace matches the pattern defined by the Create Azure Resource Group action. The pattern for this action is ^Azure.Cli.*
If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "Azure Command".
For more in-depth explanations on property collectors see Property Collectors.
Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.
Tick this to log in or out using a service principal instead of a username and password. An Azure service principal is an identity created for use with applications, hosted services, and automated tools to access Azure resources. This access is restricted by the roles assigned to the service principal, giving you control over which resources can be accessed and at which level. For security reasons, it's always recommended to use service principals with automated tools rather than allowing them to log in with a user identity. [login --service-principal]
Enter a username to log into the Azure cloud. This is generally an email address. [login|logout --username]
The password associated with the Azure username. [login --username]
Enter the application name or the URL associated with the service principal. [login --service-principal --username]
Enter the service principal password, or the path to a X509 certificate used to create the service principal in PEM format. [login --service-principal --password]
Enter the tenant associated with the service principal, as either an .onmicrosoft.com domain or Azure object ID. [login --service-principal --tenant]
Tick to support automatic certificate rollovers with service principals configured with Subject Name and Issuer Authentication. [login --use-cert-sn-issuer]
The name of the slot. Leave empty to default to the production slot. [--slot]
The time in seconds to wait for the storage container to be created. Leave zero to wait until complete. [--timeout]
The name or ID of the subscription to use. If omitted the default subscription for your environment will be used. [--subscription]
Select the name of the build variable to set with the id of the deployment.
Select the name of the build variable to set with the site name of the deployed web app.
Select the name of the build variable to set with the URL the deployment.
Select the name of the build variable to set with the URL of the deployment log.
The amount of information detail to display in the build log.
How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).
How many seconds to wait for the Azure commands to respond with output before timing out. Leave zero to wait until the main timeout.
Tick to continue build on failure marking the action with a warning status.
If this is ticked, any warnings logged will not mark the action with a warning status.
Multiple environment variables can be defined - one per line. These are set before the command line is run.
If this is ticked, environment variable values are written to the build log.
Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.
This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.
If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.