Aktivieren oder Deaktivieren von OAuth-Partneranwendungen

In diesem Artikel wird beschrieben, wie Sie OAuth-Partneranwendungen für Ihr Azure Databricks-Konto aktivieren und deaktivieren.

DBT Core-, Power BI-, Tableau Desktop- und Tableau Cloud OAuth-Anwendungen sind für Ihr Konto standardmäßig aktiviert.

Aktivieren oder Deaktivieren von Apps mithilfe der Databricks CLI

In diesem Abschnitt wird beschrieben, wie Sie die Databricks CLI verwenden, um die OAuth-Partneranwendungen zu deaktivieren, die standardmäßig für Ihr Konto aktiviert sind, und wie Sie sie nach dem Deaktivieren erneut aktivieren. Außerdem wird beschrieben, wie Tableau Server, der standardmäßig nicht aktiviert ist, aktiviert und deaktiviert wird.

Voraussetzungen

Führen Sie vor dem Aktivieren oder Deaktivieren von OAuth-Anwendungsintegrationen mit der Databricks CLI die folgenden Schritte aus:

• Installieren Sie die Databricks CLI und richten Sie die Authentifizierung zwischen der Databricks CLI und Ihrem Databricks-Konto ein.

• Um eine vorhandene OAuth-Anwendung zu deaktivieren oder zu ändern, suchen Sie die Integrations-ID.

  • Führen Sie für DBT Core, Power BI, Tableau Desktop oder Tableau Cloud den folgenden Befehl aus:

    databricks account published-app-integration list
    

  • Führen Sie für benutzerdefinierte Anwendungen wie Tableau Server den folgenden Befehl aus:

    databricks account custom-app-integration list
    

  Die eindeutige Integrations-ID für jede OAuth-Anwendung wird zurückgegeben.

Deaktivieren der DBT Core-, Power BI-, Tableau Desktop- oder Tableau Cloud OAuth-Anwendung mithilfe der CLI

DBT Core-, Power BI-, Tableau Desktop- und Tableau Cloud OAuth-Anwendungen sind für Ihr Konto standardmäßig aktiviert. Um eine DBT Core-, Power BI-, Tableau Desktop- oder Tableau Cloud OAuth-Anwendung zu deaktivieren, führen Sie den folgenden Befehl aus, und ersetzen Sie dabei <integration-id> durch die Integrations-ID der OAuth-Anwendung, die Sie löschen möchten:

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

Reaktivieren der DBT Core-, Power BI-, Tableau Desktop- oder Tableau Cloud OAuth-Anwendung mithilfe der CLI

DBT Core, Power BI, Tableau Desktop und Tableau Cloud sind standardmäßig als OAuth-Anwendungen in Ihrem Konto aktiviert. Um eine dieser OAuth-Anwendungen nach dem Deaktivieren erneut zu aktivieren, führen Sie den folgenden Befehl aus, ersetzen Sie <application-id> durch databricks-dbt-adapter, power-bi, tableau-desktop oder 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud):

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

Die eindeutige Integrations-ID für die OAuth-Anwendung wird zurückgegeben.

Aktivieren von benutzerdefinierten OAuth-Anwendungen mithilfe der CLI

DBT Core-, Power BI-, Tableau Desktop- und Tableau Cloud OAuth-Anwendungen sind für Ihr Konto standardmäßig aktiviert. Sie können die Azure Databricks CLI verwenden, um zusätzliche benutzerdefinierte OAuth-Anwendungen zu aktivieren.

Schritte zum Aktivieren einer benutzerdefinierten Tableau Server OAuth-Anwendung finden Sie unter Konfigurieren der Azure Databricks-Anmeldung von Tableau Server. Allgemeine Schritte zum Aktivieren einer benutzerdefinierten OAuth-Anwendung mithilfe der CLI finden Sie in den folgenden Themen:

1. Führen Sie den Befehl custom-app-integration create aus. Im folgenden Beispiel wird eine nicht öffentliche (vertrauliche) Anwendung erstellt:

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

   • Ersetzen Sie <name> durch einen Namen für Ihre benutzerdefinierte OAuth-Anwendung.
   • Ersetzen Sie <redirect-url> durch die Umleitungs-URLs für Ihre Anwendung.
   • Ersetzen Sie <scopes> mit der Liste der Bereiche, die Sie für die Anwendung zulassen möchten.
     • Für BI-Anwendungen ist der SQL-Bereich erforderlich, damit die verbundene App auf SQL-APIs von Databricks zugreifen kann.
     • Für Anwendungen, die für andere Zwecke als SQL auf Databricks-APIs zugreifen müssen, ist der ALL APIs-Bereich erforderlich.
     • Die Bereiche openid, email und profile sind erforderlich, um das ID-Token zu generieren.
     • Der offline_access-Bereich ist erforderlich, um Aktualisierungstoken zu generieren.

   Weitere Informationen zu unterstützten Werten finden Sie unter POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations in der REST-API-Referenz.

   Es wird eine Client-ID generiert. Bei nicht öffentlichen (vertraulichen) Anwendungen wird auch ein geheimer Clientschlüssel generiert. Die folgende Ausgabe wird zurückgegeben:

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

   Hinweis

   Das Verarbeiten einer Aktivierung einer OAuth-Anwendung kann 30 Minuten dauern.

