你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Entity - Create Or Update

参考

Service:: Purview

API Version:: 2023-09-01

创建或更新实体。现有实体使用其唯一 guid（如果提供）或其唯一属性（例如：qualifiedName）进行匹配。不支持集合的映射和数组。例如，数组<数组>、数组<映射<字符串、int>>。对于每种触点类型，最大触点数为 20。

POST {endpoint}/datamap/api/atlas/v2/entity

With optional parameters:

POST {endpoint}/datamap/api/atlas/v2/entity?api-version=2023-09-01&businessAttributeUpdateBehavior={businessAttributeUpdateBehavior}&collectionId={collectionId}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string
api-version	query		string	要用于此操作的 API 版本。
businessAttributeUpdateBehavior	query		BusinessAttributeUpdateBehavior	用于在更新实体时定义业务属性的更新行为。
collectionId	query		string	实体将移动到的集合。仅当需要将实体移动到另一个集合时，才指定值。

请求正文

名称	类型	说明
entity	AtlasEntity	实体的实例 - 如 hive_table、hive_database。
referredEntities	<string, AtlasEntity>	引用的实体。

响应

名称	类型	说明
200 OK	EntityMutationResult	请求已成功。
Other Status Codes	AtlasErrorResponse	意外的错误响应。

安全性

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
https://purview.azure.net/.default

示例

Entity_AddCustomAttribute

Entity_Create

Entity_CreateOrUpdateWithRichText

Entity_Update

Entity_AddCustomAttribute

Sample Request

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity?api-version=2023-09-01

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "customAttributes": {
      "custAttr1": "attr1",
      "custAttr2": "attr2"
    }
  }
}

Sample Response

Status code:: 200

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "owner": "ExampleOwner",
          "createTime": 0,
          "qualifiedName": "https://exampleaccount.core.windows.net",
          "name": "ExampleStorageAccount"
        },
        "lastModifiedTS": "1",
        "guid": "c696b935-2c76-4208-bc0d-8864553a67f1",
        "displayText": "ExampleStorageAccount",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": []
      }
    ]
  },
  "guidAssignments": {
    "-16806536444330": "c696b935-2c76-4208-bc0d-8864553a67f1"
  }
}

Entity_Create

Sample Request

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity?api-version=2023-09-01

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Sample Response

Status code:: 200

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "lastModifiedTS": "1",
        "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6"
  }
}

Entity_CreateOrUpdateWithRichText

Sample Request

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity?api-version=2023-09-01

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "userDescription": "<div><b>testing</b></div>",
      "publicAccessLevel": null
    },
    "customAttributes": {
      "microsoft_isDescriptionRichText": "true"
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Sample Response

Status code:: 200

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "lastModifiedTS": "1",
        "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6"
  }
}

Entity_Update

Sample Request

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity?api-version=2023-09-01

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "exampleaccount",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Sample Response

Status code:: 200

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount"
        },
        "lastModifiedTS": "2",
        "guid": "029d5668-a36c-40a9-bc11-6f352bafdc3b"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018167": "029d5668-a36c-40a9-bc11-6f352bafdc3b"
  }
}

定义

名称	说明
AtlasClassification	分类的实例;它没有标识，此对象仅在与实体关联时才存在。
AtlasEntity	实体的实例 - 如 hive_table、hive_database。
AtlasEntityHeader	实体的实例 - 如 hive_table、hive_database。
AtlasEntityWithExtInfo	实体的实例以及扩展信息（如 hive_table、hive_database）。
AtlasErrorResponse	来自服务的错误响应
AtlasTermAssignmentHeader	术语分配的标头。
AtlasTermAssignmentStatus	术语分配的状态
BusinessAttributeUpdateBehavior	用于在更新实体时定义业务属性的更新行为。
EntityMutationResult	实体的突变响应结果。
EntityStatus	状态 - 可以是活动状态，也可以已删除
TimeBoundary	捕获时间边界详细信息

AtlasClassification

分类的实例;它没有标识，此对象仅在与实体关联时才存在。

名称	类型	说明
attributes		结构的属性。
entityGuid	string	实体的 GUID。
entityStatus	EntityStatus	实体的状态 - 可以是活动状态，也可以是已删除的。不会删除已删除的实体。
lastModifiedTS	string	用于并发控制的 ETag。
removePropagationsOnEntityDelete	boolean	确定是否在删除实体时删除传播。
typeName	string	类型的名称。
validityPeriods	TimeBoundary[]	指示有效期的时间边界数组。

AtlasEntity

