Créer des ressources à l’aide de l’API REST

Importante

Retrait des fonctionnalités de gouvernance des données Microsoft Purview uniquement

Le catalogue unifié Microsoft Purview et les fonctionnalités classiques de gouvernance des données Microsoft Purview (anciennement Azure Purview) sont mis hors service. Microsoft Purview dans son ensemble n’est pas mis hors service. Les fonctionnalités de sécurité et de conformité des données de Microsoft Purview ne sont pas affectées par cette annonce et Microsoft continuera d’investir dans ces domaines.

Microsoft consolide ses fonctionnalités de gouvernance des données dans Microsoft Fabric. Les nouveaux comptes de gouvernance des données Microsoft Purview ne peuvent plus être créés, et les fonctionnalités de gouvernance des données existantes resteront en mode maintenance jusqu’au 12 novembre 2027.

Pour connaître les délais de mise hors service, les conseils de transition et les prochaines étapes recommandées, consultez l’annonce de mise hors service de la gouvernance des données Microsoft Purview.

Dans ce tutoriel, vous apprendrez à créer des ressources dans Microsoft Purview Data Map que les utilisateurs peuvent rechercher et parcourir dans le catalogue unifié Microsoft Purview.

Remarque

Si vous utilisez la version gratuite de Microsoft Purview, seuls les utilisateurs du groupe de rôles Conservateur de données pourront accéder à ces ressources.

Si vous disposez déjà de votre principal de service et de votre jeton d’authentification, vous pouvez passer directement aux étapes de création de ressources à l’aide de l’API REST. Dans le cas contraire, suivez ce guide pour appeler l’API REST.

Configuration requise

Créer un principal du service (application)

Pour qu’un client d’API REST accède à Microsoft Purview pour créer des entités, le client doit avoir un principal de service (application) et une identité que Microsoft Purview reconnaît et est configurée pour approuver.

Les clients qui ont utilisé des principaux de service existants (ID d’application) ont connu un taux d’échec élevé. Par conséquent, nous vous recommandons de créer un principal de service pour appeler des API.

Pour créer un nouveau principal de service :

  1. Connectez-vous au Portail Azure.

  2. Dans le portail, recherchez et sélectionnez Microsoft Entra ID.

  3. Dans la page Microsoft Entra ID , sélectionnez Inscriptions d’applications dans le volet gauche.

  4. Sélectionnez Nouvelle inscription.

  5. Sur la page Inscrire une application :

    1. Entrez un nom pour l’application (le nom de principal du service).
    2. Sélectionnez Comptes dans cet annuaire organisationnel uniquement (<nom> de votre client uniquement - Locataire unique).
    3. Pour URI de redirection (facultatif), sélectionnez Web et entrez une valeur. Cette valeur n’a pas besoin d’être un point de terminaison valide. https://exampleURI.com fera l’affaire.
    4. Sélectionner Inscription.
  6. Sur la page du nouveau principal de service, copiez les valeurs du nom d’affichage et de l’ID de l’application (client) pour les enregistrer pour plus tard.

    L’ID d’application est la client_id valeur de l’exemple de code.

Pour utiliser le principal du service (application), vous devez connaître le mot de passe du principal de service :

  1. Sélectionnez votre principal de service (application) dans la liste Inscriptions d’applications .
  2. Sélectionnez Certificats & secrets dans le volet gauche.
  3. Sélectionnez Nouvelle clé secrète client.
  4. Sur la page Ajouter une clé secrète client , entrez une description, sélectionnez une heure d’expiration sous Expirations, puis sélectionnez Ajouter.
  5. Dans la page Clés secrètes client , la chaîne dans la colonne Valeur de votre nouvelle clé secrète correspond à votre mot de passe. Enregistrez cette valeur.

Configurer l’authentification avec un principal de service

Une fois le nouveau principal de service créé, vous devez attribuer des autorisations afin qu’il puisse accéder à votre compte Microsoft Purview. Les autorisations que vous devez attribuer varient selon que vous utilisez l’expérience Microsoft Purview classique ou le nouveau portail Microsoft Purview.

Sélectionnez l’onglet correspondant à l’expérience que vous utilisez.

  1. Accédez à votre portail de gouvernance Microsoft Purview.

  2. Sélectionnez le Data Map dans le menu de gauche.

  3. Sélectionnez Collections.

  4. Sélectionnez la collection racine dans le menu collections. Il s’agit de la collection la plus importante de la liste, qui aura le même nom que votre compte Microsoft Purview.

    Remarque

    Vous pouvez également attribuer votre autorisation de principal de service à n’importe quelle sous-collection, au lieu de la collection racine. Toutefois, toutes les API sont limitées à cette collection (et aux sous-collections qui héritent des autorisations) et les utilisateurs qui tentent d’appeler l’API pour une autre collection reçoivent des erreurs.

  5. Sélectionnez l’onglet Attributions de rôles .

  6. Affectez le rôle de sélectionneur de données au principal de service créé précédemment. Pour obtenir des étapes détaillées, consultez Attribuer des rôles Azure à l’aide du portail de gouvernance Microsoft Purview.

