Activer ou désactiver des applications OAuth partenaires

Cet article explique comment activer et désactiver des applications OAuth partenaires pour votre compte Azure Databricks.

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par défaut pour votre compte.

Activer ou désactiver des applications à l’aide de l’interface CLI Databricks

Cette section explique comment utiliser l’interface CLI Databricks pour désactiver les applications OAuth partenaires activées par défaut pour votre compte, et comment les réactiver une fois qu’elles ont été désactivées. Il décrit également comment activer et désactiver Tableau Server, qui n’est pas activé par défaut.

Avant de commencer

Avant d’activer ou de désactiver les intégrations d’applications OAuth partenaires à l’aide de l’interface CLI Databricks, procédez comme suit :

• Installez l’interface CLI Databricks et configurez l’authentification entre l’interface CLI Databricks et votre compte Databricks.

• Pour désactiver ou modifier une application OAuth existante, recherchez l’ID d’intégration.

  • Pour dbt Core, Power BI, Tableau Desktop ou Tableau Cloud exécutez la commande suivante :

    databricks account published-app-integration list
    

  • Pour les applications personnalisées, comme Tableau Server, exécutez la commande suivante :

    databricks account custom-app-integration list
    

  L’ID d’intégration unique pour chaque application OAuth est retourné.

Désactiver l’application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud à l’aide de l’interface CLI

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par défaut pour votre compte. Pour désactiver une application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, exécutez la commande suivante, en remplaçant <integration-id> par l’ID d’intégration de l’application OAuth que vous voulez supprimer :

databricks account published-app-integration delete <integration-id>

Réactiver l’application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud à l’aide de l’interface CLI

dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par défaut en tant qu’applications OAuth dans votre compte. Pour réactiver une de ces applications OAuth après sa désactivation, exécutez la commande suivante, en remplaçant <application-id> par databricks-dbt-adapter, power-bi, tableau-desktop ou 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud) :

databricks account published-app-integration create <application-id>

L’ID d’intégration unique pour chaque application OAuth est retourné.

Activer des applications OAuth personnalisées à l’aide de l’interface CLI

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par défaut pour votre compte. Vous pouvez utiliser l’interface CLI Azure Databricks pour activer d’autres applications OAuth personnalisées.

Pour savoir comment activer une application OAuth personnalisée pour Tableau Server, consultez Configurer la connexion Azure Databricks depuis Tableau Server. Pour connaître les étapes génériques permettant d’activer une application OAuth personnalisée à l’aide de l’interface CLI, consultez ce qui suit :

1. Exécutez la commande custom-app-integration create. L’exemple suivant crée une application non publique (confidentielle) :

   databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
   

   • Remplacez <name> par un nom pour votre application OAuth personnalisée.
   • Remplacez <redirect-url> par les URL de redirection de votre application.
   • Remplacez <scopes> par la liste des portées que vous souhaitez autoriser pour l’application.
     • Pour les applications BI, la portée SQL est nécessaire pour permettre à l’application connectée d’accéder aux API SQL de Databricks.
     • Pour les applications qui doivent accéder aux API Databricks à d’autres fins que le SQL, la portée ALL APIs est requise.
     • Les portées openid, emailet profile sont requises pour générer le jeton d’ID.
     • L’étendue offline_access est requise pour générer des jetons d’actualisation.

   Pour plus d’informations sur les valeurs prises en charge, consultez POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations dans la référence de l’API REST.

   Un ID client est généré. Pour les applications non publiques (confidentielles), une clé secrète client est également générée. Voici les résultats qui sont retournés :

   {"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
   

   Remarque

   L’activation d’une application OAuth peut prendre 30 minutes.

2. Stockez en toute sécurité la clé secrète client le cas échéant.

   Important

   Vous ne pouvez pas récupérer la clé secrète client ultérieurement.

Désactiver des applications OAuth personnalisées à l’aide de l’interface CLI

Pour désactiver une application OAuth personnalisée existante, comme Tableau Server, exécutez la commande suivante en remplaçant <integration-id> par l’identifiant d’intégration de l’application OAuth que vous souhaitez désactiver :

databricks account custom-app-integration delete <integration-id>

Activer des applications OAuth personnalisées à l’aide de l’interface utilisateur d’Azure Databricks

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par défaut pour votre compte. Vous pouvez utiliser l’interface utilisateur d’Azure Databricks pour activer des applications OAuth personnalisées supplémentaires.

Pour activer une application OAuth personnalisée dans l’interface utilisateur, effectuez les étapes suivantes :

1. Connectez-vous à la console du compte et cliquez sur l’icône Paramètres dans la barre latérale.

2. Sous l’onglet Connexions d’application, cliquez sur Ajouter une connexion.

3. Entrez les informations suivantes :

   1. Un nom pour votre connexion.

   2. Les URL de redirection pour votre connexion OAuth.

   3. Pour Étendues d’accès, indiquez les API auxquelles l’application doit avoir accès.

      • Pour les applications BI, la portée SQL est nécessaire pour permettre à l’application connectée d’accéder aux API SQL de Databricks.
      • Pour les applications qui doivent accéder aux API Databricks à d’autres fins que l’interrogation, l’étendue ALL APIs est requise.

      Les étendues suivantes sont automatiquement autorisées :

      • openid, email, profile : requis pour générer le jeton d’ID.
      • offline_access : requis pour générer les jetons d’actualisation.

      Si vous ne souhaitez pas autoriser ces étendues pour l’application, vous pouvez gérer des étendues affinées à l’aide de l’API POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations pour créer votre application personnalisée.

   4. La durée de vie (TTL) du jeton d’accès en minutes. Par défaut : 60.

   5. La durée de vie du jeton d’actualisation en minutes. Par défaut : 10080.

   6. S’il faut générer une clé secrète client. Cette information est obligatoire pour les clients non publics (confidentiels).

      La boîte de dialogue Connexion créée affiche l’ID client et la clé secrète client, le cas échéant, pour votre connexion.

4. Si vous avez sélectionné Générer une clé secrète client, copiez et stockez de manière sécurisée la clé secrète client. Vous ne pouvez pas récupérer la clé secrète client ultérieurement.

Vous pouvez modifier l’URL de redirection, la durée de vie du jeton et la durée de vie du jeton d’actualisation d’applications OAuth personnalisées existantes dans l’interface utilisateur. Pour cela, cliquez sur le nom de l’application dans la page Paramètres>Connexions d’application dans la console de compte. Vous pouvez également afficher les applications OAuth publiées existantes (dbt Core, Power BI, Tableau) dans l’interface utilisateur. Vous pouvez modifier la durée de vie du jeton et la durée de vie du jeton d’actualisation d’applications publiées existantes.

Vous pouvez désactiver des applications OAuth publiées et personnalisées dans l’interface utilisateur. Pour cela, cliquez sur le nom de l’application ou sur le menu kebab en regard du nom de l’application, puis cliquez sur Supprimer.