Azure Site Extensions - Install

Octopus.AzureResourceGroup exported 2017-09-06 by alfhenrik belongs to ‘Azure Site Extensions’ category.

Installs an Azure site extension in your Azure web app.

Parameters

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

Resource group name

AzSiteExt_ResourceGroupName =

The Resource Group of your Azure Web App.

Site name

AzSiteExt_SiteName =

The name of your Azure Web App.

App service plan name

AzSiteExt_AppServicePlanName =

The App Service Plan of your Azure Web App.

Site extension name

AzSiteExt_ExtensionName =

The package name of the extension you want to install.

The extensions available to be installed can be found on the siteextensions.net website. The name of the package can be derived from the URL of the extension (e.g. for the Application Insights extension the URL is https://www.siteextensions.net/packages/Microsoft.ApplicationInsights.AzureWebSites/, so the package name is Microsoft.ApplicationInsights.AzureWebSites).

Azure account ID

AzSiteExt_AzureAccountId =

The Azure account to use for the connection.

NOTE: a service principal account is required, a management certificate account will not work.

Script body

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

undefined

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": "7518eaa0-677c-4562-82d5-a131f29e1744",
  "Name": "Azure Site Extensions - Install",
  "Description": "Installs an Azure [site extension](https://www.siteextensions.net) in your Azure web app.",
  "Version": 1,
  "ExportedAt": "2017-09-06T20:42:23.783Z",
  "ActionType": "Octopus.AzureResourceGroup",
  "Author": "alfhenrik",
  "Parameters": [
    {
      "Id": "d1494374-4db4-4bed-8136-eec378de7c9d",
      "Name": "AzSiteExt_ResourceGroupName",
      "Label": "Resource group name",
      "HelpText": "The Resource Group of your Azure Web App.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "1d188d2a-915e-425f-a4d8-5780421ebb00",
      "Name": "AzSiteExt_SiteName",
      "Label": "Site name",
      "HelpText": "The name of your Azure Web App.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "00edff48-a947-424b-b46e-4f58826568c3",
      "Name": "AzSiteExt_AppServicePlanName",
      "Label": "App service plan name",
      "HelpText": "The App Service Plan of your Azure Web App.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "2d2cfc5f-1f41-4d7b-a4df-3dbb652553fb",
      "Name": "AzSiteExt_ExtensionName",
      "Label": "Site extension name",
      "HelpText": "The package name of the extension you want to install.\n\nThe extensions available to be installed can be found on the [siteextensions.net](https://www.siteextensions.net/packages) website. The name of the package can be derived from the URL of the extension (e.g. for the Application Insights extension the URL is `https://www.siteextensions.net/packages/Microsoft.ApplicationInsights.AzureWebSites/`, so the package name is `Microsoft.ApplicationInsights.AzureWebSites`).",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "3629e43b-1af0-4df5-a6ce-6f36ead4dea0",
      "Name": "AzSiteExt_AzureAccountId",
      "Label": "Azure account ID",
      "HelpText": "The Azure account to use for the connection.\n\n**NOTE:** a **service principal** account is required, a **management certificate** account will not work.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    }
  ],
  "Properties": {
    "Octopus.Action.Azure.ResourceGroupName": "#{AzSiteExt_ResourceGroupName}",
    "Octopus.Action.Azure.TemplateSource": "Inline",
    "Octopus.Action.Azure.ResourceGroupTemplateParameters": "{\"siteName\":{\"value\":\"#{AzSiteExt_SiteName}\"},\"extensionName\":{\"value\":\"#{AzSiteExt_ExtensionName}\"},\"appServicePlanName\":{\"value\":\"#{AzSiteExt_AppServicePlanName}\"}}",
    "Octopus.Action.Azure.ResourceGroupDeploymentMode": "Incremental",
    "Octopus.Action.Azure.ResourceGroupTemplate": "{\r\n    \"$schema\": \"http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#\",\r\n    \"contentVersion\": \"1.0.0.0\",\r\n    \"parameters\": {        \r\n        \"siteName\": {\r\n            \"type\": \"string\",\r\n            \"metadata\": {\r\n                \"description\": \"Web site name\"\r\n            }\r\n        },\r\n        \"appServicePlanName\": {\r\n            \"type\": \"string\",\r\n            \"metadata\": {\r\n                \"description\": \"App service plan name\"\r\n            }\r\n        },\r\n        \"extensionName\": {\r\n            \"type\": \"string\",\r\n            \"metadata\": {\r\n                \"description\": \"Extension name\"\r\n            }\r\n        }  \r\n    },\r\n    \"variables\": {  \r\n        \"extensionApi\": \"2015-06-01\"\r\n    },\r\n    \"resources\": [\r\n        {\r\n            \"apiVersion\": \"[variables('extensionApi')]\",\r\n            \"name\": \"[parameters('siteName')]\",\r\n            \"type\": \"Microsoft.Web/sites\",\r\n            \"location\": \"[resourceGroup().location]\",\r\n            \"dependsOn\": [],\r\n            \"properties\": {\r\n                \"name\": \"[parameters('siteName')]\",\r\n                \"serverFarmId\": \"[parameters('appServicePlanName')]\"\r\n            },\r\n            \"resources\": [\r\n                {\r\n                    \"apiVersion\": \"[variables('extensionApi')]\",\r\n                    \"name\": \"[parameters('extensionName')]\",\r\n                    \"type\": \"siteextensions\",\r\n                    \"dependsOn\": [\r\n                        \"[resourceId('Microsoft.Web/Sites', parameters('siteName'))]\"\r\n                    ],\r\n                    \"properties\": {}\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}",
    "Octopus.Action.Azure.AccountId": "#{AzSiteExt_AzureAccountId}"
  },
  "Category": "Azure Site Extensions",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/azure-site-extensions-install.json",
  "Website": "/step-templates/7518eaa0-677c-4562-82d5-a131f29e1744",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAtFBMVEUAAACASZigoaJZtNmASZiASZigoaKgoaKgoaKASZiASZiASZiASZiASZiASZiASZiASZiASZiASZigoaKgoaKgoaKgoaKgoaKgoaKgoaJZtNlZtNlZtNlZtNlZtNlZtNlZtNlZtNlZtNlZtNmgoaKgoaKgoaKgoaKgoaKgoaKgoaKgoaKgoaKgoaKgoaJZtNlZtNmgoaKgoaKgoaKgoaKgoaKgoaKgoaKASZigoaJZtNn///88MUhjAAAAOHRSTlMAAAAAWP2fomNT8fPy9f4TODVk+YKEhlLzOCpIR0UUkv3585YTPj9AJ0nx9vqZTFiZ9WQ1c/v+8s7KmYgAAAABYktHRDs5DvRsAAAACXBIWXMAAA7DAAAOwwHHb6hkAAABAUlEQVR42u3YRw7CMBRFUUgg9N5L6L33tv+FMY9kLEe2RaR7F/DfGf9YTEvxRPIVLj37AAAAAAAAQKQBnlqptOPoBbwV8wAAAAAAwJ8CMtmcqHyhaAFQKgurVAvmAb+Kl3MAAAAAAABAVAE1r94I1mxZBLQ7qlsAAAAAYArgut1eX5Y/cA0ChqOxrIlvEjD9SBv3hYBsMSnMBqCUSYizAJAEAAAAAAAAAAAAwADAmc0Xopar4IPDBGC92Yra7W0ADjvxUQ8AAAAAAIQDHE9TWcOuOYBiAAAAAKANcL5cO2G63u56AI/zsx2m5/atB2AkAAAAAAAAAAAAAAAAAAAQBHwB/SLmwJclsisAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTQtMDYtMTVUMDk6MDI6MTYtMDc6MDAhb+VcAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE0LTA2LTEyVDExOjA4OjE5LTA3OjAwi613rgAAABZ0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMDvo9WkAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Wednesday, September 6, 2017