entity

Creates, updates, deletes, gets or lists an entity resource.

Overview

Name	entity
Type	Resource
Id	azure.purview_data_map.entity

Fields

The following fields are returned by SELECT queries:

get_classification

Name	Datatype	Description
attributes	object	The attributes of the struct.
entityGuid	string	The GUID of the entity.
entityStatus	string	Status of the entity - can be active or deleted. Deleted entities are not removed. Known values are: "ACTIVE" and "DELETED". (ACTIVE, DELETED)
lastModifiedTS	string	ETag for concurrency control.
removePropagationsOnEntityDelete	boolean	Determines if propagations will be removed on entity deletion.
typeName	string	The name of the type.
validityPeriods	array	An array of time boundaries indicating validity periods.

get

Name	Datatype	Description
entity	object	An instance of an entity - like hive_table, hive_database.
referredEntities	object	The referred entities.

get_by_unique_attribute

Name	Datatype	Description
entity	object	An instance of an entity - like hive_table, hive_database.
referredEntities	object	The referred entities.

get_by_ids

Name	Datatype	Description
entities	array	An array of entities.
referredEntities	object	The referred entities.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_classification	select	guid, classification_name, endpoint		Get classification for a given entity represented by a GUID.
get	select	guid, endpoint	minExtInfo, ignoreRelationships	Get complete definition of an entity given its GUID.
get_by_unique_attribute	select	type_name, endpoint	minExtInfo, ignoreRelationships, attr:qualifiedName	Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
get_by_ids	select	endpoint	minExtInfo, ignoreRelationships	List entities in bulk identified by its GUIDs.
create_or_update	insert	endpoint	businessAttributeUpdateBehavior, collectionId	Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
update_by_unique_attribute	update	type_name, endpoint	attr:qualifiedName	Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
create_or_update	replace	endpoint	businessAttributeUpdateBehavior, collectionId	Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
remove_classification	delete	guid, classification_name, endpoint		Delete a given classification from an existing entity represented by a GUID.
remove_classification_by_unique_attribute	delete	type_name, classification_name, endpoint	attr:qualifiedName	Delete a given classification from an entity identified by its type and unique attributes.
remove_business_metadata_attributes	delete	business_metadata_name, guid, endpoint		Delete business metadata attributes from an entity.
delete	delete	guid, endpoint		Delete an entity identified by its GUID.
delete_by_unique_attribute	delete	type_name, endpoint	attr:qualifiedName	Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
batch_delete	delete	endpoint		Delete a list of entities in bulk identified by their GUIDs or unique attributes.
update_attribute_by_id	exec	guid, name, endpoint		Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.
batch_create_or_update	exec	endpoint	collectionId, businessAttributeUpdateBehavior	Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
get_classifications	exec	guid, endpoint		List classifications for a given entity represented by a GUID.
add_classifications	exec	guid, endpoint		Add classifications to an existing entity represented by a GUID.
update_classifications	exec	guid, endpoint		Update classifications to an existing entity represented by a guid.
get_header	exec	guid, endpoint		Get entity header given its GUID.
get_business_metadata_template	exec	endpoint		Get the sample Template for uploading/creating bulk BusinessMetaData.
add_classification	exec	endpoint		Associate a classification to multiple entities in bulk.
add_classifications_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Add classification to the entity identified by its type and unique attributes.
update_classifications_unique_by_attribute	exec	type_name, endpoint	attr:qualifiedName	Update classification on an entity identified by its type and unique attributes.
batch_set_classifications	exec	endpoint		Set classifications on entities in bulk.
batch_get_by_unique_attributes	exec	type_name, endpoint	minExtInfo, ignoreRelationships, attr_N:qualifiedName	Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=&attr_1:=&attr_2:=&attr_3:=\ NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.
remove_business_metadata	exec	guid, endpoint		Remove business metadata from an entity.
add_or_update_business_metadata	exec	guid, endpoint	isOverwrite	Add business metadata to an entity.
add_or_update_business_metadata_attributes	exec	business_metadata_name, guid, endpoint		Add or update business metadata attributes.
import_business_metadata	exec	endpoint, file		Upload the file for creating Business Metadata in BULK.
remove_labels	exec	guid, endpoint		Delete given labels to a given entity.
set_labels	exec	guid, endpoint		Set labels to a given entity.
add_label	exec	guid, endpoint		Add given labels to a given entity.
remove_labels_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
set_labels_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
add_labels_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
move_entities_to_collection	exec	collectionId, endpoint		Move existing entities to the target collection.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
business_metadata_name	string	BusinessMetadata name. Required.
classification_name	string	The name of the classification. Required.
collectionId	string	The collection where entities will be moved to. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
guid	string	The globally unique identifier of the entity. Required.
name	string	The name of the attribute. Required.
type_name	string	The name of the type. Required.
attr:qualifiedName	string	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes). Default value is None.
attr_N:qualifiedName	string	Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes). Default value is None.
businessAttributeUpdateBehavior	string	Used to define the update behavior for business attributes when updating entities. Known values are: "ignore", "replace", and "merge". Default value is None.
collectionId	string	The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. Default value is None.
ignoreRelationships	boolean	Whether to ignore relationship attributes. Default value is None.
isOverwrite	boolean	Whether to overwrite the existing business metadata on the entity or not, default is false. Default value is None.
minExtInfo	boolean	Whether to return minimal information for referred entities. Default value is None.

