az functionapp deployment source
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
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.
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)
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
Repository url to pull the latest source from, e.g. https://github.com/foo/foo-web.
Optional Parameters
The branch name of the repository.
Git access token required for auto sync.
If using GitHub action, default to False.
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.
Disable automatic sync between source control and web.
Name of the function app.
Repository type.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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-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
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp deployment source config-zip
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
A zip file path for deployment.
Optional Parameters
Enable remote build during deployment.
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Configurable timeout in seconds for checking the status of deployment.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
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
A zip file path for deployment.
Optional Parameters
Enable remote build during deployment.
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Configurable timeout in seconds for checking the status of deployment.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp deployment source delete
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
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp deployment source show
Get the details of a source control deployment configuration.
az functionapp deployment source show [--ids]
[--name]
[--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
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp deployment source sync
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
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp deployment source update-token
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.
az functionapp deployment source update-token [--git-token]
Optional Parameters
Git access token required for auto sync.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI