User-assigned managed identities in Azure HorizonDB

Azure HorizonDB supports user-assigned managed identities (UMI) for two distinct scenarios. You can assign one or more user-assigned managed identities to a HorizonDB cluster so supported features can use them to access other Azure resources. An application can also use its own UMI to authenticate to HorizonDB without the identity being assigned to the cluster.

This article explains how user-assigned managed identities work with Azure HorizonDB and how to assign, view, and manage identities for a cluster.

Uses of user-assigned managed identities in Azure HorizonDB

A user-assigned managed identity can be used by HorizonDB to access another Azure resource or by an application to authenticate to HorizonDB. These scenarios have different configuration requirements and are explained in the following sections.

Identity assigned to the HorizonDB cluster

Customer-managed keys (CMK). HorizonDB uses a user-assigned managed identity to securely access customer-managed encryption keys stored in Azure Key Vault (AKV). The identity must have the required permissions to access the key. Assigning an identity to the HorizonDB cluster makes the identity available for configuration but doesn't automatically grant the identity access to a key or configure data encryption. For more information, see the Customer-managed keys in Azure HorizonDB.

Identity used by an application to connect to HorizonDB

Microsoft Entra ID authentication. A user-assigned managed identity can be assigned as a Microsoft Entra administrator for Azure HorizonDB. Applications and services can also use their own user-assigned managed identities to authenticate as non-administrator database principals. An application's identity does not need to be assigned to the HorizonDB cluster for database login. For guidance on enabling Microsoft Entra authentication and assigning an administrator, see Configure Microsoft Entra authentication in Azure HorizonDB.

Prerequisites

Before you assign or use a user-assigned managed identity with Azure HorizonDB, check the requirements that apply to your scenario:

  • To assign an identity to a cluster: Create or identify an existing user-assigned managed identity.
  • To use an identity with customer-managed keys: Grant it the required Azure Key Vault permissions to access the encryption key. Assigning the identity to the cluster alone doesn’t grant access to the key.
  • To use an identity for Microsoft Entra authentication: Configure it as a Microsoft Entra administrator or database principal, as appropriate.

Assign a user-assigned managed identity to an existing cluster

You can assign a user-assigned managed identity to an Azure HorizonDB cluster when you create the cluster or update an existing cluster. For the cluster identity properties used to assign UMIs, see the HorizonDB cluster template reference or the Clusters – Update REST API reference.

View a user-assigned managed identity of an existing cluster

To view the user-assigned managed identities associated with a cluster, retrieve the cluster resource and inspect its identity information. For the cluster identity properties used to view UMIs, see Clusters – Get.

Remove a user-assigned managed identity from an existing cluster

Before removing an identity, check whether a supported feature uses it.

  • Customer-managed keys: If you remove the identity used for CMK, the cluster becomes inaccessible. Configure a different identity for key access before removing it.
  • Microsoft Entra authentication: Removing an identity from the cluster’s assigned identities is separate from managing Microsoft Entra administrators and database principals. See the Microsoft Entra authentication guidance to manage database access.

To remove one or more identities, update the cluster by setting each identity’s entry to null in the userAssignedIdentities property. To remove all assigned identities, set the cluster’s identity type to None. For the cluster identity properties used to remove UMIs, see Clusters – Update.