Microsoft Azure Key Vault connector for Jitterbit Integration Studio

Summary

The Microsoft Azure Key Vault connector establishes access to Microsoft Azure Key Vault.

The Microsoft Azure Key Vault connector provides an interface for creating a Microsoft Azure Key Vault connection, the foundation used for generating instances of Microsoft Azure Key Vault activities. These activities, once configured, interact with Microsoft Azure Key Vault through the connection.

The Microsoft Azure Key Vault connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Connector overview

This connector is used to first configure a Microsoft Azure Key Vault connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Microsoft Azure Key Vault connection and its activities are referred to as a Microsoft Azure Key Vault endpoint:

• 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.

Prerequisites and supported API versions

The Microsoft Azure Key Vault connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

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

These Microsoft Azure resources are required for a successful connection:

• An active Microsoft Entra ID tenant associated with the vault.
• An app registration associated with the tenant and vault.

Troubleshooting

If you experience issues with the Microsoft Azure Key Vault connector, these troubleshooting steps are recommended:

1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

2. Ensure any Microsoft Entra ID app registrations associated with the connection are not using the deprecated Azure AD Graph.

3. Check the operation logs for any information written during execution of the operation.

4. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

5. If using private agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

   <logger name="org.jitterbit.connector.microsoft.azurekeyvault" level="DEBUG"/>
   

6. If using private agents, you can check the agent logs for more information.

7. For additional troubleshooting considerations, see Operation troubleshooting.