Azure Web App - Slot Swap | Octopus Integrations

Octopus.AzurePowerShell exported 2020-06-25 by harrisonmeister belongs to ‘Azure’ category.

Swaps an azure web app slot. Defaults to the deployment slot defined in the web app target.

Note This template is designed to run against an azure web app octopus target

Depends on Azure CLI and powershell to be installed on the running machine

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Azure Account

azureWebAppSwap.AzAccount =

null

Target Slot

azWebAppSwap.targetSlot =

null

Source Slot

azWebAppSwap.sourceSlot = #{Octopus.Action.Azure.DeploymentSlot}

null

Script body

Steps based on this template will execute the following PowerShell script.

$rg = $OctopusParameters["Octopus.Action.Azure.ResourceGroupName"]
$webAppName = $OctopusParameters["Octopus.Action.Azure.WebAppName"]
$destinationSlot = $OctopusParameters["azWebAppSwap.targetSlot"]
$sourceSlot = $OctopusParameters["azWebAppSwap.sourceSlot"]

if([string]::IsNullOrEmpty($sourceSlot))
{
	throw "value for source slot must be provided"
}

$cmdArgs = "-g $rg -n $webAppName -s $sourceSlot"

if(![string]::IsNullOrEmpty($destinationSlot)) {$cmdArgs += " --target-slot $destinationSlot"}

$cmd = "az webapp deployment slot swap $cmdArgs"

write-verbose "command being invoked: $cmd"