实体的实例 - 如 hive_table、hive_database。

名称	类型	说明
attributes		结构的属性。
businessAttributes		业务属性
classifications	AtlasClassification[]	分类数组。
collectionId	string	实体的集合 ID。
contacts	object	实体的联系人字典。密钥可以是“专家”或“所有者”。
createTime	integer	记录的创建时间。
createdBy	string	创建记录的用户。
customAttributes	object	自定义属性
guid	string	实体的 GUID。
homeId	string	实体的主 ID。
isIncomplete	boolean	它是否为 shell 实体
labels	string[]	标签
lastModifiedTS	string	用于并发控制的 ETag。
meanings	AtlasTermAssignmentHeader[]	表示实体含义的术语赋值标头数组。
provenanceType	integer	用于记录实体或关系的实例的出处。
proxy	boolean	确定是否有代理。
relationshipAttributes		关系的属性。
status	EntityStatus	实体的状态 - 可以是活动状态，也可以是已删除的。不会删除已删除的实体。
typeName	string	类型的名称。
updateTime	integer	记录的更新时间。
updatedBy	string	更新记录的用户。
version	integer	实体的版本。

AtlasEntityHeader

实体的实例 - 如 hive_table、hive_database。

名称	类型	说明
attributes		结构的属性。
classificationNames	string[]	分类名称数组。
classifications	AtlasClassification[]	分类数组。
displayText	string	显示文本。
guid	string	记录的 GUID。
isIncomplete	boolean	它是否为 shell 实体
labels	string[]	标签
lastModifiedTS	string	用于并发控制的 ETag。
meaningNames	string[]	含义数组。
meanings	AtlasTermAssignmentHeader[]	术语赋值标头的数组。
status	EntityStatus	实体的状态 - 可以是活动状态，也可以是已删除的。不会删除已删除的实体。
typeName	string	类型的名称。

AtlasEntityWithExtInfo

实体的实例以及扩展信息（如 hive_table、hive_database）。

名称	类型	说明
entity	AtlasEntity	实体的实例 - 如 hive_table、hive_database。
referredEntities	<string, AtlasEntity>	引用的实体。

AtlasErrorResponse

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string	请求 ID。

AtlasTermAssignmentHeader

术语分配的标头。

名称	类型	说明
confidence	integer	术语赋值的置信度。
createdBy	string	创建记录的用户。
description	string	术语赋值的说明。
displayText	string	显示文本。
expression	string	术语赋值的表达式。
relationGuid	string	关系的 GUID。
status	AtlasTermAssignmentStatus	术语分配的状态。
steward	string	术语的管理员。
termGuid	string	术语的 GUID。

AtlasTermAssignmentStatus

术语分配的状态

名称	类型	说明
DEPRECATED	string	状态已弃用。
DISCOVERED	string	已发现状态。
IMPORTED	string	状态已导入。
OBSOLETE	string	状态已过时。
OTHER	string	其他状态。
PROPOSED	string	建议状态。
VALIDATED	string	状态已验证。

BusinessAttributeUpdateBehavior

用于在更新实体时定义业务属性的更新行为。

名称	类型	说明
ignore	string	忽略更新的业务属性有效负载。
merge	string	合并业务属性。如果未提供业务属性，则不会更新。
replace	string	使用有效负载替换所有业务属性。

EntityMutationResult

实体的突变响应结果。

名称	类型	说明
guidAssignments	object	包含实体的 GUID 分配的映射。
mutatedEntities	object	可变实体的实体标头。
partialUpdatedEntities	AtlasEntityHeader[]	部分更新的实体标头数组。

EntityStatus

状态 - 可以是活动状态，也可以已删除

名称	类型	说明
ACTIVE	string	状态为活动状态。
DELETED	string	状态已删除。

TimeBoundary

捕获时间边界详细信息

名称	类型	说明
endTime	string	时间边界的结束时间。
startTime	string	时间边界的开始。
timeZone	string	时间边界的时区。

Entity - Create Or Update

URI 参数

请求正文

响应

安全性

OAuth2Auth

Scopes

示例

Entity_AddCustomAttribute

Sample Request

Sample Response

Entity_Create

Sample Request

Sample Response

Entity_CreateOrUpdateWithRichText

Sample Request

Sample Response

Entity_Update

Sample Request

Sample Response

定义

AtlasClassification

AtlasEntity

AtlasEntityHeader

AtlasEntityWithExtInfo

AtlasErrorResponse

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

BusinessAttributeUpdateBehavior

EntityMutationResult

EntityStatus

TimeBoundary

其他资源