SELECT examples

get_classification

Get classification for a given entity represented by a GUID.

SELECT
attributes,
entityGuid,
entityStatus,
lastModifiedTS,
removePropagationsOnEntityDelete,
typeName,
validityPeriods
FROM azure.purview_data_map.entity
WHERE guid = '{{ guid }}' -- required
AND classification_name = '{{ classification_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Get complete definition of an entity given its GUID.

SELECT
entity,
referredEntities
FROM azure.purview_data_map.entity
WHERE guid = '{{ guid }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND minExtInfo = '{{ minExtInfo }}'
AND ignoreRelationships = '{{ ignoreRelationships }}'
;

get_by_unique_attribute

Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

SELECT
entity,
referredEntities
FROM azure.purview_data_map.entity
WHERE type_name = '{{ type_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND minExtInfo = '{{ minExtInfo }}'
AND ignoreRelationships = '{{ ignoreRelationships }}'
AND attr:qualifiedName = '{{ attr:qualifiedName }}'
;

get_by_ids

List entities in bulk identified by its GUIDs.

SELECT
entities,
referredEntities
FROM azure.purview_data_map.entity
WHERE endpoint = '{{ endpoint }}' -- required
AND minExtInfo = '{{ minExtInfo }}'
AND ignoreRelationships = '{{ ignoreRelationships }}'
;

INSERT examples

create_or_update

Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.

INSERT INTO azure.purview_data_map.entity (
referredEntities,
entity,
endpoint,
businessAttributeUpdateBehavior,
collectionId
)
SELECT 
'{{ referredEntities }}',
'{{ entity }}',
'{{ endpoint }}',
'{{ businessAttributeUpdateBehavior }}',
'{{ collectionId }}'
RETURNING
guidAssignments,
mutatedEntities,
partialUpdatedEntities
;

Manifest

# Description fields are for documentation purposes
- name: entity
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the entity resource.
  - name: referredEntities
    value: "{{ referredEntities }}"
    description: |
      The referred entities.
  - name: entity
    description: |
      An instance of an entity - like hive_table, hive_database.
    value:
      attributes: "{{ attributes }}"
      typeName: "{{ typeName }}"
      lastModifiedTS: "{{ lastModifiedTS }}"
      businessAttributes: "{{ businessAttributes }}"
      classifications:
        - attributes: "{{ attributes }}"
          typeName: "{{ typeName }}"
          lastModifiedTS: "{{ lastModifiedTS }}"
          entityGuid: "{{ entityGuid }}"
          entityStatus: "{{ entityStatus }}"
          removePropagationsOnEntityDelete: {{ removePropagationsOnEntityDelete }}
          validityPeriods: "{{ validityPeriods }}"
      createTime: {{ createTime }}
      createdBy: "{{ createdBy }}"
      customAttributes: "{{ customAttributes }}"
      guid: "{{ guid }}"
      homeId: "{{ homeId }}"
      collectionId: "{{ collectionId }}"
      isIncomplete: {{ isIncomplete }}
      labels:
        - "{{ labels }}"
      meanings:
        - confidence: {{ confidence }}
          createdBy: "{{ createdBy }}"
          description: "{{ description }}"
          displayText: "{{ displayText }}"
          expression: "{{ expression }}"
          relationGuid: "{{ relationGuid }}"
          status: "{{ status }}"
          steward: "{{ steward }}"
          termGuid: "{{ termGuid }}"
      provenanceType: {{ provenanceType }}
      proxy: {{ proxy }}
      relationshipAttributes: "{{ relationshipAttributes }}"
      status: "{{ status }}"
      updateTime: {{ updateTime }}
      updatedBy: "{{ updatedBy }}"
      version: {{ version }}
      contacts: "{{ contacts }}"
  - name: businessAttributeUpdateBehavior
    value: "{{ businessAttributeUpdateBehavior }}"
    description: Used to define the update behavior for business attributes when updating entities. Known values are: "ignore", "replace", and "merge". Default value is None.
    description: Used to define the update behavior for business attributes when updating entities. Known values are: "ignore", "replace", and "merge". Default value is None.
  - name: collectionId
    value: "{{ collectionId }}"
    description: The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. Default value is None.
    description: The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. Default value is None.

