AzureServiceScope

The “AzureServiceScope” acts as a centralized authentication environment for Azure services. In this scope, users are required to provide common values necessary for authenticating and accessing Azure services. Once entered, these values apply to all associated activities, eliminating the need for separate authentication steps with each Azure service interaction. This approach not only enhances efficiency but also ensures consistency by avoiding repetitive access procedures for each service.

Common values

Once you’ve registered and configured your resource with Azure services, you’ll receive important credentials as outlined below. If you haven’t completed your registration and configuration, please click here to do so.

1. Client ID: This is a Globally Unique Identifier (GUID) for each application registered with Azure services. It acts as a unique key, allowing your application to identify and authenticate itself during bot execution.
2. Client Secret: This is a password or key used in conjunction with the Client ID to authenticate the application. You can refer here for instructions on how to view the Client ID and secret key.
3. Subscription ID: The unique identifier for the Azure subscription under which your Key Vault is created.
4. Tenant ID: Identifies the Azure AD instance (or tenant) where your application is registered, also referred to as the Directory ID in Key Vault contexts.

Properties 

INPUT

ClientID *: This parameter indicates to provide the Client ID for your application registered within the Azure services. It is used to identify and authenticate to the Azure services during bot execution.

This parameter accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

ClientSecret *: This parameter indicates to provide the Client secret for your application registered within the Azure services. It usually represents the password or key that is used along with Client ID to authenticate to the Azure services during bot execution.

This parameter accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

SubscriptionID *: This parameter indicates to provide the Subscription ID of your key vault registered within the Azure services. Refer the image below in documentation for reference.

This parameter accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

TenantID *: This parameter indicates to provide the Tenant ID for your application registered within the Azure services. Refer the image below in documentation for reference. It represents the “Directory ID” of the key vault created in the Azure services.

This parameter accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

MISC

Body: Gets auto filled once the “Activity” is dropped into the body.

DisplayName: Displays the name of the activity. The activity name can be customized, which aids in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”

True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: It indicates the version of the feature being used.

OUTPUT

Result: It provides the ability to view the execution status of the activity. It returns values in “Boolean.”

True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

* Represents mandatory fields to execute the workflow.

Configuration

When you have created and configured the Key Vault in the Azure portal, you can find the Subscription ID and Tenant ID. Refer to the image below for details.

Here’s an example of how the activity is used in the workflow –

In the following example, using my Azure Key Vault credentials, I am going to access my Key Vault in Azure. I have hardcoded the following values into string variables:

1. Client ID
2. Client Secret
3. Subscription ID
4. Tenant ID

Steps to build the bot:

1. Create a new solution.
2. Install the latest version of “AzureKeyVault” from the Manage Features menu.
3. Drag and drop the “AzureServiceScope” activity into the workflow and set it as start node.
    a. Here, I am using this activity to authenticate with the Key Vault in Azure services.
4.I have provided the parameters “Client ID,” “Client Secret,” “Subscription ID,” and “Tenant ID” in variables.

5.To continue the workflow, refer to the “CreateSecret” activity’s documentation.