Tutoriel : Nouvelles fonctionnalités d’Atlas 2.2
Dans ce tutoriel, découvrez comment interagir par programmation avec les nouvelles API Atlas 2.2 avec la carte de données dans Microsoft Purview.
Si vous n’avez pas d’abonnement Azure, créez un compte gratuit avant de commencer.
Vous devez disposer d’un compte Microsoft Purview existant. Si vous n’avez pas de catalogue, consultez le guide de démarrage rapide pour créer un compte Microsoft Purview.
Pour établir un jeton du porteur et appeler des API, consultez la documentation sur l’authentification des API pour Microsoft Purview.
Les métadonnées métier sont un modèle qui contient des attributs personnalisés (valeurs de clé). Vous pouvez créer ces attributs globalement, puis les appliquer à plusieurs types typedefs.
Pour toutes les demandes, vous aurez besoin du point de terminaison Atlas pour votre compte Microsoft Purview.
- Recherchez votre compte Microsoft Purview dans le Portail Azure
- Sélectionnez la page Propriétés dans le menu de gauche.
- Copier la valeur du point de terminaison Atlas
Vous pouvez envoyer une POST
requête au point de terminaison suivant :
POST {{endpoint}}/api/atlas/v2/types/typedefs
Conseil
La propriété applicableEntityTypes indique les types de données auxquels les métadonnées seront appliquées.
Exemple JSON :
{
"businessMetadataDefs": [
{
"category": "BUSINESS_METADATA",
"createdBy": "admin",
"updatedBy": "admin",
"version": 1,
"typeVersion": "1.1",
"name": "<Name of Business Metadata>",
"description": "",
"attributeDefs": [
{
"name": "<Attribute Name>",
"typeName": "string",
"isOptional": true,
"cardinality": "SINGLE",
"isUnique": false,
"isIndexable": true,
"options": {
"maxStrLength": "50",
"applicableEntityTypes": "[\"Referenceable\"]"
}
}
]
}
]
}
Vous pouvez envoyer une PUT
requête au point de terminaison suivant :
PUT {{endpoint}}/api/atlas/v2/types/typedefs
Exemple JSON :
{
"businessMetadataDefs": [
{
"category": "BUSINESS_METADATA",
"createdBy": "admin",
"updatedBy": "admin",
"version": 1,
"typeVersion": "1.1",
"name": "<Name of Business Metadata>",
"description": "",
"attributeDefs": [
{
"name": "<Attribute Name>",
"typeName": "string",
"isOptional": true,
"cardinality": "SINGLE",
"isUnique": false,
"isIndexable": true,
"options": {
"maxStrLength": "500",
"applicableEntityTypes": "[\"Referenceable\"]"
}
},
{
"name": "<Attribute Name 2>",
"typeName": "int",
"isOptional": true,
"cardinality": "SINGLE",
"isUnique": false,
"isIndexable": true,
"options": {
"applicableEntityTypes": "[\"Referenceable\"]"
}
}
]
}
]
}
Vous pouvez envoyer une GET
requête au point de terminaison suivant :
GET {endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
Vous pouvez envoyer une POST
requête au point de terminaison suivant :
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
Exemple JSON :
{
"myBizMetaData1": {
"bizAttr1": "I am myBizMetaData1.bizAttr1",
"bizAttr2": 123,
}
}
Vous pouvez envoyer une DELETE
requête au point de terminaison suivant :
'DELETE' {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
Exemple JSON :
{
"myBizMetaData1": {
"bizAttr1": ""
}
}
Notes
Vous pouvez supprimer la définition de type de métadonnées métier uniquement si elle n’a pas de références, c’est-à-dire si elle n’a pas été affectée à des ressources dans le catalogue.
Vous pouvez envoyer une DELETE
requête au point de terminaison suivant :
DELETE {{endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
Les attributs personnalisés sont des paires clé/valeur qui peuvent être ajoutées directement à une entité Atlas.
Vous pouvez envoyer une POST
requête au point de terminaison suivant :
POST {{endpoint}}/api/atlas/v2/entity
Exemple JSON :
{
"entity": {
"typeName": "azure_datalake_gen2_path",
"attributes": {
"qualifiedName": "<FQN of the asset>",
"name": "data6.csv"
},
"guid": "3ffb28ff-138f-419e-84ba-348b0165e9e0",
"customAttributes": {
"custAttr1": "attr1",
"custAttr2": "attr2"
}
}
}
Les étiquettes sont des balises de texte libre qui peuvent être appliquées à n’importe quelle entité Atlas.
Vous pouvez envoyer une POST
requête au point de terminaison suivant :
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
Exemple JSON :
[
"label1",
"label2"
]
Vous pouvez envoyer une DELETE
requête au point de terminaison suivant :
DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
Exemple JSON :
[
"label2"
]
Gérer les APIREST du plan de données Microsoft Purview des sources de données