Skip to Content

Microsoft Azure Key Vault connection

Introduction

A Microsoft Azure Key Vault connection, created using the Microsoft Azure Key Vault connector, establishes access to Microsoft Azure Key Vault. Once a connection is configured, you can create instances of Microsoft Azure Key Vault activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Prerequisites

These Microsoft Azure resources are required for a successful connection:

Create or edit a Microsoft Azure Key Vault connection

A new Microsoft Azure Key Vault connection is created using the Microsoft Azure Key Vault connector from one of these locations:

An existing Microsoft Azure Key Vault connection can be edited from these locations:

Configure a Microsoft Azure Key Vault connection

Each user interface element of the Microsoft Azure Key Vault connection configuration screen is described below.

Microsoft Azure Key Vault connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Azure Key Vault connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft Azure Key Vault endpoint, which refers to both a specific connection and its activities.

  • Tenant ID: Enter the tenant (directory) ID associated with the vault.

  • Client ID: Enter the client (application) ID associated with the vault.

  • Subscription ID: Enter the subscription ID associated with the vault.

  • Client secret: Enter the client secret associated with the vault.

  • Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Microsoft Azure Key Vault connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.

These activity types are available:

  • Update Vault: Updates a vault in Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.

  • Create Vault Objects: Creates a certificate, key, or secret in Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.

  • Query Vault: Retrieves a vault from Microsoft Azure Key Vault and is intended to be used as a source to provide data in an operation.

  • Delete Vault Objects: Deletes a certificate, key, or secret from Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.

  • Create Vault: Creates a vault in Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.

  • Query Vault Objects: Retrieves a certificate, key, or secret from Microsoft Azure Key Vault and is intended to be used as a source to provide data in an operation.

  • Delete Vault: Deletes a vault in Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.

  • Update Vault Objects: Updates a certificate, key, or secret in Microsoft Azure Key Vault and is intended to be used as a target to consume data in an operation.