Dela via


Aktivera eller inaktivera OAuth-partnerprogram

Den här artikeln beskriver hur du aktiverar och inaktiverar OAuth-partnerprogram för ditt Azure Databricks-konto.

dbt Core-, Power BI-, Tableau Desktop- och Tableau Cloud OAuth-program är aktiverade som standard för ditt konto.

Kommentar

Det kan ta 30 minuter att bearbeta uppdateringar av OAuth-program.

Aktivera eller inaktivera appar med Databricks CLI

I det här avsnittet beskrivs hur du använder Databricks CLI för att inaktivera de OAuth-partnerprogram som är aktiverade som standard för ditt konto och hur du återaktiverar dem när de har inaktiverats. Den beskriver också hur du aktiverar och inaktiverar Tableau Server, vilket inte är aktiverat som standard.

Innan du börjar

Innan du aktiverar eller inaktiverar partner-OAuth-programintegreringar med databricks CLI gör du följande:

  • Installera Databricks CLI- och konfigurera autentisering mellan Databricks CLI och ditt Databricks-konto.

  • Om du vill inaktivera eller ändra ett befintligt OAuth-program letar du upp integrations-ID:t.

    • Kör följande kommando för dbt Core, Power BI, Tableau Desktop eller Tableau Cloud:

      databricks account published-app-integration list
      
    • Kör följande kommando för anpassade program, till exempel Tableau Server:

      databricks account custom-app-integration list
      

    Det unika integrations-ID:t för varje OAuth-program returneras.

Inaktivera dbt Core-, Power BI-, Tableau Desktop- eller Tableau Cloud OAuth-programmet med hjälp av CLI

dbt Core-, Power BI-, Tableau Desktop- och Tableau Cloud OAuth-program är aktiverade som standard för ditt konto. Om du vill inaktivera ett dbt Core-, Power BI-, Tableau Desktop- eller Tableau Cloud OAuth-program kör du följande kommando och ersätter med integrations-ID <integration-id> :t för det OAuth-program som du vill ta bort:

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

Återaktivera dbt Core, Power BI, Tableau Desktop eller Tableau Cloud OAuth-programmet med hjälp av CLI

dbt Core, Power BI, Tableau Desktop och Tableau Cloud är aktiverade som OAuth-program i ditt konto som standard. Om du vill återaktivera ett av dessa OAuth-program när det har inaktiverats kör du följande kommando och ersätter <application-id> med databricks-dbt-adapter, power-bitableau-desktopeller 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud):

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

Det unika integrations-ID:t för OAuth-programmet returneras.

Aktivera anpassade OAuth-program med hjälp av CLI

dbt Core-, Power BI-, Tableau Desktop- och Tableau Cloud OAuth-program är aktiverade som standard för ditt konto. Du kan använda Azure Databricks CLI för att aktivera ytterligare anpassade OAuth-program.

Anvisningar för hur du aktiverar ett anpassat Tableau Server OAuth-program finns i Konfigurera Azure Databricks-inloggning från Tableau Server. Allmänna steg för att aktivera alla anpassade OAuth-program med hjälp av CLI finns i följande:

  1. Kör kommandot custom-app-integration create. I följande exempel skapas ett icke-offentligt (konfidentiellt) program:

    databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
    
    • Ersätt <name> med ett namn för ditt anpassade OAuth-program.
    • Ersätt <redirect-url> med omdirigerings-URL:er för ditt program.
    • Ersätt <scopes> med listan över omfång som du vill tillåta för programmet.
      • För BI-program krävs omfånget SQL för att den anslutna appen ska få åtkomst till Databricks SQL-API:er.
      • För program som behöver komma åt Databricks-API:er för andra syften än SQL krävs omfånget ALL APIs .
      • Omfången openid, emailoch profile krävs för att generera ID-token.
      • Omfånget offline_access krävs för att generera uppfriskningstokener.

    Mer information om värden som stöds finns i POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations i REST API-referensen.

    Ett klient-ID genereras. För icke-offentliga (konfidentiella) program genereras även en klienthemlighet. Följande utdata returneras:

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

    Kommentar

    Det kan ta 30 minuter att aktivera ett OAuth-program.

  2. Lagra klienthemligheten på ett säkert sätt, om tillämpligt.

    Viktigt!

    Du kan inte hämta klienthemligheten senare.

Inaktivera anpassade OAuth-program med hjälp av CLI

Om du vill inaktivera ett befintligt anpassat OAuth-program, till exempel Tableau Server, kör du följande kommando och ersätter med integrations-ID <integration-id> :t för det OAuth-program som du vill inaktivera:

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

Aktivera anpassade OAuth-program med hjälp av Azure Databricks-användargränssnittet

dbt Core-, Power BI-, Tableau Desktop- och Tableau Cloud OAuth-program är aktiverade som standard för ditt konto. Du kan använda Användargränssnittet för Azure Databricks för att aktivera ytterligare anpassade OAuth-program.

Om du vill aktivera ett anpassat OAuth-program i användargränssnittet gör du följande:

  1. Logga in på kontokonsolen och klicka på ikonen Inställningar i sidofältet.

  2. På fliken Appanslutningar klickar du på Lägg till anslutning.

  3. Ange följande detaljerad information:

    1. Ett namn på anslutningen.

    2. Omdirigerings-URL:er för din OAuth-anslutning.

    3. För Åtkomstomfattningar ska de API:er som programmet ska ha åtkomst till.

      • För BI-program krävs omfånget SQL för att den anslutna appen ska få åtkomst till Databricks SQL-API:er.
      • För program som behöver komma åt Databricks-API:er för andra syften än att fråga krävs omfånget ALL APIs .

      Följande omfång tillåts automatiskt:

      • openid, email, profile: Krävs för att generera ID-token.
      • offline_access: Krävs för att generera uppdateringstoken.

      Om du inte vill tillåta dessa omfång för programmet kan du hantera detaljerade omfång med hjälp av API:et POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations för att skapa ditt anpassade program.

    4. TTL (time to live) för åtkomsttoken på några minuter. Standard: 60.

    5. Tidsgräns för uppdateringstokenns livslängd (TTL) i minuter. Standard: 10080.

    6. Om du vill generera en klienthemlighet. Detta krävs för icke-offentliga (konfidentiella) klienter.

      Dialogrutan Anslutning som skapats visar klient-ID:t och klienthemligheten, om tillämpligt, för anslutningen.

  4. Om du har valt Generera en klienthemlighetkopierar du och lagrar klienthemligheten på ett säkert sätt. Du kan inte hämta klienthemligheten senare.

Du kan redigera omdirigerings-URL:en, tidsgränsen för token och uppdateringstoken för befintliga anpassade OAuth-program i användargränssnittet genom att klicka på programnamnet på sidan Inställningar>Appanslutningar i kontots konsol. Du kan också visa dina befintliga publicerade OAuth-program (dbt Core, Power BI, Tableau) i användargränssnittet. Du kan redigera TTL för token och uppdatera TTL för befintliga publicerade program.

Du kan inaktivera både publicerade och anpassade OAuth-program i användargränssnittet genom att antingen klicka på programnamnet eller på menyn kebab bredvid programnamnet och sedan klicka på Ta bort.

Kommentar

Om du inaktiverar ett program bryts programanslutningen, så var försiktig när du inaktiverar OAuth-program. Om du inaktiverar ett publicerat OAuth-program i användargränssnittet kan det inte återaktiveras i användargränssnittet. Information om hur du återaktiverar ett publicerat program finns i Återaktivera dbt Core, Power BI, Tableau Desktop eller Tableau Cloud OAuth-programmet med hjälp av CLI.