Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az functionapp deployment github-actions

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

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
 [--acquire-policy-token]
 [--branch]
 [--build-path]
 [--change-reference]
 [--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/<owner>/<repository-name> or <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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--branch -b

The branch to which the workflow file will be added.

Property Value
Default value: master
--build-path

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

Property Value
Default value: .
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
Parameter group: Github Arguments
Default value: False
--name -n

Name of the function app.

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

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.

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.

Property Value
Parameter group: Github Arguments

az functionapp deployment github-actions remove

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

az functionapp deployment github-actions remove --repo
 [--acquire-policy-token]
 [--branch]
 [--change-reference]
 [--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/<owner>/<repository-name> or <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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--branch -b

The branch to which the workflow file will be added.

Property Value
Default value: master
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
Parameter group: Github Arguments
Default value: False
--name -n

Name of the function app.

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

Property Value
Parameter group: Github Arguments

Feedback

Was this page helpful?