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 az functionapp deployment source configManage 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 ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property Value Parameter group: Resource Id ArgumentsDisable automatic sync between source control and web.
Name of the function app.
Property Value Parameter group: Resource Id ArgumentsRepository type.
Property Value Default value: git Accepted values: externalgit, git, github, localgit, mercurialName 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
.
Increase logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source config-local-gitGet 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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
.
Increase logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source config-zipPerform 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 ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Enable remote build during deployment.
Property Value Accepted values: false, trueOne 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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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 ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False 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 ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Enable remote build during deployment.
Property Value Default value: False Accepted values: false, trueOne 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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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 ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source deleteDelete 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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
.
Increase logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source showGet 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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
.
Increase logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source syncSynchronize 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property Value Parameter group: Resource Id ArgumentsName of the function app.
Property Value Parameter group: Resource Id ArgumentsName 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
.
Increase logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: False az functionapp deployment source update-tokenUpdate 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Git access token required for auto sync.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath 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.
Property Value Default value: FalseRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4