Configuring the version of the Azure PowerShell CLI

Last updated 2021-02-24T23:29:15.9912100+00:00

A version of Azure PowerShell CLI is bundled with Octopus Deploy. To determine the version of the bundled CLI, add the PowerShell below to an Azure PowerShell Script Step:

az --version

If you wish to use a different version, you can install the Azure PowerShell CLI on your Octopus Server, and configure Octopus to use the installed version instead.

The procedure to configure this differs depending on which version of Octopus Deploy you are using:

Octopus 2020.1 or newer

The PowerShell Azure step has an option called "Azure Tools". Toggle the setting to Use Azure Tools pre-installed on the worker.

Octopus 2018.5.5 to 2019.13.7

Create a variable named OctopusUseBundledAzureCLI and set its value to False.

With this value set, Octopus Deploy will not load the bundled Azure PowerShell CLI.

If you need to disable the Azure CLI altogether due to errors or the added time to login to the CLI, use OctopusDisableAzureCLI and set its value to True.

Learn more

Generate an Octopus guide for Azure and the rest of your CI/CD pipeline.

Need support? We're here to help.