Edit

Share via

az functionapp deployment source

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage function app deployment via source control.

Commands

Name Description Type Status
az functionapp deployment source config

Manage deployment from git or Mercurial repositories.

 Core GA
az functionapp deployment source config-local-git

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

 Core GA
az functionapp deployment source config-zip

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

 Core GA
az functionapp deployment source config-zip (appservice-kube extension)

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

 Extension GA
az functionapp deployment source delete

Delete a source control deployment configuration.

 Core GA
az functionapp deployment source show

Get the details of a source control deployment configuration.

 Core GA
az functionapp deployment source sync

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

 Core GA
az functionapp deployment source update-token

Update source control token cached in Azure app service.

 Core GA

az functionapp deployment source config

Edit

Manage deployment from git or Mercurial repositories.

Note that the GitHub action password is now redacted in the result. Please use the az functionapp deployment source show command to view the GitHub action password.

Azure CLI 
az functionapp deployment source config --repo-url
                                        [--branch]
                                        [--git-token]
                                        [--github-action]
                                        [--ids]
                                        [--manual-integration]
                                        [--name]
                                        [--repository-type {externalgit, git, github, localgit, mercurial}]
                                        [--resource-group]
                                        [--slot]
                                        [--subscription]

Examples

Manage deployment from git or Mercurial repositories. (autogenerated)

Azure CLI 
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

--branch

The branch name of the repository.

--git-token

Git access token required for auto sync.

--github-action

If using GitHub action, default to False.

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

--repository-type

Repository type.

Accepted values: externalgit, git, github, localgit, mercurial
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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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.

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

Examples

Get an endpoint and add it as a git remote.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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.

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az functionapp deployment source config-zip (appservice-kube extension)

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.

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

Azure CLI 
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
Default value: False
--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az functionapp deployment source delete

Edit

Delete a source control deployment configuration.

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

Examples

Delete a source control deployment configuration. (autogenerated)

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az functionapp deployment source show

Edit

Get the details of a source control deployment configuration.

Azure CLI 
az functionapp deployment source show [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--slot]
                                      [--subscription]

Examples

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

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az functionapp deployment source sync

Edit

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

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

Examples

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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. Note that tokens are now redacted in the result.

Azure CLI 
az functionapp deployment source update-token [--git-token]

Optional Parameters

--git-token

Git access token required for auto sync.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.