az webapp deployment source

Manage web app deployment via source control.

Commands

az webapp deployment source config Manage deployment from git or Mercurial repositories.
az webapp deployment source config-local-git Get a URL for a git repository endpoint to clone and push to for web app deployment.
az webapp deployment source config-zip Perform deployment using the kudu zip push deployment for a webapp.
az webapp deployment source delete Delete a source control deployment configuration.
az webapp deployment source show Get the details of a source control deployment configuration.
az webapp deployment source sync Synchronize from the repository. Only needed under manual integration mode.
az webapp deployment source update-token Update source control token cached in Azure app service.

az webapp deployment source config

Manage deployment from git or Mercurial repositories.

az webapp deployment source config --name
                                   --repo-url
                                   --resource-group
                                   [--app-working-dir]
                                   [--branch]
                                   [--cd-account-create]
                                   [--cd-app-type {AspNet, AspNetCore, NodeJS, PHP, Python}]
                                   [--cd-project-url]
                                   [--git-token]
                                   [--manual-integration]
                                   [--nodejs-task-runner {Grunt, Gulp, None}]
                                   [--private-repo-password]
                                   [--private-repo-username]
                                   [--python-framework {Bottle, Django, Flask}]
                                   [--python-version {Python 2.7.12 x64, Python 2.7.12 x86, Python 2.7.13 x64, Python 2.7.13 x86, Python 3.5.3 x64, Python 3.5.3 x86, Python 3.6.0 x64, Python 3.6.0 x86, Python 3.6.1 x86, Python 3.6.2 x64}]
                                   [--repository-type {externalgit, git, github, localgit, mercurial, vsts}]
                                   [--slot]
                                   [--slot-swap]
                                   [--test]

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--repo-url -u

Repository url to pull the latest source from, e.g. https://github.com/foo/foo-web.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--app-working-dir

Working directory of the application. Default will be root of the repo.

--branch

The branch name of the repository.

--cd-account-create

To create a new Visual Studio Team Services (VSTS) account if it doesn't exist already.

--cd-app-type

Web application framework you used to develop your app. Default is AspNet.

accepted values: AspNet, AspNetCore, NodeJS, PHP, Python
--cd-project-url

URL of the Visual Studio Team Services (VSTS) project to use for continuous delivery. URL should be in format https://<accountname>.visualstudio.com/<projectname>.

--git-token

Git access token required for auto sync.

--manual-integration

Disable automatic sync between source control and web.

--nodejs-task-runner

Task runner for nodejs. Default is None.

accepted values: Grunt, Gulp, None
--private-repo-password

Password for the private repository.

--private-repo-username

Username for the private repository.

--python-framework

Framework used for Python application. Default is Django.

accepted values: Bottle, Django, Flask
--python-version

Python version used for application. Default is Python 3.5.3 x86.

accepted values: Python 2.7.12 x64, Python 2.7.12 x86, Python 2.7.13 x64, Python 2.7.13 x86, Python 3.5.3 x64, Python 3.5.3 x86, Python 3.6.0 x64, Python 3.6.0 x86, Python 3.6.1 x86, Python 3.6.2 x64
--repository-type

Repository type.

accepted values: externalgit, git, github, localgit, mercurial, vsts
default value: git
--slot -s

The name of the slot. Default to the productions slot if not specified.

--slot-swap

Name of the slot to be used for deployment and later promote to production. If slot is not available, it will be created. Default: Not configured.

--test

Name of the web app to be used for load testing. If web app is not available, it will be created. Default: Disable.

az webapp deployment source config-local-git

Get a URL for a git repository endpoint to clone and push to for web app deployment.

az webapp deployment source config-local-git --name
                                             --resource-group
                                             [--slot]

Examples

Get an endpoint and add it as a git remote.

az webapp source-control config-local-git \
                            -g MyResourceGroup -n MyUniqueApp
                        
                        git remote add azure \
                            https://<deploy_user_name>@MyUniqueApp.scm.azurewebsites.net/MyUniqueApp.git

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp deployment source config-zip

Perform deployment using the kudu zip push deployment for a webapp.

az webapp deployment source config-zip --name
                                       --resource-group
                                       --src
                                       [--slot]

Examples

Perform deployment by using zip file content.

az webapp deployment source config-zip \
                            -g <myRG> -n <myAppName> \
                            --src <zip file path location>

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--src

A zip file path for deployment.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp deployment source delete

Delete a source control deployment configuration.

az webapp deployment source delete --name
                                   --resource-group
                                   [--slot]

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp deployment source show

Get the details of a source control deployment configuration.

az webapp deployment source show --name
                                 --resource-group
                                 [--slot]

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp deployment source sync

Synchronize from the repository. Only needed under manual integration mode.

az webapp deployment source sync --name
                                 --resource-group
                                 [--slot]

Required Parameters

--name -n

Name of the web. You can configure the default using 'az configure --defaults web='.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp deployment source update-token

Update source control token cached in Azure app service.

az webapp deployment source update-token [--git-token]

Optional Parameters

--git-token

Git access token required for auto sync.