Microsoft Azure Key Vault (beta) connector¶

Summary¶

The Microsoft Azure Key Vault (beta) connector establishes access to Microsoft Azure Key Vault.

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

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

The Microsoft Azure Key Vault (beta) 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 (beta) 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 (beta) connection and its activities are referred to as a Microsoft Azure Key Vault (beta) endpoint:

Microsoft Azure Key Vault (beta) activity types

Certificate: Performs an operation on a Microsoft Azure Key Vault certificate and is intended to be used as a source or target in an operation.
Secret: Performs an operation on a Microsoft Azure Key Vault secret and is intended to be used as a source or target in an operation.
Vault: Performs an operation on a Microsoft Azure Key Vault key vault and is intended to be used as a source or target in an operation.
Key: Performs an operation on a Microsoft Azure Key Vault key and is intended to be used as a source or target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and supported API versions¶

The Microsoft Azure Key Vault (beta) 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 (beta) 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 key vault.
An app registration associated with the tenant and key vault.

Troubleshooting¶

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

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).
Check the operation logs for any information written during execution of the operation.
Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.
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"/>
```
If using private agents, you can check the agent logs for more information.