Руководство. Новые функциональные возможности Atlas 2.2
В этом руководстве вы узнаете, как программно взаимодействовать с новыми API Atlas 2.2 с помощью карты данных в Microsoft Purview.
Если у вас нет подписки Azure, создайте бесплатную учетную запись перед началом работы.
У вас должна быть существующая учетная запись Microsoft Purview. Если у вас нет каталога, см. краткое руководство по созданию учетной записи Microsoft Purview.
Сведения о том, как установить токен носителя и вызвать любые API, см. в документации по проверке подлинности API для Microsoft Purview.
Бизнес-метаданные — это шаблон, содержащий настраиваемые атрибуты (значения ключей). Эти атрибуты можно создать глобально, а затем применить их к нескольким типам.
Для всех запросов вам потребуется конечная точка Atlas для учетной записи Microsoft Purview.
- Найдите учетную запись Microsoft Purview в портал Azure
- Выберите страницу Свойства в меню слева
- Копирование значения конечной точки Atlas
Запрос можно отправить POST
в следующую конечную точку:
POST {{endpoint}}/api/atlas/v2/types/typedefs
Совет
Свойство applicableEntityTypes указывает, к каким типам данных будут применены метаданные.
Пример 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\"]"
}
}
]
}
]
}
Запрос можно отправить PUT
в следующую конечную точку:
PUT {{endpoint}}/api/atlas/v2/types/typedefs
Пример 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\"]"
}
}
]
}
]
}
Запрос можно отправить GET
в следующую конечную точку:
GET {endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
Запрос можно отправить POST
в следующую конечную точку:
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
Пример JSON:
{
"myBizMetaData1": {
"bizAttr1": "I am myBizMetaData1.bizAttr1",
"bizAttr2": 123,
}
}
Запрос можно отправить DELETE
в следующую конечную точку:
'DELETE' {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
Пример JSON:
{
"myBizMetaData1": {
"bizAttr1": ""
}
}
Примечание
Удалить определение типа бизнес-метаданных можно только в том случае, если у него нет ссылок, т. е. если оно не было назначено ни одному ресурсу в каталоге.
Запрос можно отправить DELETE
в следующую конечную точку:
DELETE {{endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
Пользовательские атрибуты — это пары "ключ-значение", которые можно напрямую добавить в сущность Atlas.
Запрос можно отправить POST
в следующую конечную точку:
POST {{endpoint}}/api/atlas/v2/entity
Пример 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"
}
}
}
Метки — это бесплатные текстовые теги, которые можно применить к любой сущности Atlas.
Запрос можно отправить POST
в следующую конечную точку:
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
Пример JSON:
[
"label1",
"label2"
]
Запрос можно отправить DELETE
в следующую конечную точку:
DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
Пример JSON:
[
"label2"
]