2. Speichern Sie, falls vorhanden, den geheimen Clientschlüssel sicher.

   Wichtig

   Sie können den geheimen Clientschlüssel später nicht abrufen.

Deaktivieren von benutzerdefinierten OAuth-Anwendungen mithilfe der CLI

Um eine vorhandene benutzerdefinierte OAuth-Anwendung wie Tableau Server zu deaktivieren, führen Sie den folgenden Befehl aus, und ersetzen Sie <integration-id> durch die Integrations-ID der OAuth-Anwendung, die Sie deaktivieren möchten:

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

Aktivieren benutzerdefinierter OAuth-Anwendungen über die Azure Databricks-Benutzeroberfläche

DBT Core-, Power BI-, Tableau Desktop- und Tableau Cloud OAuth-Anwendungen sind für Ihr Konto standardmäßig aktiviert. Sie können die Azure Databricks-Benutzeroberfläche verwenden, um zusätzliche benutzerdefinierte OAuth-Anwendungen zu aktivieren.

Gehen Sie wie folgt vor, um eine benutzerdefinierte OAuth-Anwendung auf der Benutzeroberfläche zu aktivieren:

1. Melden Sie sich bei der Kontokonsole an, und klicken Sie in der Seitenleiste auf das Symbol Einstellungen.

2. Klicken Sie auf der Registerkarte App-Verbindungen auf Verbindung hinzufügen.

3. Geben Sie die folgenden Details ein:

   1. Ein Name für Ihre Verbindung.

   2. Die Umleitungs-URLs für Ihre OAuth-Verbindung

   3. Für Zugriffsbereiche die APIs, auf die die Anwendung Zugriff haben soll

      • Für BI-Anwendungen ist der SQL-Bereich erforderlich, damit die verbundene App auf SQL-APIs von Databricks zugreifen kann.
      • Für Anwendungen, die für andere Zwecke als Abfragen auf Databricks-APIs zugreifen müssen, ist der ALL APIs-Bereich erforderlich.

      Die folgenden Bereiche sind automatisch zulässig:

      • openid, email, profile: Erforderlich, um das ID-Token zu generieren
      • offline_access: Erforderlich, um Aktualisierungstoken zu generieren

      Wenn Sie diese Bereiche für die Anwendung nicht zulassen möchten, können Sie mithilfe der API POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations differenzierte Bereiche verwalten, um Ihre benutzerdefinierte Anwendung zu erstellen.

   4. Die Gültigkeitsdauer (Time-To-Live, TTL) des Zugriffstokens in Minuten. Standardwert: 60.

   5. Die Gültigkeitsdauer (Time-To-Live, TTL) des Aktualisierungstokens in Minuten. Standardwert: 10080.

   6. Geben Sie an, ob ein geheimer Clientschlüssel erstellt werden soll. Dieser ist für nicht öffentliche (vertrauliche) Clients erforderlich.

      Im Dialogfeld Verbindung erstellt werden ggf. die Client-ID und der geheime Clientschlüssel für Ihre Verbindung angezeigt.

4. Wenn Sie Geheimen Clientschlüssel generieren ausgewählt haben, kopieren Sie den geheimen Clientschlüssel, und speichern Sie ihn an einem sicheren Ort. Sie können den geheimen Clientschlüssel später nicht abrufen.

Sie können die Umleitungs-URL sowie die Gültigkeitsdauer für Token und Aktualisierungstoken für vorhandene benutzerdefinierte OAuth-Anwendungen auf der Benutzeroberfläche bearbeiten, indem Sie auf der Seite Einstellungen>App-Verbindungen in der Kontokonsole auf den Anwendungsnamen klicken. Sie können auch Ihre vorhandenen veröffentlichten OAuth-Anwendungen (dbt Core, Power BI, Tableau) auf der Benutzeroberfläche anzeigen. Sie können die Token-TTL und die Aktualisierungstoken-TTL für vorhandene veröffentlichte Anwendungen aktualisieren.

Sie können sowohl veröffentlichte als auch benutzerdefinierte OAuth-Anwendungen auf der Benutzeroberfläche deaktivieren, indem Sie entweder auf den Anwendungsnamen oder dem Kebab Menü neben dem Anwendungsnamen und dann auf Entfernen klicken.