Del via


Opret forbindelse mellem programmer og Fabric API til GraphQL

Hvis du vil forbinde et program til en API til GraphQL, skal du bruge tre vigtige oplysninger: et klient-id, dit lejer-id og din GraphQL-slutpunktsadresse i Fabric. I de følgende afsnit viser vi, hvordan du opretter og henter alle de oplysninger, du har brug for, og hvordan du får adgang til din API ved hjælp af et eksempelprogram.

Forudsætninger

  • Før du opretter forbindelse til et program, skal du have en API til GraphQL i Fabric. Du kan få flere oplysninger under Opret en API til GraphQL i Fabric, og tilføj data.

  • API til GraphQL kræver i øjeblikket, at programmer bruger Microsoft Entra til godkendelse. Dit program skal registreres og konfigureres korrekt for at kunne udføre API-kald mod Fabric. Du kan få flere oplysninger under Opret en Microsoft Entra-app i Azure.

  • De godkendte legitimationsoplysninger (brugerprincipal, tjenesteprincipal eller administreret identitet), der kalder API'en, kræver Udfør-tilladelser til GraphQL-API'en (kør forespørgsler og mutationer, når du tilføjer tilladelser til direkte adgang), og hvis du bruger enkeltlogon (SSO) som forbindelsesmulighed i API'en, kræves læse- eller skrivetilladelser i den valgte datakilde i overensstemmelse hermed. Du kan få flere oplysninger under Opret forbindelse til en datakilde, og opret dit skema.

Opret en Microsoft Entra-app

I følgende trin viser vi, hvordan du konfigurerer understøttelse af et ReactJS-program i Microsoft Entra.

  1. Registrer et program ved hjælp af de trin, der er beskrevet i Hurtig start: Registrer et program med Microsoft-identitetsplatformen.
  2. Værdierne for dit Microsoft Entra-appprogram (klient) id og mappe-id (lejer) vises i feltet Oversigt. Registrer disse værdier, som de er påkrævet senere.
  3. På listen Administrer skal du vælge API-tilladelserog derefter Tilføj tilladelse.
  4. Tilføj PowerBI-tjenesten, vælg Delegerede tilladelser, og vælg GraphQLApi.Execute.All permissions. Sørg for, at administratorsamtykke ikke er påkrævet.
  5. Tilbage til listen Administrer skal du vælge Godkendelse>Tilføj en platform, >enkeltsidet program.
  6. I forbindelse med lokal udvikling skal du tilføje http://localhost:3000 under Omdirigerings-URI'er og bekræfte, at programmet er aktiveret for godkendelseskodeflowet med proof key for Code Exchange (PKCE). Vælg knappen Konfigurer for at gemme dine ændringer. Hvis programmet modtager en fejl, der er relateret til anmodninger på tværs af oprindelser, skal du tilføje platformen mobil- og skrivebordsprogrammer i det forrige trin med den samme omdirigerings-URI.
  7. Gå tilbage til Godkendelse, rul ned til avancerede indstillinger, og under Tillad offentlige klientflowskal du vælge Ja for at Aktivér følgendepå mobilenheder og stationære computere .

Konfigurer en GraphQL-eksempel-API til programadgang

I dette eksempel opretter vi en GraphQL-API for at vise lakehouse-eksempeldata for klienter.

  1. Vælg Dataudvikler på listen over arbejdsbelastninger på startsiden for Fabric-portalen.

  2. I Dataudvikler skal du vælge Brug et eksempel, og under Lakehouse skal du vælge Helligdage for automatisk at oprette et nyt Lakehouse med helligdage.

    Skærmbillede af valg af indstillingen Eksempeldata Lakehouse.

  3. Når du følger trinnene fra Opret en API til GraphQL, skal du oprette en ny GraphQL-API og vælge det Lakehouse, du har oprettet. Tilføj tabellen helligdage for at give klienterne adgang til disse data.

    Skærmbillede af tilføjelse af Lakehouse-eksemplet som GraphQL-datakilde.

  4. Test GraphQL-API'en i API-editoren ved hjælp af følgende eksempelforespørgsel. Det er den samme forespørgsel, vi bruger i vores React-klientprogram:

     query {
       publicholidays (filter: {countryRegionCode: {eq:"US"}, date: {gte: "2024-01-01T00:00:00.000Z", lte: "2024-12-31T00:00:00.000Z"}}) {
         items {
           countryOrRegion
           holidayName
           date
         }
       }
     }
    
  5. Vælg Kopiér slutpunkt på API-elementets værktøjslinje.

    Skærmbillede af værktøjslinjeindstillingerne for et API-element.

  6. Vælg Kopiérskærmen Kopiér link.

    Skærmbillede af dialogboksen Kopiér link, der viser, hvor du skal vælge Kopiér.

  7. Som klient-id og lejer-id fra Microsoft Entra-appen, der er registreret tidligere, skal du kopiere slutpunktets URI, som det er påkrævet senere.

