How to automate Azure App Service deployment slots for dev/staging environments

About Deployment Slots

Azure web app service has a fantastic feature called “Deployment Slots”, available on standard or premium mode pricing tiers. This feature allows you to spin up multiple slots (full instances) of your web application for test/development and staging uses.

What’s great about using deployment slots? First – you can test changes to your application in the cloud without impacting production. Second, using the ‘swap’ feature allows you to seamlessly promote a secondary slot into the primary production slot. This means you can perform web application code updates with no user impact or downtime.

When a slot swap occurs, the source IIS instance is ‘warmed up’ for you immediately before the swap. This allows new incoming web requests to be immediately be serviced at the swap destination.

Slot settings and extensions

Since deployment slots are full app service instances – they have their own separate configuration, url/bindings, app settings, and extensions. When you create a new slot, the settings can to be cloned from another instance/slot if needed. If you have extensions or webjobs running in production, those will also need to be installed in the deployment slots separately because they aren’t included in the settings to be cloned.

Azure app service settings also have a flag called ‘Slot Setting’. Checking that box for a setting means that the setting and value will not migrate to another slot when you perform a swap. An example might be a database connection string that only applies to staging and not production. You don’t want that setting value moved to production when you promote that instance to the production slot – you want it to stick to whatever is running in the staging slot. [Further reading].

Automating deployment slots with PowerShell

You will need to have the Azure PowerShell module installed and understand how to connect to your Azure resources. This article covers that.

In our example scenario, I have created a web application called “keithbabinec-test1”, in a resource group called “TestRG1”. I run Get-AzureRmWebApp just to make sure we can see/access our web application in PowerShell. If you can’t find your website, the later commands won’t work because you probably have a resource access issue.

PS C:\> $mysite = Get-AzureRmWebApp -Name "keithbabinec-test1"
PS C:\> $mysite | fl Name, State, HostNames

Name      : keithbabinec-test1
State     : Running
HostNames : {}

To create a new slot, we run the New-AzureRmWebAppSlot cmdlet. Provide the resource group name, the web application name, and the name of the slot to be created.

PS C:\> New-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1" -Slot "Staging"

SiteName                  : keithbabinec-test1(Staging)
State                     : Running
HostNames                 : {}

A new web application output is dumped to the console/pipeline. We can see the staging name appended in the new url/hostname provided from Azure.

To remove the slot, simply run Remove-AzureRmWebAppSlot with the same parameters.

PS C:\> Remove-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1" -Slot "Staging"

Reminder: these are full web application instances that can be stopped and started just like production. Here are the examples for start & stop actions.

PS C:\> Stop-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1" -Slot "Staging"

SiteName                  : keithbabinec-test1(Staging)
State                     : Stopped
HostNames                 : {}
PS C:\> Start-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1" -Slot "Staging"

SiteName                  : keithbabinec-test1(Staging)
State                     : Running
HostNames                 : {}

Want to list already created slots? Run this:

PS C:\> Get-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1"

SiteName                  : keithbabinec-test1(Staging)
State                     : Running
HostNames                 : {}

Tip: When you run Get-AzureRmWebAppSlot to list the slots for a web application, you won’t see the production slot in the output. It just shows the secondary slots you have created. The production slot always exists and is named ‘production’ for the purposes of slot related commands. Here is the swap command:

PS C:\> Switch-AzureRmWebAppSlot -ResourceGroupName "TestRG1" -Name "keithbabinec-test1" -SourceSlotName "Staging" -DestinationSlotName "Production"

You can swap with production, or swap with another named slot. In the example above I swapped with the implicitly named production slot.

When the swap is successful, no output will be dumped to the PowerShell console/pipeline. If the source or destination slot aren’t found, for example, you will receive errors.

Slot access

Depending on how you created the slot and if you cloned from a configuration – newly created slots are likely public-accessible by default at the hostname/url provided by Azure. It would be wise to lock down those slot instances if you don’t want the world to see the secondary slots. One way to do this would be to configure dynamic IP restrictions in the web application settings for the slots you create.

One thought on “How to automate Azure App Service deployment slots for dev/staging environments

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s