Create Azure CLI plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Azure CLI plugin configuration parameters

Table 1. AzureCLI plugin configuration parameters
Parameter Description

Configuration name

Required. The unique name for the configuration.

Description

A description of the configuration.

CLI path

Required. Path to Azure CLI. For example, /usr/bin/az.

Authorization type

Required. Choose the authorization type:

  • servicePrincipalPassword: Requires app ID, password, and tenant.

  • servicePrincipalCertificate: Requires app ID, x509 certificate in PEM format, and tenant.

Service principal credentials

Required. The Azure service principal credentials; the application ID and service principal password or certificate.

Application ID

Required. The URL or name associated with the service principal.

X509 certificate

Required. Provide the content of the X509 certificate (PEM file) used to create the service principal.

Tenant

Required. The tenant associated with the service principal, as either an .onmicrosoft.com domain or Azure object ID.

Environment variables

Set additional environment variables.

Check configuration resource

Checks the configuration of the resource. Azure CLI must be installed on this resource.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.