Share via

az functionapp deployment github-actions

  • Reference

Configure GitHub Actions for a functionapp.

Commands

Name Description Type Status
az functionapp deployment github-actions add

Add a GitHub Actions workflow file to the specified repository. The workflow will build and deploy your app to the specified functionapp.

 Core GA
az functionapp deployment github-actions remove

Remove and disconnect the GitHub Actions workflow file from the specified repository.

 Core GA

az functionapp deployment github-actions add

Edit

Add a GitHub Actions workflow file to the specified repository. The workflow will build and deploy your app to the specified functionapp.

az functionapp deployment github-actions add --repo
                                             [--branch]
                                             [--build-path]
                                             [--force]
                                             [--ids]
                                             [--login-with-github]
                                             [--name]
                                             [--resource-group]
                                             [--runtime]
                                             [--runtime-version]
                                             [--slot]
                                             [--subscription]
                                             [--token]

Examples

Add GitHub Actions to a specified repository, providing personal access token

az functionapp deployment github-actions add --repo "githubUser/githubRepo" -g MyResourceGroup -n MyFunctionapp --token MyPersonalAccessToken

Add GitHub Actions to a specified repository, using interactive method of retrieving personal access token

az functionapp deployment github-actions add --repo "githubUser/githubRepo" -g MyResourceGroup -n MyFunctionapp --login-with-github

Required Parameters

--repo

The GitHub repository to which the workflow file will be added. In the format: https://github.com// or /.

Optional Parameters

--branch -b

The branch to which the workflow file will be added.

Default value: master
--build-path

Path to the build requirements. Ex: package path, POM XML directory.

Default value: .
--force -f

When true, the command will overwrite any workflow file with a conflicting name.

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.

--login-with-github

Interactively log in with Github to retrieve the Personal Access Token.

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

--runtime -r

The functions runtime stack. Use "az functionapp list-runtimes" to check supported runtimes and versions.

--runtime-version -v

The version of the functions runtime stack. The functions runtime stack. Use "az functionapp list-runtimes" to check supported runtimes and versions.

--slot -s

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

--subscription

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

--token

A Personal Access Token with write access to the specified repository. For more information: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line.

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 github-actions remove

Edit

Remove and disconnect the GitHub Actions workflow file from the specified repository.

az functionapp deployment github-actions remove --repo
                                                [--branch]
                                                [--ids]
                                                [--login-with-github]
                                                [--name]
                                                [--resource-group]
                                                [--slot]
                                                [--subscription]
                                                [--token]

Examples

Remove GitHub Actions from a specified repository, providing personal access token

az functionapp deployment github-actions remove --repo "githubUser/githubRepo" -g MyResourceGroup -n MyFunctionapp --token MyPersonalAccessToken

Remove GitHub Actions from a specified repository, using interactive method of retrieving personal access token

az functionapp deployment github-actions remove --repo "githubUser/githubRepo" -g MyResourceGroup -n MyFunctionapp --login-with-github

Required Parameters

--repo

The GitHub repository to which the workflow file will be added. In the format: https://github.com// or /.

Optional Parameters

--branch -b

The branch to which the workflow file will be added.

Default value: master
--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.

--login-with-github

Interactively log in with Github to retrieve the Personal Access Token.

Default value: False
--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 production slot if not specified.

--subscription

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

--token

A Personal Access Token with write access to the specified repository. For more information: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line.

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.