UPDATE examples

update_by_unique_attribute

Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

UPDATE azure.purview_data_map.entity
SET 
referredEntities = '{{ referredEntities }}',
entity = '{{ entity }}'
WHERE 
type_name = '{{ type_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND attr:qualifiedName = '{{ attr:qualifiedName}}'
RETURNING
guidAssignments,
mutatedEntities,
partialUpdatedEntities;

REPLACE examples

create_or_update

Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.

REPLACE azure.purview_data_map.entity
SET 
referredEntities = '{{ referredEntities }}',
entity = '{{ entity }}'
WHERE 
endpoint = '{{ endpoint }}' --required
AND businessAttributeUpdateBehavior = '{{ businessAttributeUpdateBehavior}}'
AND collectionId = '{{ collectionId}}'
RETURNING
guidAssignments,
mutatedEntities,
partialUpdatedEntities;

DELETE examples

remove_classification

Delete a given classification from an existing entity represented by a GUID.

DELETE FROM azure.purview_data_map.entity
WHERE guid = '{{ guid }}' --required
AND classification_name = '{{ classification_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

remove_classification_by_unique_attribute

Delete a given classification from an entity identified by its type and unique attributes.

DELETE FROM azure.purview_data_map.entity
WHERE type_name = '{{ type_name }}' --required
AND classification_name = '{{ classification_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND attr:qualifiedName = '{{ attr:qualifiedName }}'
;

remove_business_metadata_attributes

Delete business metadata attributes from an entity.

DELETE FROM azure.purview_data_map.entity
WHERE business_metadata_name = '{{ business_metadata_name }}' --required
AND guid = '{{ guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

delete

Delete an entity identified by its GUID.

DELETE FROM azure.purview_data_map.entity
WHERE guid = '{{ guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

delete_by_unique_attribute

Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

DELETE FROM azure.purview_data_map.entity
WHERE type_name = '{{ type_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND attr:qualifiedName = '{{ attr:qualifiedName }}'
;

batch_delete

Delete a list of entities in bulk identified by their GUIDs or unique attributes.

DELETE FROM azure.purview_data_map.entity
WHERE endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

update_attribute_by_id

Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.

EXEC azure.purview_data_map.entity.update_attribute_by_id 
@guid='{{ guid }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

batch_create_or_update

Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.

EXEC azure.purview_data_map.entity.batch_create_or_update 
@endpoint='{{ endpoint }}' --required, 
@collectionId='{{ collectionId }}', 
@businessAttributeUpdateBehavior='{{ businessAttributeUpdateBehavior }}' 
@@json=
'{
"referredEntities": "{{ referredEntities }}", 
"entities": "{{ entities }}"
}'
;

get_classifications

List classifications for a given entity represented by a GUID.

EXEC azure.purview_data_map.entity.get_classifications 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

add_classifications

Add classifications to an existing entity represented by a GUID.

EXEC azure.purview_data_map.entity.add_classifications 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"attributes": "{{ attributes }}", 
"typeName": "{{ typeName }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"entityGuid": "{{ entityGuid }}", 
"entityStatus": "{{ entityStatus }}", 
"removePropagationsOnEntityDelete": {{ removePropagationsOnEntityDelete }}, 
"validityPeriods": "{{ validityPeriods }}"
}'
;

