チュートリアル: Atlas 2.2 の新機能
このチュートリアルでは、Microsoft Purview のデータ マップを使用して、新しい Atlas 2.2 API とプログラムで対話する方法について説明します。
Azure サブスクリプションをお持ちでない場合は、開始 する前に無料アカウントを作成 してください。
既存の Microsoft Purview アカウントが必要です。 カタログがない場合は、 Microsoft Purview アカウントを作成するためのクイック スタートを参照してください。
ベアラー トークンを確立し、すべての API を呼び出すには、 Microsoft Purview の API を認証する方法に関するドキュメントを参照してください。
ビジネス メタデータは、カスタム属性 (キー値) を含むテンプレートです。 これらの属性はグローバルに作成し、複数の typedef に適用できます。
すべての要求に対して、Microsoft Purview アカウントの Atlas エンドポイントが必要です。
- Azure portalで Microsoft Purview アカウントを見つける
- 左側のメニューの [プロパティ ] ページを選択します
- 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"
]