az webapp deployment github-actions

  • Reference

Configure GitHub Actions for a webapp.

Commands

Name Description Type Status
az webapp 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 webapp.

 Core GA
az webapp deployment github-actions remove

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

 Core GA

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

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

Examples

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

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

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

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

Required Parameters

--repo

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

Optional Parameters

--branch -b

The branch to which the workflow file will be added. Defaults to "master" if not specified.

default value: master
--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 web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

--runtime -r

Canonicalized web runtime in the format of Framework|Version, e.g. "PHP|5.6". Use "az webapp list-runtimes" for available list.

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

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

az webapp 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 webapp deployment github-actions remove --repo "githubUser/githubRepo" -g MyResourceGroup -n MyWebapp --token MyPersonalAccessToken

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

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

Required Parameters

--repo

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

Optional Parameters

--branch -b

The branch to which the workflow file will be added. Defaults to "master" if not specified.

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 web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

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