This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License types and features.

Microsoft Azure connector

The Microsoft Azure connector connects BMC Helix Digital Workplace Catalog with the Microsoft Azure third-party system. It enables you to perform certain actions in Microsoft Azure, such as creating a storage account or creating a virtual machine.

External account requirements

Before you start building workflows that use Azure actions, perform the following tasks:

  1. Register an account in Microsoft Azure. Go to  Create Microsoft 365 account Open link .
  2. In the Microsoft Azure portal, create and configure an Active Directory application by performing the following steps:
    • Configure Azure Active Directory permissions Open link
    • Create an Azure Active Directory application Open link
    • Assign application to a role Open link


Configuration parameters for the Microsoft Azure connector

Before you can use the Microsoft Azure connector to import the catalog (for resource mapping or in workflows), you must configure a connection, as described in Configuring service connectors.  The following table describes the parameters required to configure a connection:

ParameterExamplesDescription
Subscription ID

b8ab0d50-d6ff-4669-babd-a5a789182fab 

The ID obtained during creation of the Azure account.
Tenant ID46a3634f-f1e5-408a-9593-705909012ecb

Corresponds to the value of the Directory ID tied to Active Directory in Azure.

Client IDa078123f-d025-467d-936b-fa3c3ec9d932 

Corresponds to a value of the Application ID obtained upon creation of an application in Azure Active Directory.

Client Key

Hq8Fn1w7gtju+hzzw7flzpimpogdrgTZ5nGNq0ULsyk=

Corresponds to a value of the password specified upon creation of the Active Directory account.
Region






















The value must be one of the following options:

  • eastus
  • eastus2
  • westus
  • centralus
  • northcentralus
  • southcentralus
  • northeurope
  • westeurope
  • eastasia
  • southeastasia
  • japaneast
  • japanwest
  • australiaeast
  • australiasoutheast
  • brazilsouth
  • southindia
  • centralindia
  • westindia
  • canadacentral
  • canadaeast
  • westus2
  • westcentralus
  • uksouth
  • ukwest

The name of one of the available Microsoft Azure regions Open link .

Catalog import capabilities

With the Microsoft Azure connector, you can import services from Microsoft Azure as services in BMC Helix Digital Workplace Catalog. For details about how to import the catalog, see Importing service catalog items from external systems.

You must import Azure services to be able to attach a workflow that includes the Create VM activity.

Resource mapping capabilities 

You can map data sets to populate a list of answers in the service questionnaire with a data set. For more information, see Creating selection menus for question responses.

You can map data from the following data sets:

  • Azure Resource Groups
  • Azure VM Sizes
  • Azure Storage Keys

Workflow actions available through the Azure connector

The following table provides an overview of all Azure connector actions:

Action categoryActionDescriptionInput parametersPossible output
Actions with storage accounts

Create Storage Account Service

Creates a storage in Microsoft Azure

Create Storage Account Service input parametersStorage Key output parameters

Refresh Storage KeyRefreshes the storage keysRefresh Storage Key input parameters
Regenerate Storage KeyCreates new the storage keys for an Azure accountRegenerate Storage Key input parameters
Actions with virtual machines

Create VM

Creates a virtual machine in the Azure portal

Create VM input parameters

VM actions output paramaters

Status VMChecks the status of a virtual machineStatus VM input paramaters

Default service actions 

The Microsoft Azure connector provides the following Day 2 predefined service actions:

  • Mapped to the Create VM action: 
    • Start
    • Shut Down
    • Restart VM
    • Deallocate
    • Delete VM
  • Mapped to the Create Storage Account Service action:
    • Delete Storage Account

These actions are available for end users who requested creation of a storage account, or a virtual machine in Microsoft Azure. For more details about Day 2 service actions, see Setting up the My Stuff page.

Example: Workflow for a service that creates a virtual machine

The following workflow can be mapped to a service that creates a virtual machine in Microsoft Azure:

This workflow uses the Send Virtual Machine Creation Email activity, which can be used in a process only if Microsoft Office 365 is configured. This activity sends output from the Create VM activity to a specified email. 

Input and output parameters for actions

Create Storage Account Service input parameters 

ValidationParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > AzureDefault connection ID of this connector.
RequiredStorage Account NameStringProcess input > Text variable

Name of a storage account that you create.

The value must meet the following requirements:

  • The length of the value must be 3 to 24 characters.
  • The value must contain only numeric characters and lowercase letters.
  • The value must be unique within Azure portal.
RequiredUser_BYString

Process context variable >  Requested by User > Login Name  