update_classifications

Update classifications to an existing entity represented by a guid.

EXEC azure.purview_data_map.entity.update_classifications 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"attributes": "{{ attributes }}", 
"typeName": "{{ typeName }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"entityGuid": "{{ entityGuid }}", 
"entityStatus": "{{ entityStatus }}", 
"removePropagationsOnEntityDelete": {{ removePropagationsOnEntityDelete }}, 
"validityPeriods": "{{ validityPeriods }}"
}'
;

get_header

Get entity header given its GUID.

EXEC azure.purview_data_map.entity.get_header 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_business_metadata_template

Get the sample Template for uploading/creating bulk BusinessMetaData.

EXEC azure.purview_data_map.entity.get_business_metadata_template 
@endpoint='{{ endpoint }}' --required
;

add_classification

Associate a classification to multiple entities in bulk.

EXEC azure.purview_data_map.entity.add_classification 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"classification": "{{ classification }}", 
"entityGuids": "{{ entityGuids }}"
}'
;

add_classifications_by_unique_attribute

Add classification to the entity identified by its type and unique attributes.

EXEC azure.purview_data_map.entity.add_classifications_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}' 
@@json=
'{
"attributes": "{{ attributes }}", 
"typeName": "{{ typeName }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"entityGuid": "{{ entityGuid }}", 
"entityStatus": "{{ entityStatus }}", 
"removePropagationsOnEntityDelete": {{ removePropagationsOnEntityDelete }}, 
"validityPeriods": "{{ validityPeriods }}"
}'
;

update_classifications_unique_by_attribute

Update classification on an entity identified by its type and unique attributes.

EXEC azure.purview_data_map.entity.update_classifications_unique_by_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}' 
@@json=
'{
"attributes": "{{ attributes }}", 
"typeName": "{{ typeName }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"entityGuid": "{{ entityGuid }}", 
"entityStatus": "{{ entityStatus }}", 
"removePropagationsOnEntityDelete": {{ removePropagationsOnEntityDelete }}, 
"validityPeriods": "{{ validityPeriods }}"
}'
;

batch_set_classifications

Set classifications on entities in bulk.

EXEC azure.purview_data_map.entity.batch_set_classifications 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guidHeaderMap": "{{ guidHeaderMap }}"
}'
;

batch_get_by_unique_attributes

Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=&attr_1:=&attr_2:=&attr_3:=\ NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.

EXEC azure.purview_data_map.entity.batch_get_by_unique_attributes 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minExtInfo={{ minExtInfo }}, 
@ignoreRelationships={{ ignoreRelationships }}, 
@attr_N:qualifiedName='{{ attr_N:qualifiedName }}'
;

remove_business_metadata

Remove business metadata from an entity.

EXEC azure.purview_data_map.entity.remove_business_metadata 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

add_or_update_business_metadata

Add business metadata to an entity.

EXEC azure.purview_data_map.entity.add_or_update_business_metadata 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@isOverwrite={{ isOverwrite }}
;

add_or_update_business_metadata_attributes

Add or update business metadata attributes.

EXEC azure.purview_data_map.entity.add_or_update_business_metadata_attributes 
@business_metadata_name='{{ business_metadata_name }}' --required, 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

import_business_metadata

Upload the file for creating Business Metadata in BULK.

EXEC azure.purview_data_map.entity.import_business_metadata 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"file": "{{ file }}"
}'
;

remove_labels

Delete given labels to a given entity.

EXEC azure.purview_data_map.entity.remove_labels 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

set_labels

Set labels to a given entity.

EXEC azure.purview_data_map.entity.set_labels 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

add_label

Add given labels to a given entity.

EXEC azure.purview_data_map.entity.add_label 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

remove_labels_by_unique_attribute

Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

EXEC azure.purview_data_map.entity.remove_labels_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;

set_labels_by_unique_attribute

Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

EXEC azure.purview_data_map.entity.set_labels_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;

add_labels_by_unique_attribute

Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

EXEC azure.purview_data_map.entity.add_labels_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;

move_entities_to_collection

Move existing entities to the target collection.

EXEC azure.purview_data_map.entity.move_entities_to_collection 
@collectionId='{{ collectionId }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"entityGuids": "{{ entityGuids }}"
}'
;