Utiliser les informations d’identification du service catalogue Unity pour se connecter aux services cloud externes

Cet article explique comment utiliser des informations d’identification de service dans le catalogue Unity pour se connecter aux services cloud externes. Dans Unity Catalog, un objet d’identification de service encapsule un identifiant cloud de longue durée qui permet d’accéder à un service cloud externe auquel les utilisateurs doivent se connecter depuis Azure Databricks.

Voir aussi :

Exigences

Avant de pouvoir utiliser des informations d’identification de service pour vous connecter à un service cloud externe, vous devez disposer des conditions suivantes :

  • Un espace de travail Azure Databricks activé pour Unity Catalog.

  • Ressource de calcul qui se trouve sur Databricks Runtime 16.2 ou version ultérieure.

    Les entrepôts SQL ne sont pas pris en charge pour utiliser directement les identifiants de service. Voir Utiliser un identifiant de service dans un UDF Python.

    La version préliminaire publique des informations d’identification du service est disponible sur Databricks Runtime 15.4 LTS et versions ultérieures, avec prise en charge de Python, mais aucune prise en charge Scala.

  • Informations d’identification de service créées dans votre metastore Unity Catalog qui donne accès au service cloud.

  • Le privilège ACCESS sur les informations d’identification de service ou la propriété des informations d’identification de service.

Utiliser un identifiant de service dans votre code

Cette section fournit des exemples d’utilisation des identifiants de service dans un notebook. Remplacez les valeurs fictives. Ces exemples ne montrent pas nécessairement l’installation des bibliothèques requises, qui dépendent du service client auquel vous souhaitez accéder.

Seul Python est pris en charge.

Utilisez une certification de service dans un UDF Python

Dans les FDUs, utilisez databricks.service_credentials.getServiceCredentialsProvider() pour accéder aux identifiants de service. La dbutils.credentials.getServiceCredentialsProvider() fonction utilisée dans les notebooks n’est pas disponible dans les contextes d’exécution UDF.

Les exigences dépendent du type de UDF :

Type UDF Exigences
UDF scalaire à portée de session PySpark Databricks Runtime 17.1 ou version ultérieure sur du calcul classique, ou un notebook sans serveur ou une session de tâche exécutant la version 3 ou ultérieure de l’environnement.
Catalogue Batch Unity Python UDF Databricks Runtime 16.3 ou supérieur sur le calcul classique ; calcul serverless ; entrepôts SQL pro et serverless. La version 6 de l’environnement n’est pas requise.
Scalar Unity Catalog Python UDF Databricks Runtime 18.1 ou version ultérieure avec le calcul classique. Dans l’environnement de calcul serverless ainsi que dans les entrepôts de données SQL Pro et serverless, définissez explicitement le environment_version de l’UDF sur 6 ou une valeur supérieure. Omettre entièrement la clause ENVIRONMENT ou définir environment_version = 'None' n’active pas cette fonctionnalité sur ces types d’instances de calcul. Le calcul classique ne nécessite pas d’environnement version 6.

Pour effectuer des appels sortants à partir d’une UDF Python scalaire ou par lot d’Unity Catalog sur un entrepôt SQL sans serveur, activez la préversion publique Activer la mise en réseau pour les charges de travail isolées dans les entrepôts SQL sans serveur sur la page Préversions de votre espace de travail. Les entrepôts SQL Pro ne nécessitent pas cette préversion.

Pour créer un UDF du catalogue Unity qui déclare une identifiante de service, le créateur de fonction doit avoir ACCESS sur cette identifiante. Pour le calcul sans serveur, les entrepôts SQL Pro et sans serveur, ainsi que le calcul en mode d’accès standard, les appelants doivent disposer des privilèges de fonction habituels, y compris EXECUTE, mais n’ont pas besoin de ACCESS sur les informations d’identification. Pour le calcul en mode d’accès dédié, les appelants doivent également avoir ACCESS.

Les UDF PySpark de portée session utilisent les autorisations de l’appelant. L’appelant doit avoir ACCESS sur l’identifiant de service ; sur le calcul en mode d’accès dédié, l’appelant doit avoir MANAGE.

Voir les versions de l’environnement et les exigences de dépendances personnalisées.

Exemple Python : configurer un client du Kit de développement logiciel (SDK) Azure pour utiliser des informations d’identification de service spécifiques

from azure.keyvault.secrets import SecretClient # example Azure SDK client

credential = dbutils.credentials.getServiceCredentialsProvider('your-service-credential')
vault_url = "https://your-keyvault-name.vault.azure.net/"
client = SecretClient(vault_url=vault_url, credential=credential)

Spécifier des informations d’identification de service par défaut pour une ressource de calcul

Vous pouvez, si vous le souhaitez, spécifier un identifiant de service par défaut pour un cluster de calcul polyvalent ou un cluster de calcul pour les tâches en définissant une variable d’environnement. Par défaut, le Kit de développement logiciel (SDK) utilise ces informations d’identification de service si aucune authentification n’est fournie. Les utilisateurs ont toujours besoin ACCESS sur les informations d’identification de ce service pour se connecter au service cloud externe. Databricks ne recommande pas cette approche, car elle rend votre code moins portable que de nommer l’identifiant de service dans votre code.

Remarque

Les entrepôts de calcul serverless et SQL ne prennent pas en charge les variables d’environnement. Par conséquent, ils ne prennent pas en charge les informations d’identification de service par défaut.

  1. Ouvrez la page de modification du cluster.

    Consultez Gérer le calcul classique.

  2. Cliquez sur Avancé en bas de la page et accédez à l’onglet Spark .

  3. Ajoutez l’entrée suivante dans les variables d’environnement, en <your-service-credential>remplaçant :

    DATABRICKS_DEFAULT_SERVICE_CREDENTIAL_NAME=<your-service-credential>

Les exemples de code suivants ne spécifient pas d’informations d’identification de service. Au lieu de cela, ils utilisent les informations d’identification du service spécifiées dans la variable d’environnement DATABRICKS_DEFAULT_SERVICE_CREDENTIAL_NAME :

Python

Si vous utilisez des informations d’identification de service par défaut, vous n’avez pas besoin de spécifier les informations d’identification en tant qu’argument :

from azure.identity import DefaultAzureCredential
from azure.keyvault.secrets import SecretClient

credential = DefaultAzureCredential()
vault_url = "https://your-keyvault-name.vault.azure.net/"
client = SecretClient(vault_url=vault_url, credential=credential)

Comparez cela à l’exemple dans Python : configurez un client Kit de développement logiciel (SDK) Azure pour utiliser une information d’identification de service spécifique, qui ne nécessite pas d’importation DefaultAzureCredential et ajoute la spécification de l’information d’identification :

credential = dbutils.credentials.getServiceCredentialsProvider('your-service-credential')