チュートリアル: Atlas 2.2 の新機能

  • [アーティクル]

このチュートリアルでは、Microsoft Purview のデータ マップを使用して、新しい Atlas 2.2 API とプログラムで対話する方法について説明します。

前提条件

ビジネス メタデータ API

ビジネス メタデータは、カスタム属性 (キー値) を含むテンプレートです。 これらの属性はグローバルに作成し、複数の typedef に適用できます。

Atlas エンドポイント

すべての要求に対して、Microsoft Purview アカウントの Atlas エンドポイントが必要です。

  1. Azure portalで Microsoft Purview アカウントを見つける
  2. 左側のメニューの [プロパティ ] ページを選択します
  3. Atlas エンドポイント値をコピーする

[Atlas エンドポイント] ボックスが強調表示されている Microsoft Purview のプロパティ ページのスクリーンショット。

属性を使用してビジネス メタデータを作成する

次の 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}}

カスタム属性 API

カスタム属性は、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"
        }
    }
}

ラベル API

ラベルは、任意の 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"
]

次の手順

データ ソースの管理Microsoft Purview データ プレーン REST API