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
The GitHub repository to which the workflow file will be added. In the format: /.
Optional Parameters
The branch to which the workflow file will be added. Defaults to "master" if not specified.
When true, the command will overwrite any workflow file with a conflicting name.
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.
Interactively log in with GitHub to retrieve the Personal Access Token.
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>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Canonicalized web runtime in the format of Framework|Version, e.g. "PHP|5.6". Use "az webapp list-runtimes" for available list.
The name of the slot. Default to the production slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
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 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
The GitHub repository to which the workflow file will be added. In the format: /.
Optional Parameters
The branch to which the workflow file will be added. Defaults to "master" if not specified.
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.
Interactively log in with GitHub to retrieve the Personal Access Token.
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>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot. Default to the production slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
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.