Login name of the user who requested the service.
RequiredIs Existing GroupStringProcess input > Text variable

Value specifies whether a virtual machine belongs to an existing Resource Group.

Create a radio button selection question with the following values:

  • True—To create a virtual machine in an existing storage group
  • False—To create a new storage for a virtual machine
OptionalResource GroupString

Process input > Text variable

The process input that you create can be mapped to the Azure Resource Groups data set in the questionnaire.

Regenerate Storage Key input parameters 

ValidationParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > AzureDefault connection ID of this connector.
RequiredResource GroupStringProcess input > Text variableThe process input that you create can be mapped to the Azure Resource Groups data set in the questionnaire.
RequiredStorage Account NameString

Process input > Text variable


Value must meet the following requirements:

  • The length of the value must be 3 to 24 characters.
  • The value must contain only numeric characters and lowercase letters.
  • The value must be unique within Azure portal.
RequiredStorage Account KeyString

Process input > Text variable

Key of a storage account. You must enter the value of key1 or key2.

The process input that you create can be mapped to the Azure Storage Key data set in a questionnaire.

Refresh Storage Key input parameters 

ValidationParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > AzureDefault connection ID of this connector.
RequiredResource GroupStringProcess input > Text variable

Name of a resource group to which the virtual machine belongs.

The process input that you create can be mapped to the Azure Resource Groups data set in a questionnaire.

RequiredStorage Account NameStringProcess input > Text variable

The value must meet the following requirements:

  • The length of the value must be 3 to 24 characters.
  • The value must contain only numeric characters and lowercase letters.
  • The value must be unique within Azure portal.

Important

Regenerating Storage Key refreshes only one key you select. Refreshing Storage Key refreshes both.

Storage Account actions output parameters

The Create Storage Account Service, Refresh Storage Key, and Regenerate Storage Key actions all return the same output parameters described in the following table:

Parameter nameData typeExampleDescription
Account NameString

itsupport03

Name of a storage account.
Key 1String

Not applicable

Key 1 of the storage account.
Key 2String

Not applicable

Key 2 of the storage account.

Create VM input parameters 

Important

You must have a required catalog item imported from the Microsoft Azure before you can use this activity in your workflow.


RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > AzureDefault connection ID of this connector.
RequiredUser NameStringProcess input > Text variableUser login name for the virtual machine.
RequiredPasswordStringProcess input > Text variable

Password for the virtual machine.

It must be 8 to 123 characters, and must meet 3 of the following requirements:

  • At least one lowercase character
  • At least one uppercase character
  • At least one numeric character
  • At least one special character
RequiredVm NameStringProcess input > Text variable

Name of the virtual machine.

The value must be 1 to 15 characters with no special characters.

RequiredResource GroupStringProcess input > Text variable

Name of a resource group to which the virtual machine belongs.

The process input that you create can be mapped to the Azure Resource Groups data set in a questionnaire.

RequiredVm SizeStringProcess input > Text variable

Size of a virtual machine.

The process input that you create can be mapped to the Azure VM Sizes data set in a questionnaire.

RequiredPrimary NetworkStringProcess input > Text variable

Network address space of a virtual machine.

You can create a drop-down question with the available network spaces values.

RequiredOs TypeStringProcess context variable > Service > External Service ID 

External ID of a service imported from the Microsoft Azure that is mapped to the workflow.

RequiredUSER_BYStringProcess context variable >  Requested by User > Login Name  Login name of a user who requested the service.
RequiredIs Existing GroupStringProcess input > Text variable

Value specifies whether a virtual machine belongs to an existing Resource Group.

Create a radio button selection question with the following values:

  • True—To create a virtual machine in an existing storage group
  • False—To create a new storage for a virtual machine

Status VM input parameters 

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > AzureDefault connection ID of this connector.
RequiredResource GroupStringProcess input > Text variable

Name of a resource group to which the virtual machine belongs.

The process input that you create can be mapped to the Azure Resource Groups data set in a questionnaire.

RequiredVm NameStringProcess input > Text variableValue must be 1 to 15 characters with no special characters.

VM actions output parameters 

The Create VM and Status VM actions return the same output parameters described in the following table:

Parameter nameData typeExampleDescription
IPString

164.26.192.205

IP address of the provisioned machine
StatusString
  • Running
  • Deallocating
  • Stopped
Current status of a virtual machine
User NameStringAllenUser login name for a virtual machine
User PasswordStringPasW0r_dLogin password for a virtual machine
Was this page helpful? Yes No Submitting... Thank you

Comments