Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

...

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/.

Overview

The Azure command-line interface (Azure CLI) is a set of commands used to create and manage Azure resources. The Azure CLI is available across Azure services and is designed to get you working quickly with Azure, with an emphasis on automation.

The Universal Task for Azure AZ CLI allows calling a single or a set of Azure CLI commands. 

Version Information

Template NameVersion
Azure AZ CLI1.0.0

...

This Universal Task provides the following key features:

The Universal Task for Azure AZ CLI allows you to schedule and Invoke Azure CLI commands.

...

  • Authentication
    • Authenticate with Azure using your Azure user credentials.

    • Authenticate with Azure with a service principal.
  • Actions
    • Invoke a single Azure CLI commands.
    • Invoke a list of Azure CLI commands provides via a Universal Controller Script file.
  • Logging
    • Chooses different log-levels.
  • Other
    • The Universal Task can run on any Windows or Linux Agent, without the need to install the Azure CLI.

...

  1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

  2. To import the Universal Template into your Controller, follow the instructions here.

  3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the support of this integration. For more information, refer to Integration Modifications.

Configure Universal Task

...

FieldInput typeValueTypeDescription

Authentication Method

RequiredAzure user credentials | Service-principalChoice

Choose how to authenticate to Azure.

  • Authenticate with Azure using your Azure user credentials.

  • Authenticate with Azure with a Service-principal.
Azure CredentialsRequired

Runtime User

Runtime Password

Credential

In Case of Azure user credentials Authentication:

Credential FieldValue in Azure

Runtime User

Azure user

Runtime Password

Azure user password

In case of Azure Service-principal Authentication:

(Azure App Registration)

Credential FieldValue in Azure

Runtime User

appId

Runtime Password

app password


Tenant IDOptionalAzure Tenant IDTextField is only visible in case of Authentication Method "Service-principal"
Command or ScriptRequired

Command | Script

Note

The command is provided without the key word az.


Example:

In Microsoft Azure AZ: az version

Command or Script: version

Choice
  • Command, to invoke a single Azure CLI commands.
  • Script, to invoke a list of Azure CLI commands provided via a Script in the field AZ Script.
AZ CommandOptionalSingle Azure CLI command.TextSingle Azure CLI command.
AZ ScriptOptionalScript with a list of Azure CLI commands.ScriptThe listed Azure CLI commands will be executed one after the other.
Log LevelRequiredINFO | DEBUG | WARNING | ERRORChoicePython Log Level

Task Examples 

Single Azure CLI Command

The following example invokes a single Azure CLI Command. 

...

Document LinkDescription
Universal TemplatesUser documentation for creating, working with and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.

...