az functionapp deployment source

  • Reference

Manage function app deployment via source control.

Commands

az functionapp deployment source config

Manage deployment from git or Mercurial repositories.
az functionapp deployment source config-local-git

Get a URL for a git repository endpoint to clone and push to for function app deployment.
az functionapp deployment source config-zip

Perform deployment using the kudu zip push deployment for a function app.
az functionapp deployment source delete

Delete a source control deployment configuration.
az functionapp deployment source show

Get the details of a source control deployment configuration.
az functionapp deployment source sync

Synchronize from the repository. Only needed under manual integration mode.
az functionapp deployment source update-token

Update source control token cached in Azure app service.

az functionapp deployment source config

Edit

Manage deployment from git or Mercurial repositories.

az functionapp deployment source config --repo-url
                                        [--app-working-dir]
                                        [--branch]
                                        [--cd-account-create]
                                        [--cd-app-type {AspNet, AspNetCore, NodeJS, PHP, Python}]
                                        [--cd-project-url]
                                        [--git-token]
                                        [--ids]
                                        [--manual-integration]
                                        [--name]
                                        [--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}]
                                        [--resource-group]
                                        [--slot]
                                        [--slot-swap]
                                        [--subscription]
                                        [--test]

Examples

Manage deployment from git or Mercurial repositories. (autogenerated)

az functionapp deployment source config --branch master --manual-integration --name MyFunctionApp --repo-url https://github.com/Azure-Samples/function-image-upload-resize --resource-group MyResourceGroup

Required Parameters

--repo-url -u

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

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.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--manual-integration

Disable automatic sync between source control and web.

--name -n

Name of the function app.

--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
--resource-group -g

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

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--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 functionapp deployment source config-local-git

Edit

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

az functionapp deployment source config-local-git [--ids]
                                                  [--name]
                                                  [--resource-group]
                                                  [--slot]
                                                  [--subscription]

Examples

Get an endpoint and add it as a git remote.

az functionapp deployment source config-local-git \
    -g MyResourceGroup -n MyUniqueApp

git remote add azure \
    https://{deploy_user_name}@MyUniqueApp.scm.azurewebsites.net/MyUniqueApp.git

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp deployment source config-zip

Edit

Perform deployment using the kudu zip push deployment for a function app.

By default Kudu assumes that zip deployments do not require any build-related actions like npm install or dotnet publish. This can be overridden by including an .deployment file in your zip file with the following content '[config] SCM_DO_BUILD_DURING_DEPLOYMENT = true', to enable Kudu detection logic and build script generation process. See https://github.com/projectkudu/kudu/wiki/Configurable-settings#enabledisable-build-actions-preview. Alternately the setting can be enabled using the az functionapp config appsettings set command.

az functionapp deployment source config-zip --src
                                            [--build-remote {false, true}]
                                            [--ids]
                                            [--name]
                                            [--resource-group]
                                            [--slot]
                                            [--subscription]
                                            [--timeout]

Examples

Perform deployment by using zip file content.

az functionapp deployment source config-zip \
    -g {myRG} -n {myAppName} \
    --src {zipFilePathLocation}

Required Parameters

--src

A zip file path for deployment.

Optional Parameters

--build-remote

Enable remote build during deployment.

accepted values: false, true
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout -t

Configurable timeout in seconds for checking the status of deployment.

az functionapp deployment source delete

Edit

Delete a source control deployment configuration.

az functionapp deployment source delete [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--slot]
                                        [--subscription]

Examples

Delete a source control deployment configuration. (autogenerated)

az functionapp deployment source delete --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp deployment source show

Edit

Get the details of a source control deployment configuration.

az functionapp deployment source show [--ids]
                                      [--name]
                                      [--query-examples]
                                      [--resource-group]
                                      [--slot]
                                      [--subscription]

Examples

Get the details of a source control deployment configuration. (autogenerated)

az functionapp deployment source show --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--slot -s

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp deployment source sync

Edit

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

az functionapp deployment source sync [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--slot]
                                      [--subscription]

Examples

Synchronize from the repository. Only needed under manual integration mode. (autogenerated)

az functionapp deployment source sync --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp deployment source update-token

Edit

Update source control token cached in Azure app service.

If no token is provided, the command will clean up existing token.

az functionapp deployment source update-token [--git-token]
                                              [--subscription]

Optional Parameters

--git-token

Git access token required for auto sync.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.