Skip to Content

Microsoft Azure Key Vault (beta) Key activity

Introduction

A Microsoft Azure Key Vault (beta) Key activity, using its Microsoft Azure Key Vault (beta) connection, performs an operation on a Microsoft Azure Key Vault key and is intended to be used as a source (to provide data in an operation) or a target (to consume data in an operation).

Note

This connector is currently released as a beta version and is available only to select organizations. To participate in the beta program or provide feedback on bugs and enhancements, contact your Customer Success Manager (CSM).

Create a Microsoft Azure Key Vault (beta) Key activity

An instance of a Microsoft Azure Key Vault (beta) Key activity is created from a Microsoft Azure Key Vault (beta) connection using its Key activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Microsoft Azure Key Vault (beta) Key activity can be edited from these locations:

Configure a Microsoft Azure Key Vault (beta) Key activity

Follow these steps to configure a Microsoft Azure Key Vault (beta) Key activity:

Step 1: Enter a name and select a vault

In this step, provide a name for the activity and select a vault. Each user interface element of this step is described below.

Microsoft Azure Key Vault Key activity configuration step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure Key Vault (beta) Key activity and must not contain forward slashes / or colons :.

  • Select a vault: This section displays vaults available in the Microsoft Azure Key Vault (beta) endpoint.

    • Selected vault: After a vault is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of vaults. The search is not case-sensitive. If vaults are already displayed within the table, the table results are filtered in real time with each keystroke. To reload vaults from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon or the word Refresh to reload vaults from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if vaults have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of vaults displayed in the configuration.

    • Selecting a vault: Within the table, click anywhere on a row to select a vault. Only one vault can be selected. The information available for each vault is fetched from the Microsoft Azure Key Vault (beta) endpoint:

      • Name: The name of the vault.

      • Location: The Azure region the vault is located in.

      • Resource group: The resource group of the vault.

    Tip

    If the table does not populate with available vaults, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Optional settings: Click to expand additional optional settings:

    • Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select an operation

In this step, select an operation. Each user interface element of this step is described below.

Microsoft Azure Key Vault Key activity configuration step 2

  • Select an operation: This section displays operations available in the Microsoft Azure Key Vault (beta) endpoint.

    • Selected vault: The vault selected in the previous step is listed here.

    • Selected operation: After an operation is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of operations. The search is not case-sensitive. If operations are already displayed within the table, the table results are filtered in real time with each keystroke. To reload operations from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon or the word Refresh to reload operations from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if operations have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of operations displayed in the configuration.

    • Selecting an operation: Within the table, click anywhere on a row to select an operation. Only one operation can be selected. The information available for each operation is fetched from the Microsoft Azure Key Vault (beta) endpoint:

      • Name: The name of the operation.

      • Description: The description of the operation.

    Tip

    If the table does not populate with available operations, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Microsoft Azure Key Vault Key activity configuration step 3

  • Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping. The data schemas change based on the operation chosen in step 2.

    The Microsoft Azure Key Vault (beta) connector uses the Microsoft Azure Key Vault REST API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Microsoft Azure Key Vault (beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Microsoft Azure Key Vault (beta) Key activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Microsoft Azure Key Vault (beta) Key activities can be used as a source with these operation patterns:

Microsoft Azure Key Vault (beta) Key activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.