Une fois que vous avez attribué des autorisations, vous devez collecter votre jeton d’authentification.

  1. Envoyez une demande POST à l’URL suivante pour obtenir un jeton d’accès :

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

    Vous pouvez trouver votre ID de locataire en recherchant Propriétés du locataire dans le portail Azure. L’ID est disponible sur la page des propriétés du locataire.

    Les paramètres suivants doivent être transmis à l’URL ci-dessus :

    • client_id : ID client de l’application inscrite dans Microsoft Entra ID et affectée à un rôle de plan de données pour le compte Microsoft Purview.
    • client_secret : clé secrète client créée pour l’application ci-dessus.
    • grant_type : Ce devrait être « client_credentials ».
    • resource : This should be 'https://purview.azure.net'

    Voici un exemple de requête POST dans PowerShell :

    $tenantID = "12a345bc-67d1-ef89-abcd-efg12345abcde"
    
    $url = "https://login.microsoftonline.com/$tenantID/oauth2/token"
    $params = @{ client_id = "00001111-aaaa-2222-bbbb-3333cccc4444"; client_secret = "abcd~a1234bcd56789012abcdabcd1234abcd"; grant_type = "client_credentials"; resource = ‘https://purview.azure.net’ }
    
    Invoke-WebRequest $url -Method Post -Body $params      -UseBasicParsing | ConvertFrom-Json
    

    Exemple de jeton de réponse :

    {
        "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>>"
    }
    

    Conseil

    Si vous obtenez un message d’erreur indiquant : L’échange de jetons cross-origin est autorisé uniquement pour le type de client « Application monopage ».

    • Vérifiez vos en-têtes de requête et confirmez que votre requête ne contient pas l’en-tête « origin ».
    • Vérifiez que votre URI de redirection est défini sur web dans votre principal de service.
    • Assurez-vous que votre logiciel est à jour pour l’application que vous utilisez pour envoyer votre demande POST.
  2. Utilisez le jeton d’accès ci-dessus pour appeler les API du plan de données.

Créer des ressources à l’aide de l’API REST

Maintenant que vous disposez d’un jeton et que vous pouvez vous authentifier, vous êtes prêt à créer vos ressources.

Importante

Vos points de terminaison d’URL de demande dépendent de l’expérience Microsoft Purview que vous utilisez : l’expérience Microsoft Purview classique ou le nouveau portail Microsoft Purview

Créer des ressources Azure

Voici un exemple que vous pouvez utiliser pour créer vos entités pour les ressources Azure. Cet exemple couvre un compte de stockage Azure, mais vous pouvez l’utiliser pour toute autre source Azure.

Importante

Pour utiliser cet exemple pour vos ressources Azure, remplacez les valeurs suivantes dans la charge utile :

  • typeName
  • Propriétaire
  • qualifiedName
  • nom
  • Expert ID
  • Informations d’expert
  • ID du propriétaire
  • Informations sur le propriétaire
  • Créé par
  • Mise à jour par

URL de la requête : https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity

Method : PUBLIER

Authentification : Utilisez le jeton de l’étape précédente comme jeton de porteur.

Exemple de charge utile :

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": " 30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Créer des ressources multicloud

Voici un exemple que vous pouvez utiliser pour créer vos entités pour les ressources multicloud. Cet exemple crée une ressource Snowflake, mais vous pouvez l’utiliser pour n’importe quelle autre source

Importante

Pour utiliser cet exemple pour vos ressources Azure, remplacez les valeurs suivantes dans la charge utile :

  • typeName
  • Propriétaire
  • qualifiedName
  • nom
  • type
  • Expert ID
  • Informations d’expert
  • ID du propriétaire
  • Informations sur le propriétaire
  • Créé par
  • Mise à jour par

URL de la requête : https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity

Method : PUBLIER

Authentification : Utilisez le jeton de l’étape précédente comme jeton de porteur.

Exemple de charge utile :

{
  "referredEntities": {},
  "entity": {
    "typeName": "snowflake_table",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "snowflake://microsoft_partner.east-us-2.azure.snowflakecomputing.com/databases/AZUREPURVIEW_TESTDB/schemas/COMPANY/tables/PROJECT_INFO",
      "name": "PROJECT_INFO",
      "description": null,
      "type": "TABLE"
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "4b27e65f-6a15-4925-a4ef-2e640445079b",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Étapes suivantes