az webapp deployment github-actions

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: <owner>/<repository-name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch -b

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

Property	Value
Default value:	master

--force -f

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

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

Property	Value
Parameter group:	Resource Id Arguments

--login-with-github

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False