This documentation is for Octopus Deploy Version 3.13. View other versions

Creating an Azure Management Certificate Account

Last updated

Azure Management Certificate Accounts Work with the Azure Service Management API only
Prior to Octopus Deploy 3.3, Azure Management Certificate Accounts (previously known simply as "Azure Subscription Accounts") were the only type of Azure Account available.

Azure Management Certificate Accounts are only able to interact with the legacy Azure interface known as the "Azure Service Management API", which is used when Octopus deploys Cloud Services and Azure Web Apps.

To interact with Azure Resource Manager (ARM), like when Octopus deploys a Resource Group Template, you must use an Azure Service Principal Account.

To create an Azure Management Certificate Account, select Management Certificate as the Authentication Method.

Add management certificate

Step 1: Subscription ID

The Subscription Id can be found on the Settings tab of the Azure Management portal.

Azure subscription Id

Step 2: Management Certificate

When using Management Certificate as the Authentication Method, Octopus Deploy authenticates with Azure using an X.509 certificate.  You can either upload an existing certificate (.pfx), or leave the field blank and Octopus Deploy will generate a certificate. Keep in mind that since Octopus Deploy securely stores the certificate internally, there is no need to upload a password protected .pfx file. If you would like to use one that is password protected, you will need to first remove the password. This can be done with the following commands.

Remove .pfx password

openssl pkcs12 -in AzureCert.pfx -password pass:MySecret -nodes -out temp.pem
openssl pkcs12 -export -in temp.pem -passout pass -out PasswordFreeAzureCert.pfx
del temp.pem

If you allow Octopus Deploy to generate your certificate, you will need to upload the certificate to the Azure Management Portal.  After clicking 'Save', the Account settings page provides instructions for downloading the certificate public-key from Octopus Deploy, and uploading it into the Azure Management Portal.

Upload certificate to Azure

Uploaded certificates can be viewed on the 'Management Certificates' tab of the 'Settings' page in the Azure Portal.

Download management certificate

The certificate will be named Octopus Deploy -``{Your Account Name}.

Step 3: Save and Test

Click the Save and Test button and if the test succeeds, you should be able to configure Octopus to deploy anything to Azure via the Azure Service Management (ASM) API.

What is actually tested?
When you click the Save and Test button, Octopus will attempt to use the account credentials to access the Azure Service Management (ASM) API and list the Hosted Services in that subscription. You may need to whitelist the appropriate IP Addresses for the Azure Data Center you are targeting. See deploying to Azure via a Firewall for more details.