Create Azure CLI plugin procedures

2 minute readExtensibilityDeveloper productivity
On this page

Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Run CLI

Runs Azure CLI commands with the authorization data provided in the plugin’s configuration. This procedure does not support Azure DevOps commands.

Input parameters

Table 1. Run CLI input parameters
Parameter Description

Configuration name

Required. The previously defined configuration for the plugin.

Reference group

Required. Reference Group. For example, sql, network, storage , vm, etc.

The devops reference group is not supported by this procedure.

Reference subgroup(s)

Reference subgroup(s). If you provide more than one subgroup, separate each one with a space. For example: nsg nsg rule vnet vnet subnet.

Reference subgroups should have the same order/precedence as they are used in the Azure CLI command.

Command

Required. Azure CLI command to execute. For example, create, update, list, delete, etc.

Environment variables

Provide additional environment variables to the command. This field content and variables from the configuration are merged and this field takes precedence.

Arguments

Command arguments, one per line. Some commands require to accept a confirmation prompt, for them add -y argument to accept.

The following are examples of valid arguments:

  • -g resourgroupname

  • -n vmname

  • -d

  • -y

  • --yes

Output file

If a value is provided, the command output will be saved to this file instead of the output parameter. The output parameter is left empty when using this option.

Output parameters

Table 2. Run CLI output parameters
Parameter Description

output

The response received from the Azure CLI.