Entity - Add Classifications By Unique Attribute

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

型と一意の属性によって識別されるエンティティに分類を追加します。

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications

省略可能なパラメーターを含む:

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications?attr:qualifiedName={attr:qualifiedName}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
typeName	path	True	string	型の名前。
attr:qualifiedName	query		string	エンティティの修飾名。 (これはほんの一例です。qualifiedName は他の一意の属性に変更できます)

要求本文

名前	型	説明
body	AtlasClassification[]	追加する分類の配列。

応答

名前	型	説明
204 No Content		この要求に送信するコンテンツはありませんが、ヘッダーが役に立つ場合があります。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://purview.azure.net/.default

例

Entity_AddClassificationsByUniqueAttribute

要求のサンプル

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account/classifications?attr:qualifiedName=https://exampleaccount.core.windows.net

[
  {
    "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"
  },
  {
    "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER"
  }
]

応答のサンプル

状態コード:: 204

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasErrorResponse	サービスからのエラー応答
EntityStatus	状態 - アクティブまたは削除可能
TimeBoundary	時間境界の詳細をキャプチャします

AtlasClassification

分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。

名前	型	説明
attributes		構造体の属性。
entityGuid	string	エンティティの GUID。
entityStatus	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
lastModifiedTS	string	コンカレンシー制御の ETag。
removePropagationsOnEntityDelete	boolean	エンティティの削除時に伝達を削除するかどうかを決定します。
typeName	string	型の名前。
validityPeriods	TimeBoundary[]	有効期間を示す時間境界の配列。

AtlasErrorResponse

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string	要求 ID です。

EntityStatus

状態 - アクティブまたは削除可能

名前	型	説明
ACTIVE	string	状態がアクティブです。
DELETED	string	状態が削除されます。

TimeBoundary

時間境界の詳細をキャプチャします

名前	型	説明
endTime	string	時間境界の終わり。
startTime	string	時間境界の開始。
timeZone	string	時間境界のタイムゾーン。

次の方法で共有