{"id":5589,"date":"2021-03-15T19:35:17","date_gmt":"2021-03-15T19:35:17","guid":{"rendered":"https:\/\/rakhesh.com\/?p=5589"},"modified":"2021-03-15T19:35:17","modified_gmt":"2021-03-15T19:35:17","slug":"url-redirection-using-azure-app-service","status":"publish","type":"post","link":"https:\/\/rakhesh.com\/azure\/url-redirection-using-azure-app-service\/","title":{"rendered":"URL redirection using Azure App Service"},"content":{"rendered":"

A colleague had setup something along these lines at work. It’s a good idea and I couldn’t figure out any blog post or docs mentioning such a use case, so thought I’d write something up.<\/p>\n

What we wanted to do was have URL redirection. That’s to say if someone visits https:\/\/rakhesh.com I want it to forward to https:\/\/rakhesh.net. Simple stuff, and I think the recently announced Azure Front Door<\/a> can be used for the same now. Of course when he setup redirection this wasn’t available so he had to resort to other means. What he did was setup an App Service and modify its web.config<\/code> file to do IIS redirects. While I knew of App Services and knew you could modify the web.config<\/code> setting via Application Settings <\/a>I hadn’t realized you can entirely replace it.<\/p>\n

In fact, before jumping into web.config<\/code> I should probably first mention that IIS has a URL Rewrite extension and while that is something you usually install manually it is present by default in App Service<\/a>. Here’s an example web.config<\/code> that redirects all requests to Google:<\/p>\n

<configuration>\r\n    <system.webServer>\r\n      <rewrite>\r\n        <rules>\r\n          <rule name=\"Rewrite to google.com\">\r\n            <match url=\"^(.*)$\" \/>\r\n            <action type=\"Redirect\" url=\"https:\/\/www.google.com\" \/>\r\n          <\/rule>\r\n        <\/rules>\r\n      <\/rewrite>\r\n    <\/system.webServer>\r\n<\/configuration><\/pre>\n
So what one needs to do to setup a redirection service is create an App Service and somehow replace its web.config<\/code> with one similar to the above that does the redirection for you. The App Service should use IIS so we’ll go with one of the .NET ones.<\/p>\n
It’s probably easiest to create an App Service via the Portal so feel free to do it that way. Below is a rough sketch of the steps via CLI:<\/p>\n
# create a resource group\r\naz group create --name $apprg --location $location\r\n\r\n# create app service plan\r\naz appservice plan create --resource-group $apprg --name $planname --location $location --sku \"S1\"\r\n\r\n# create webapp\r\naz webapp create --resource-group $apprg --plan $planname --name $appname --runtime \"aspnet|V4.8\" --deployment-local-git<\/pre>\n
Replace all the $<\/code> variables accordingly of course.<\/p>\n
One thing I did above, which you’ll have to do manually if creating this from the portal, is to set the deployment type as local Git. Again, it doesn’t have to be local Git – you can use any other deployment method to push the web.config<\/code>, or you can totally skip this and edit the web.config<\/code> file manually (I’ll show how in a bit). But that’s what the --deployment-local-git<\/code> switch in the last command above stands for.<\/p>\n
In my case I ended up with an App Service with the following URL: https:\/\/rak-362143-wa.azurewebsites.net. Let’s say the domain I want to actually redirect is az.rakhesh.com<\/code> so what I’ll do now is 1) create a CNAME entry in DNS pointing az.rakhesh.com to rak-362143-wa.azurewebsites.net, and 2) add az.rakhesh.com as a custom domain to the App Service. Again, you can do the latter via the portal but here’s how to do it via the CLI:<\/p>\n
az webapp config hostname add --webapp-name $appname --resource-group $apprg --hostname \"az.rakhesh.com\"<\/pre>\n
Assuming no errors, we are good to proceed.<\/p>\n
(Just to add: at this point only http:\/\/az.rakhesh.com will work. To get https working I’ll have to add a cert – skipping that for now).<\/p>\n
Now onto the web.config<\/code>.<\/p>\n
I’ll go into how to modify the web.config<\/code> file directly on the App Service – i.e. not via Git like I setup above. For this we can make use of something called Kudu<\/a>. This is the engine that runs on an App Service and does the actual building of your code when you push it to an App Service. Turns out for every App Service like https:\/\/rak-362143-wa.azurewebsites.net you can go to a URL like https:\/\/rak-362143-wa.scm<\/strong><\/span>.azurewebsites.net that takes you to its Kudu page<\/a>. On this page if you click on Debug Console > PowerShell<\/code> > and in the file manager that opens if you click on the site > wwwroot<\/code> folder you can then click the +<\/code> icon to create a new web.config<\/code> file.<\/p>\n
\"\"<\/p>\n
Then click on the pencil icon next to the file, paste the web.config<\/code> text I had above and Save it. And that’s it! At this point if I go to http:\/\/az.rakhesh.com it will redirect me to Google. :)<\/p>\n
Instead of creating and editing the file via Kudu it is also possible to create a file locally and push via Git. This is why I enabled local Git deployment above. What this does is that the App Service now has a Git repo associated to it with a username password combo, and one can push to this Git repo to make any changes to the App Service.<\/p>\n
If you want to try this delete the web.config<\/code> file created above and read on…<\/p>\n
The quickest way to see the Git repo details in the Portal is to go to the Deployment Center and see Local Git\/FTPS credentials. Or to get these via the portal you can do the following:<\/p>\n
# output the username, password etc. for git\r\ngituser=`az webapp deployment list-publishing-credentials --name $appname --resource-group $apprg | jq -r '.publishingUserName'`\r\n\r\ngitpass=`az webapp deployment list-publishing-credentials --name $appname --resource-group $apprg | jq -r '.publishingPassword'`\r\n\r\ngitrepo=`az webapp deployment source config-local-git --name $appname --resource-group $apprg | jq -r '.url' | sed \"s\/None\/$gituser\/g\"`\r\n\r\necho \"Clone from $gitrepo; the password is $gitpass\"<\/pre>\n
After this change to some directory and clone $gitrepo<\/code>. Enter the password when prompted:<\/p>\n
$ git clone $gitrepo\r\nCloning into 'rak-362143-wa'...\r\nPassword for 'https:\/\/$rak-362143-wa@rak-362143-wa.scm.azurewebsites.net':\r\nwarning: You appear to have cloned an empty repository.<\/pre>\n
Next change to the folder that was created and create a folder called FolderToDeploy<\/code> in that (I didn’t do this initially and figured I had to do this from the error messages). Create web.config<\/code> in here with the same info as earlier. And do a git add .<\/code> and git commit -m \"initial commit\"<\/code> and git push<\/code> as usual. In my case it threw the following error :)<\/p>\n
Enumerating objects: 4, done.\r\nCounting objects: 100% (4\/4), done.\r\nDelta compression using up to 6 threads\r\nCompressing objects: 100% (2\/2), done.\r\nWriting objects: 100% (4\/4), 1.05 KiB | 1.05 MiB\/s, done.\r\nTotal 4 (delta 0), reused 0 (delta 0), pack-reused 0\r\nremote: The current deployment branch is 'master', but nothing has been pushed to it\r\nremote: Error - Changes committed to remote repository but deployment to website failed.\r\nTo https:\/\/rak-362143-wa.scm.azurewebsites.net\/rak-362143-wa.git\r\n * [new branch]      main -> main<\/pre>\n
This bummed me for a while until I realized that locally my Git repo branch was called main<\/code> while in Azure it was master<\/code>. So I made a new branch locally called master<\/code>, set the upstream, and pushed again. This time it worked! (Note<\/strong>: if you are following along, don’t do this yet. Read on for one more issue I encountered, fix it, and then push)<\/em>.<\/p>\n
# create a new local branch\r\ngit checkout -b master\r\n\r\n# push the current branch and set the remote as upstream\r\ngit push --set-upstream origin master<\/pre>\n
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0\r\nremote: Updating branch 'master'.\r\nremote: Updating submodules.\r\nremote: Preparing deployment for commit id '387ad970b1'.\r\nremote: Generating deployment script.\r\nremote: Generating deployment script for Web Site\r\nremote: Running deployment command...\r\nremote: Handling Basic Web Site deployment.\r\nremote: Creating app_offline.htm\r\nremote: KuduSync.NET from: 'D:\\home\\site\\repository' to: 'D:\\home\\site\\wwwroot'\r\nremote: Deleting file: 'hostingstart.html'\r\nremote: Copying file: 'FolderToDeploy\\web.config'\r\nremote: Deleting app_offline.htm\r\nremote: Finished successfully.\r\nremote: Running post deployment command(s)...\r\nremote: Triggering recycle (preview mode disabled).\r\nremote: Deployment successful.\r\nTo https:\/\/rak-362143-wa.scm.azurewebsites.net\/rak-362143-wa.git\r\n * [new branch]      master -> master\r\nBranch 'master' set up to track remote branch 'master' from 'origin'.<\/pre>\n
Sweet!<\/p>\n
Unfortunately this too does not work. :D What happens is the web.config<\/code> has been copied to a folder called FolderToDeploy<\/code> but that’s of no use to us as we want it to be in the root of wwwroot<\/code>. The trick to get it to copy over as I want is in this article<\/a>. What I have to do is set the following in the Application Settings of the app:<\/p>\n
SCM_SCRIPT_GENERATOR_ARGS=--basic -p FolderToDeploy<\/code><\/pre>\n
I can do that via the CLI as follows:<\/p>\n
az webapp config appsettings set --resource-group $apprg --name $appname --settings SCM_SCRIPT_GENERATOR_ARGS=\"--basic -p FolderToDeploy\"<\/pre>\n
Now I can push the config again. This time you’ll see it removes the FolderToDeploy<\/code> after the code is pushed:<\/p>\n
[master 5a6191c] changes\r\n 1 file changed, 1 insertion(+), 1 deletion(-)\r\nEnumerating objects: 7, done.\r\nCounting objects: 100% (7\/7), done.\r\nDelta compression using up to 6 threads\r\nCompressing objects: 100% (2\/2), done.\r\nWriting objects: 100% (4\/4), 981 bytes | 981.00 KiB\/s, done.\r\nTotal 4 (delta 1), reused 0 (delta 0), pack-reused 0\r\nremote: Updating branch 'master'.\r\nremote: Updating submodules.\r\nremote: Preparing deployment for commit id '5a6191c539'.\r\nremote: Generating deployment script.\r\nremote: The site directory path: .\\FolderToDeploy\r\nremote: Generating deployment script for Web Site\r\nremote: Running deployment command...\r\nremote: Handling Basic Web Site deployment.\r\nremote: Creating app_offline.htm\r\nremote: KuduSync.NET from: 'D:\\home\\site\\repository\\FolderToDeploy' to: 'D:\\home\\site\\wwwroot'\r\nremote: Deleting file: 'FolderToDeploy\\web.config'\r\nremote: Deleting directory: 'FolderToDeploy'\r\nremote: Copying file: 'web.config'\r\nremote: Deleting app_offline.htm\r\nremote: Finished successfully.\r\nremote: Running post deployment command(s)...\r\nremote: Triggering recycle (preview mode disabled).\r\nremote: Deployment successful.\r\nTo https:\/\/rak-362143-wa.scm.azurewebsites.net\/rak-362143-wa.git\r\n   387ad97..5a6191c  master -> master<\/pre>\n
Now if I go to http:\/\/az.rakhesh.com\/ it will redirect as expected!<\/p>\n","protected":false},"excerpt":{"rendered":"
A colleague had setup something along these lines at work. It’s a good idea and I couldn’t figure out any blog post or docs mentioning such a use case, so thought I’d write something up. What we wanted to do was have URL redirection. That’s to say if someone visits https:\/\/rakhesh.com I want it to … Continue reading URL redirection using Azure App Service<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[887],"tags":[1012,999,55,1013],"jetpack_publicize_connections":[],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/5589"}],"collection":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/comments?post=5589"}],"version-history":[{"count":0,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/5589\/revisions"}],"wp:attachment":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/media?parent=5589"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/categories?post=5589"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/tags?post=5589"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}