How to write "az cli" script to deploy WebApp in Github

Siegfried Heintze 1,906

Please help me write a script to deploy a blazor server web application whose C# source is in a Github repo. My first choice is "azure CLI" commands inside a "ps1" file.

Attempt #1

Here is my first attempt after having successfully created a webapp plan for the free tier:

az webapp create --name webapp-protected-helloworld --resource-group $env:rg --runtime "dotnet:6" --plan plan-webapp
az webapp deployment source config --repo-url "https://github.com/siegfried01/DemoVisualStudioCICDForBlazorServer001.git" --branch main --name webapp-protected-helloworld --repository-type git --resource-group $env:rg

I get this error message:

 ERROR: Cannot find SourceControlToken with name GitHub.

I tried bing/google searching the error message and even tried edge copilot and could not find any good hints

Attempt #2

I thought well maybe the problem is that my sln and csproj files are not in the top level directory. So I created a new git repo and tried again:

az appservice plan create -g $env:rg -n plan-webapp --sku B1 -l $env:webloc
az webapp create --name HelloBlazorSvr --resource-group $env:rg --plan plan-webapp
az webapp deployment source config --repo-url "https://github.com/siegfried01/HelloBlazorSvr.git" --branch main --name HelloBlazorSvr --repository-type git --resource-group $env:rg

I received this error:

ERROR: Operation returned an invalid status 'OK'

Since the repos I specified are public I think I should not need a github access token.

Thanks

Siegfried

2 answers

VenkateshDodda-MSFT 22,636 Reputation points Microsoft Employee

2024-05-14T06:34:43.2833333+00:00
@Siegfried Heintze Thanks for reaching out to Microsoft Q&A, apologize for any inconvenience caused on this.

To repro this behavior, I have created an app service and tried to deploy the code by adding the source control using the cmdlet. I am able to link deploy the source code from the repo successfully as well.

az webapp deployment source config -g <resource-groupname> -n <WebAppName> --repo-url <GithubUrl> --branch <BranchName> --manual-integration

As per the cmdlet documentation of az webapp deployment source config --git-token parameter is not a mandatory/required parameter, and this should not break the operation as well.

Also, --git-token property is not required for the public repositories and the shared cmdlet operation might be failed because of a different reason.

I would suggest you try using the above shared cmdlet or try running your cmdlet in debug mode by appending --debug at the end.

Let me know if you are still facing the issue or if you have any further questions on this.
Please sign in to rate this answer.

1 person found this answer helpful.
Siegfried Heintze 1,906 Reputation points

2024-05-14T15:40:52.7533333+00:00

Thank you (once again) VenkateshDodda. I forgot to specify the branch! Now it works!

Please tell me about the --manual-integration. How does it work if I don't specify this switch? How do I configure this automatic synchronization feature? Can I make my web app automatically update when I do a new push to the master branch when I push? How would I configure this? Please point me to the docs!

Thanks

siegfried

VenkateshDodda-MSFT 22,636 Reputation points Microsoft Employee

2024-05-15T05:17:54.7966667+00:00

Siegfried Heintze Thanks for your follow-up questions and response. Glad to know that your problem has been resolved.

Please tell me about the --manual-integration. How does it work if I don't specify this switch? How do I configure this automatic synchronization feature?

If you configure --manual-integration this will create a webhook in the repository and webhooks deploy the changes to app service made in that repo.

If you want to limit the changes getting deployed to app service then set this property to true to limit to manual integration; false to enable continuous integration.

Can I make my web app automatically update when I do a new push to the master branch when I push? How would I configure this? Please point me to the docs!

This mechanism can be achieved by using GitHub actions or through manual integration as well.

In GitHub actions allows you building, testing and deploying code which are defined in the custom .yaml file whereas webhooks are HTTP callbacks that notify external services about events that occur within a GitHub repository.

Refer to this GitHub discussion to know more information about webhooks and actions.

Hope this helps let me know if you still have any further questions on this.

Siegfried Heintze (ARTECH CONSULTING LLC) 0 Reputation points Microsoft Vendor

2024-05-21T17:53:58.32+00:00

I thought of more questions!

Siegfried Heintze (ARTECH CONSULTING LLC) 0 Reputation points Microsoft Vendor

2024-05-21T22:46:17.0233333+00:00

VenkateshDodda:

I looked at those links and I still don't understand.

I did not see any examples in those links. Are there some examples of this feature somewhere?I'm familiar with using github actions inside of github workflows via the custom yaml files that are triggered by "git push"'s. Does this automatic integration feature only work with custom github work flows defined in yaml files?

Thank does not make sense because I see that "az webapp deployment source config" works great with no custom github work flow yaml files.

Thanks

siegfried

VenkateshDodda-MSFT 22,636 Reputation points Microsoft Employee

2024-05-22T05:28:06.64+00:00

Siegfried Heintze (ARTECH CONSULTING LLC) Thanks for the follow-up questions on this.

If you use --manual-integration to false, whatever the git push changes that were made to the repo will be deployed to app service using webhooks.

When you use the --github-action property in your cmdlet, a default .yaml file is created with predefined steps to build and deploy your application code using GitHub actions. You can customize this file as per your requirements.

If you prefer to use an existing .yaml file present in the repository instead of creating a new one when using the --github-action property in the az webapp deployment source config cmdlet, I recommend configuring the source control using the portal instead of CLI cmdlets

I hope the initial ask of this question has been addressed and if you still have any further questions on this. Please raise/post a new question to get them addressed.

Please accept as Yes if the answer provided is useful , so that you can help others in the community looking for remediation for similar issues.

Siegfried Heintze (ARTECH CONSULTING LLC) 0 Reputation points Microsoft Vendor

2024-05-23T00:48:55.34+00:00

Thank you Venkatesh for your answers. Consider this closed.

VenkateshDodda-MSFT 22,636 Reputation points Microsoft Employee

2024-05-23T04:35:16.34+00:00

Siegfried Heintze (ARTECH CONSULTING LLC) Thanks for your response.

Please accept as Yes if the answer provided is useful , so that you can help others in the community looking for remediation for similar issues.

Siegfried Heintze (ARTECH CONSULTING LLC) 0 Reputation points Microsoft Vendor

2024-05-29T00:35:17.64+00:00

See responses from VenkateshDodda.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.
Bruce (SqlWork.com) 68,311 Reputation points

2024-05-10T22:43:09.7333333+00:00

on the az webapp deployment source config you need to supply a --git-token or use --manual-integration

note: I typically use GitHub actions to deploy
Please sign in to rate this answer.
Siegfried Heintze (ARTECH CONSULTING LLC) 0 Reputation points Microsoft Vendor

2024-05-14T01:10:39.1733333+00:00

I tried --manual-integration and it did not work.

Is it necessary to specify a token for a public repo? I hope not. This is a public repo and we are just grabbing copy. I will try a token later but I'm hoping you can help me make this work without a token.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

How to write "az cli" script to deploy WebApp in Github

2 answers

Your answer