Zelfstudie: REST API's gebruiken

In deze zelfstudie leert u hoe u de Azure Purview REST API's kunt gebruiken. Iedereen die gegevens wil verzenden naar een Azure Purview, Purview wil opnemen als onderdeel van een geautomatiseerd proces of een eigen gebruikerservaring in Purview wil bouwen, kan de REST API's gebruiken om dit te doen.

Als u geen abonnement op Azure hebt, maakt u een gratis account voordat u begint.

Vereisten

Service-principal (toepassing) maken

Een REST API-client kan toegang tot de catalogus krijgen als de client over een service-principal (toepassing) beschikt en over een identiteit die de catalogus herkent en die zodanig is geconfigureerd dat de service-principal wordt vertrouwd. Wanneer u REST API-aanroepen naar de catalogus uitvoert, wordt gebruikgemaakt van de identiteit van de service-principal.

Klanten die bestaande service-principals (toepassings-id's) hebben gebruikt, kennen een hoge mate van uitval. Daarom wordt u aangeraden een nieuwe service-principal te maken om API's aan te roepen.

Ga als volgt te werk als u een nieuwe service-principal wilt maken:

  1. Meld u aan bij de Azure-portal.

  2. Zoek en selecteer in de portal Azure Active Directory.

  3. Selecteer op de pagina Azure Active Directory de optie App-registraties in het linkerdeelvenster.

  4. Selecteer Nieuwe registratie.

  5. Op de pagina Een toepassing registreren gaat u als volgt te werk:

    1. Voer een naam in voor de toepassing (de naam voor de service-principal).
    2. Selecteer Alleen accounts in deze organisatiemap (alleen <de naam van de tenant> - één tenant) .
    3. Voor Omleidings-URI (optioneel) selecteert u Web en voert u een waarde in. Deze waarde hoeft geen geldige URI te zijn.
    4. Selecteer Registreren.
  6. Kopieer op de pagina voor de service-principal de waarden van de weergavenaam en de toepassings(client)-id om deze voor later te bewaren.

    De toepassings-id is de waarde client_id in de voorbeeldcode.

Als u de service-principal (toepassing) wilt gebruiken, moet u het wachtwoord ervoor ophalen. U doet dit als volgt:

  1. Selecteer in Azure Portal de optie Azure Active Directory en selecteer vervolgens App-registraties in het linkerdeelvenster.

  2. Selecteer de service-principal (toepassing) in de lijst.

  3. Selecteer Certificaten en geheimen in het linkerdeelvenster.

  4. Selecteer Nieuw clientgeheim.

  5. Voer op de pagina Een clientgeheim toevoegen een beschrijving in, selecteer een vervaltijd onder Verloopt en selecteer vervolgens Toevoegen.

    Op de pagina Clientgeheimen is de tekenreeks in de kolom Waarde van het nieuwe geheim uw wachtwoord. Sla deze waarde op.

    Schermopname van een clientgeheim.

Verificatie instellen met behulp van service-principal

Zodra de service-principal is gemaakt, moet u gegevensvlakrollen van uw account voor het opsmaken van gegevens toewijzen aan de service-principal die hierboven is gemaakt. De onderstaande stappen moeten worden gevolgd om een rol toe te wijzen om een vertrouwensrelatie tot stand te brengen tussen de service-principal en het account voor het opsprincipaal maken.

  1. Navigeer naar uw Purview Studio.
  2. Selecteer het Gegevenstoewijzing in het menu links.
  3. Selecteer Verzamelingen.
  4. Selecteer de hoofdverzameling in het menu Verzamelingen. Dit wordt de bovenste verzameling in de lijst en heeft dezelfde naam als uw Purview-account.
  5. Selecteer het tabblad Roltoewijzingen.
  6. Wijs de volgende rollen toe aan de service-principal die hierboven is gemaakt voor toegang tot verschillende gegevensvlakken in Purview.
    1. De rol 'Gegevensmaker' voor toegang tot het vlak Catalogusgegevens.
    2. De rol Gegevensbronbeheerder voor toegang tot het vlak Scangegevens.
    3. De rol 'Verzamelingsbeheerder' voor toegang tot het gegevensvlak van het account.
    4. De rol 'Verzamelingsbeheerder' voor toegang tot het gegevensvlak van het metagegevensbeleid.

Notitie

Alleen 'Verzamelingsbeheerder' kan gegevensvlakrollen toewijzen in Access Control in Azure Purview.

Token op halen

U kunt een POST-aanvraag verzenden naar de volgende URL om het toegang token op te halen.

https://login.microsoftonline.com/{your-tenant-id}/oauth2/token

De volgende parameters moeten worden doorgegeven aan de bovenstaande URL.

  • client_id: client-id van de toepassing die is geregistreerd in Azure Active Directory en is toegewezen aan een gegevensvlakrol voor het account Purview.
  • client_secret: clientgeheim gemaakt voor de bovenstaande toepassing.
  • grant_type: dit moet 'client_credentials' zijn.
  • resource: dit moet ' https://purview.azure.net ' zijn

Voorbeeld van antwoord-token:

    {
        "token_type": "Bearer",
        "expires_in": "86399",
        "ext_expires_in": "86399",
        "expires_on": "1621038348",
        "not_before": "1620951648",
        "resource": "https://purview.azure.net",
        "access_token": "<<access token>>"
    }

Gebruik het bovenstaande toegangs token om de GEGEVENSvlak-API's aan te roepen.

Volgende stappen