> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Azure App Service Plugin

View this plugin on the Plugins site

azureWebAppPublish: Publish an Azure Web App

  • azureCredentialsId
    • Type: String
  • appName
    • Type: String
  • resourceGroup
    • Type: String
  • deleteTempImage (optional)
    If checked, the intermediate docker image will be removed from your build agent after build succeeds.
    • Type: boolean
  • deployOnlyIfSuccessful (optional)
    If checked, application will only be deployed to Azure if the build was successful.
    • Type: boolean
  • dockerFilePath (optional)
    • Type: String
  • dockerImageName (optional)
    The docker image name. Leave blank if you want to use the same name as it on Azure.
    Be sure to include the registry and account if any. See examples:
    Docker hub format: <username>/<name> eg. bitname/mysql
    Azure registry format: <namePrefix.azurecr.io>/<repo> eg. xxx.azurecr.io/mysql, xxx.azurecr.io/yyy/mysql
    • Type: String
  • dockerImageTag (optional)
    Tha tag for your image. It's recommended to use a different tag for every single build otherwise your previous images might be overridden. We suggest you to append the BuildNumber to your tag so you can easily know that with which image your web app is currently running.
    • Type: String
  • dockerRegistryEndpoint (optional)
      Nested Object
    • url
      URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
      • Type: String
    • credentialsId
      • Type: String
  • filePath (optional)

    The file paths that will be deployed.

    You can use wildcards like module/dist/**/*.py. See the includes attribute of Ant fileset for the exact format. Multiple files can be separated by ','. The base directory is the workspace. You can only deploy files that are located in your workspace.

    Examples:

    • Java

      webapps/*.war
      **/*.zip

      Note: For Java application, if you choose WAR deployment, usually you should put your war file under the 'webapps' directory.

    • PHP

      **/*.php,composer.json

    • Python

      **/*.py,requirements.txt

    • Node.js

      **/*.js,package.json,process.json
    • Type: String
  • publishType (optional)
    • Type: String
  • skipDockerBuild (optional)
    If checked, will skip building docker image and assume it already exists in the registry.
    • Type: boolean
  • slotName (optional)

    If not blank, will deploy to this deployment slot instead of the default production slot.

    See this article for more details.

    • Type: String
  • sourceDirectory (optional)
    Source directory relative to the workspace.
    • Type: String
  • targetDirectory (optional)
    Target directory relative to the site root.
    • Type: String

azureWebAppSwapSlots: Swap slots for an Azure Web App

  • azureCredentialsId
    • Type: String
  • resourceGroup
    • Type: String
  • appName
    • Type: String
  • sourceSlotName
    Source slot needs to be swapped.
    • Type: String
  • targetSlotName
    Target slot needs to be swapped. It is usually the production slot.
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.