Konfigurer en React-app for at få adgang til API'en for helligdage

  1. Vi bruger en eksisterende React-app som udgangspunkt. Følg alle trinnene i selvstudiet Opret et React-enkeltsidet program, og forbered det til godkendelse for at oprette et React-projekt, hvor Microsoft Entra-godkendelse allerede er konfigureret, herunder yderligere filer og mapper, der skal føjes til projektstrukturen. Vi behøver kun at ændre tre filer for at tilpasse appen til vores GraphQL-brugscase.

  2. Åbn filen authConfig.js i mappen src, og erstat indholdet af filen med følgende kodestykke:

     /*
      * Copyright (c) Microsoft Corporation. All rights reserved.
      * Licensed under the MIT License.
      */
    
     import { LogLevel } from "@azure/msal-browser";
    
     /**
      * Configuration object to be passed to MSAL instance on creation. 
      * For a full list of MSAL.js configuration parameters, visit:
      * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/configuration.md 
      */
    
     export const graphqlConfig = {
         graphqlEndpoint: "`Enter_the_GraphQL_Endpoint_Here"
     };
    
     export const msalConfig = {
         auth: {
             clientId: "Enter_the_Application_Id_Here",
             authority: "https://login.microsoftonline.com/Enter_the_Tenant_Info_Here",
             redirectUri: "http://localhost:3000",
         },
         cache: {
             cacheLocation: "sessionStorage", // This configures where your cache will be stored
             storeAuthStateInCookie: false, // Set this to "true" if you are having issues on IE11 or Edge
         },
         system: {	
             loggerOptions: {	
                 loggerCallback: (level, message, containsPii) => {	
                     if (containsPii) {		
                         return;		
                     }		
                     switch (level) {
                         case LogLevel.Error:
                             console.error(message);
                             return;
                         case LogLevel.Info:
                             console.info(message);
                             return;
                         case LogLevel.Verbose:
                             console.debug(message);
                             return;
                         case LogLevel.Warning:
                             console.warn(message);
                             return;
                         default:
                             return;
                     }	
                 }	
             }	
         }
     };
    
     /**
      * Scopes you add here will be prompted for user consent during sign-in. 
      * By default, MSAL.js will add OIDC scopes (openid, profile, email) to any login request.
      * For more information about OIDC scopes, visit: 
      * https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#openid-connect-scopes
      */
     export const loginRequest = {
         scopes: ["https://analysis.windows.net/powerbi/api/GraphQLApi.Execute.All"]
     };
    
     /**
      * Add here the scopes to request when obtaining an access token for MS Graph API. For more information, see:
      * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/resources-and-scopes.md
      */
     export const graphConfig = {
         graphMeEndpoint: "https://graph.microsoft.com/v1.0/me",
     };
    

    Som du kan se i ovenstående kode, er det vigtigt at bruge det korrekte område til at få adgang til programmet. I vores tilfælde https://analysis.windows.net/powerbi/api/GraphQLApi.Execute.All.

  3. Erstat følgende værdier med værdierne fra Microsoft Entra Administration.

    • clientId - Programmets id, også kaldet klienten. Erstat Enter_the_Application_Id_Here med den program-id-værdi (klient), der blev registreret tidligere fra oversigtssiden for det registrerede Microsoft Entra-program.
    • authority - Dette består af to dele:
      • Forekomsten er slutpunktet for cloududbyderen. Kontakt de forskellige tilgængelige slutpunkter i nationale cloudmiljøer.
      • Lejer-id'et er id'et for den lejer, hvor programmet er registreret. Erstat Enter_the_Tenant_Info_Here med den mappe-id-værdi (lejer), der blev registreret tidligere fra oversigtssiden for det registrerede program.
    • graphQLEndpoint – Fabric API til GraphQL-slutpunktet. Erstat Enter_the_GraphQL_Endpoint_Here med GraphQL API-slutpunktet, der er registreret tidligere.
  4. Gem filen.

  5. Åbn App.js-fileni den samme src-mappe, og erstat indholdet af filen med følgende kodestykke:

     import React, { useState } from 'react';
     import { PageLayout } from './components/PageLayout';
     import { loginRequest, graphqlConfig } from './authConfig';
     import { ProfileData } from './components/ProfileData';
     import { AuthenticatedTemplate, UnauthenticatedTemplate, useMsal } from '@azure/msal-react';
     import './App.css';
     import Button from 'react-bootstrap/Button';
     import Spinner from 'react-bootstrap/Spinner';
    
     /**
     * Renders information about the signed-in user or a button to retrieve data about the user
     */
     const ProfileContent = () => {
       const { instance, accounts } = useMsal();
       const [graphqlData, setGraphqlData] = useState(null);
       const [display, setDisplay] = useState(false);
    
       function RequestGraphQL() {
           // Silently acquires an access token which is then attached to a request for GraphQL data
           instance
               .acquireTokenSilent({
                   ...loginRequest,
                   account: accounts[0],
               })
               .then((response) => {
                   callGraphQL(response.accessToken).then((response) => setGraphqlData(response));
               });
       }
    
     async function callGraphQL(accessToken) {
       setDisplay(true);
       const query = `query {
         publicholidays (filter: {countryRegionCode: {eq:"US"}, date: {gte: "2024-01-01T00:00:00.000Z", lte: "2024-12-31T00:00:00.000Z"}}) {
           items {
             countryOrRegion
             holidayName
             date
           }
         }
       }`;
       fetch(graphqlConfig.graphqlEndpoint, {
               method: 'POST',
               headers: {
                   'Content-Type': 'application/json',
                   'Authorization': `Bearer ${accessToken}`,
               },
               body: JSON.stringify({ 
                   query: query
               })
           })
           .then((res) => res.json())
           .then((result) => setGraphqlData(result));
     }
    
       return (
           <>
               <h5 className="card-title">Welcome {accounts[0].name}</h5>
               <br/>
               {graphqlData ? (
                   <ProfileData graphqlData={graphqlData} />
               ) : (
                   <Button variant="primary" onClick={RequestGraphQL}>
                       Query Fabric API for GraphQL Data 
                       {display ? (
                             <Spinner
                                 as="span"
                                 animation="border"
                                 size="sm"
                                 role="status"
                                 aria-hidden="true"
                             />
                         ) : null}
                   </Button>
               )}
           </>
       );
     };
    
     /**
     * If a user is authenticated the ProfileContent component above is rendered. Otherwise a message indicating a user is not authenticated is rendered.
     */
     const MainContent = () => {
       return (
           <div className="App">
               <AuthenticatedTemplate>
                   <ProfileContent />
               </AuthenticatedTemplate>
    
               <UnauthenticatedTemplate>
                   <h5>
                       <center>
                           Please sign-in to see your profile information.
                       </center>
                   </h5>
               </UnauthenticatedTemplate>
           </div>
       );
     };
    
     export default function App() {
       return (
           <PageLayout>
               <center>
                   <MainContent />
               </center>
           </PageLayout>
       );
     }
    
  6. Gem filen.

  7. Til sidst skal du åbne filen ProfileData.jsx under mappen src/components og erstatte indholdet af filen med følgende kodestykke:

     import React from "react";
     import ListGroup from 'react-bootstrap/ListGroup'; 
     import Table from 'react-bootstrap/Table';
     /**
      * Renders information about the user obtained from MS Graph 
      * @param props
      */
     export const ProfileData = (props) => {
       const holidays = props.graphqlData.data.publicholidays.items;
       return (
         <Table striped bordered hover responsive>
         <thead>
           <tr>
             <th>Country</th>
             <th>Holiday</th>
             <th>Date</th>
           </tr>
         </thead>
         <tbody>
           {holidays.map((item,i) => (
           <tr key={i}>
             <td>{item.countryOrRegion}</td>
             <td>{item.holidayName}</td>
             <td>{item.date}</td>
           </tr>
           ))}
           </tbody>
         </Table>
     )};
    
  8. Gem alle filændringerne.

  9. I den valgte terminalanvendelse skal du gå til rodmappen for React-projektet og udføre kommandoen npm start for at teste programmet lokalt.

  10. Når programmet indlæses i din browser fra http://localhost:3000, skal du følge trinnene i den sidste del af selvstudiet Kald API'en fra programmet for at godkende.

  11. Når du har logget på, skal du klikke på knappen Query Fabric API til GraphQL-data.

    Skærmbillede af React-eksempelappen, når du har logget på.

  12. En godkendt anmodning til GraphQL-API'en i Fabric returnerer dataene fra GraphQL-forespørgslen til Lakehouse i vores React-klientprogram:

    Skærmbillede af React-eksempelappen efter modtagelse af GraphQL-anmodningen.

Andre sprog

Find eksempler på C#, Python og andre sprog for at oprette forbindelse til din GraphQL-API i GitHub-lageret til Microsoft Fabric Samples.