Installing the Tentacle VM extension via an ARM template

The VM extension is deprecated and no longer supported. All customers using the VM extension should migrate to DSC.

An Azure Resource Manager (ARM) template is a JSON file that defines a set of Azure resources that can be automatically read and provisioned by Azure.

Using an ARM template, you can deploy the Tentacle VM extension at the same time you create the virtual machine, or update the resource group to apply the extension later.

Create your ARM template as normal, and add a resources element under your Microsoft.Compute/virtualMachine resource:

"resources": [
    "type": "extensions",
    "name": "[concat(parameters('vmName'),'/OctopusDeployWindowsTentacle')]",
    "apiVersion": "2015-05-01-preview",
    "location": "[resourceGroup().location]",
    "dependsOn": [
      "[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'))]"
    "properties": {
      "publisher": "OctopusDeploy.Tentacle",
      "type": "OctopusDeployWindowsTentacle",
      "typeHandlerVersion": "2.0",
      "autoUpgradeMinorVersion": "true",
      "forceUpdateTag": "1.0",
      "settings": {
        "OctopusServerUrl": "http://localhost:81",
        "Environments": [
        "Roles": [
          "App Server",
          "Web Server"
        "CommunicationMode": "Listen",
        "Port": 10933,
        "PublicHostNameConfiguration": "PublicIP"
      "protectedSettings": {
        "ApiKey": "API-ABCDEF1234567890ABCDEF12345"


  • publisher: (string) Must be OctopusDeploy.Tentacle.
  • type: (string) Must be OctopusDeployWindowsTentacle.
  • typeHandlerVersion: (string): The major and minor version of the extension to apply. You can find what versions are available via the Azure CLI.
  • autoUpgradeMinorVersion: (string) Indicates whether the extension version should be automatically updated to a newer minor version. Accepts the values true or false.
  • forceUpdateTag: (string) Any user defined value that can be modified to force the extension to re-run, even if none of the settings or protectedSettings have changed.

Please refer to the configuration structure for details regarding the format of the settings and protectedSettings elements.

If you need more the ability to customize more of the installation, you might want to consider using the Azure Desired State Configuration (DSC) extension in conjunction with the OctopusDSC resource.

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023