Invoke-Expression $cmd

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "f256502a-4143-4d29-914e-80e541b05783",
  "Name": "Azure Web App - Slot Swap",
  "Description": "Swaps an azure web app slot. Defaults to the deployment slot defined in the web app target.\n<hr />\n\n*<p>Note This template is designed to run against an azure web app octopus target </p>*\n*<p>Depends on Azure CLI and powershell to be installed on the running machine</p>*",
  "Version": 3,
  "ExportedAt": "2020-06-25T15:05:37.259Z",
  "ActionType": "Octopus.AzurePowerShell",
  "Author": "harrisonmeister",
  "Packages": [],
  "Parameters": [
    {
      "Id": "a204505b-f995-40ff-95b3-300638d9b9df",
      "Name": "azureWebAppSwap.AzAccount",
      "Label": "Azure Account",
      "HelpText": null,
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "AzureAccount"
      }
    },
    {
      "Id": "0b3383f9-31ae-402c-af57-be3b82a3d5b9",
      "Name": "azWebAppSwap.targetSlot",
      "Label": "Target Slot",
      "HelpText": null,
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "7e4ed213-d5bb-4725-b13f-78e366535479",
      "Name": "azWebAppSwap.sourceSlot",
      "Label": "Source Slot",
      "HelpText": null,
      "DefaultValue": "#{Octopus.Action.Azure.DeploymentSlot}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "PowerShell",
    "Octopus.Action.Script.ScriptBody": "$rg = $OctopusParameters[\"Octopus.Action.Azure.ResourceGroupName\"]\n$webAppName = $OctopusParameters[\"Octopus.Action.Azure.WebAppName\"]\n$destinationSlot = $OctopusParameters[\"azWebAppSwap.targetSlot\"]\n$sourceSlot = $OctopusParameters[\"azWebAppSwap.sourceSlot\"]\n\nif([string]::IsNullOrEmpty($sourceSlot))\n{\n\tthrow \"value for source slot must be provided\"\n}\n\n$cmdArgs = \"-g $rg -n $webAppName -s $sourceSlot\"\n\nif(![string]::IsNullOrEmpty($destinationSlot)) {$cmdArgs += \" --target-slot $destinationSlot\"}\n\n$cmd = \"az webapp deployment slot swap $cmdArgs\"\n\nwrite-verbose \"command being invoked: $cmd\"\n\nInvoke-Expression $cmd",
    "Octopus.Action.Azure.AccountId": "#{azureWebAppSwap.AzAccount}"
  },
  "Category": "Azure",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/azure-web-app-slot-swap.json",
  "Website": "/step-templates/f256502a-4143-4d29-914e-80e541b05783",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAADNQTFRF////AHjXf7vrv931QJrh7/f8EIDaIIncMJHfYKvmz+b3n8zw3+76j8Ttr9XycLPpUKLkkKvYFAAABGZJREFUeNrsnNmCqjoQRc1MEiD8/9cer7Yt2KBJZQC8ez07sKlKTQlcLgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAzoUSnt8YxXlFuGHSbIaxvj+fip4btkLn1blkWLaF5v03yLhLOYlVuGYfMOMZzNGxCOzhjTJqFkXnjq3Dr1yyvPI3hGl3Ih3zzHHNKudRstRhX5O58vIcShY67Gq6EPIESlzUWvazaGAOGbvU7ArDu/g8M4o8opDZWvbvPzlL/MMBE8jT9T9W7PbAJlHPTBFRf9yVTEcs63msXz2UHLSgf650G/d5t+wjbxxB2UCMqGrk8/LFSD7uJMeNt5bcJCyQZyAe5Fo9KYfWS2flQrr4b4tpuzaeWjYs49rt9LHf9uZD7+VbyVi9EBNrjYjuq2sxQOrl+p+HuBVu45qvqfq691ttYFQ5KyKbyJgaIY/NGxrlWZwlwGvmvu1oY3PuAv0niTq6tZ78jk//9uc1r1r4lQki7y7sp2Tu4V1y2iLoqFTqi1lIGcpFiebrZNZ1dOkF0cCIlO8jQ47nCkam9Lilz9GhDF1I6XGLzfnhwDIIZVfI7+8SSgfHsijqXENOGJF5QorG4EcW0OrScqX/dDrXpr70Ut/BII+1OfECPuYz/NWxYmgrCsUskxPvyhgmrw+WGZ6lGTuOlIyCYWTFyWjpM5KIZRUIOwjRNYRQ6tZF9BXtk8hWAHPtLNJ727Fq0JSkC1FDRRF0Jalj0d5qVh2KEpM2TuSsCYTCT6ZkdmFYI9LrYp5QayWbo6NXlZwcRD/61pth5Fq5EX423QQxNjhqWvvklkljOLkYjrmphXPZOJOk6Pg7HKMsrtQKcowzZoK3rx1ZUelGMdQA/HaKkjAt2RgqpZeYqbNbH7Hp2ct4nqfSPOfe0ftiSTZJydOV6rG5bQbyLK+nRuCC0343PzDgiOXyQA5c14BTZi98uR/5KJ1SnatLdoO50WWBQZPTq0VgsklU3h932actuo17ayrHrb/3ykiegd3KbqF2wbV6RrlsJ07yLcpsWFTul9RyK6ZScr+tk7oNrFj0o7HQUlj4EiEvJ6rPLKSmlMZCrksl1OnLaRkxc+/HB1naMhNtT/6yM2bDs6azCRHrM3aVPN7aW8irD/10B8njpAMcsl8okXcdKrl4sPsLmQVy/Sj90ucPRc/d/Bxxj+dXSpCayen32D+hLi16MsIV8gfCXrYp6ySsiJKRUF0XXiLpVbFU+fNv4r7mOwhFsX4ZdwpSi1DYs2jb6ebZ9788cblTzMrYhu7sf/17IFdtuviJ2ioHA6pMHkoH4CLUeMBU7iGkxuM/YgcdderF9ibRdc7O982F1HpYhjfWUe+x5a6pjop9iNLfoePvlsdZdTSMwfxSmTY20Q0eHnUNzga1edeNmmqbg18aMVR1L9vwSXHF9TfIWBxpKLs2hj3eQeBC0USvp2HHF3eIkRdhFOd6ER8AAAAAAAAAAAAAAAAAAAAAAAAAAAAA/I/4J8AAo/80BciBec4AAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Thursday, June 25, 2020