entity

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

Overview

Name	entity
Type	Resource
Id	azure.purview_catalog.entity

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	endpoint		Create or update an entity in Atlas. 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>.
create_or_update	replace	endpoint		Create or update an entity in Atlas. 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>.
delete_by_guid	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.
delete_by_guids	delete	endpoint		Delete a list of entities in bulk identified by their GUIDs or unique attributes.
list_by_guids	exec	endpoint	minExtInfo, ignoreRelationships	List entities in bulk identified by its GUIDs.
create_or_update_entities	exec	endpoint		Create or update entities in Atlas 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>.
get_by_guid	exec	guid, endpoint	minExtInfo, ignoreRelationships	Get complete definition of an entity given its GUID.
partial_update_entity_attribute_by_guid	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.
get_by_unique_attributes	exec	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.
partial_update_entity_by_unique_attributes	exec	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.
get_classification	exec	guid, classification_name, endpoint		List classifications for a given entity represented by a GUID.
delete_classification	exec	guid, classification_name, endpoint		Delete a given classification from an existing entity represented by a GUID.
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_entities_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_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1.
get_header	exec	guid, endpoint		Get entity header given its GUID.
get_sample_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.
delete_classification_by_unique_attribute	exec	type_name, classification_name, endpoint	attr:qualifiedName	Delete a given classification from an entity identified by its type and unique attributes.
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_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Update classification on an entity identified by its type and unique attributes.
set_classifications	exec	endpoint		Set classifications on entities in bulk.
delete_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.
delete_business_metadata_attributes	exec	bm_name, guid, endpoint		Delete business metadata attributes from an entity.
add_or_update_business_metadata_attributes	exec	bm_name, guid, endpoint		Add or update business metadata attributes.
delete_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.
delete_labels_by_unique_attribute	exec	type_name, endpoint	attr:qualifiedName	Delete given labels to a given entity identified by its type and unique attributes, 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.

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
bm_name	string	BusinessMetadata name.
classification_name	string	The name of the classification.
endpoint	string	The service endpoint host (no scheme). (default: )
guid	string	The globally unique identifier of the entity.
name	string	The name of the attribute.
type_name	string	The name of the type.
attr:qualifiedName	string	The qualified name of the entity. Default value is None.
attr_N:qualifiedName	string	Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. Default value is None.
ignoreRelationships	boolean	Whether to ignore relationship attributes. Default value is False.
isOverwrite	boolean	Whether to overwrite the existing business metadata on the entity or not, default is false.
minExtInfo	boolean	Whether to return minimal information for referred entities. Default value is False.

INSERT examples

create_or_update

Create or update an entity in Atlas. 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>.

INSERT INTO azure.purview_catalog.entity (
endpoint
)
SELECT 
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: entity
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the entity resource.

REPLACE examples

create_or_update

Create or update an entity in Atlas. 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>.

REPLACE azure.purview_catalog.entity
SET 
-- No updatable properties
WHERE 
endpoint = '{{ endpoint }}' --required;

DELETE examples

delete_by_guid

Delete an entity identified by its GUID.

DELETE FROM azure.purview_catalog.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_catalog.entity
WHERE type_name = '{{ type_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND attr:qualifiedName = '{{ attr:qualifiedName }}'
;

delete_by_guids

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

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

Lifecycle Methods

list_by_guids

List entities in bulk identified by its GUIDs.

EXEC azure.purview_catalog.entity.list_by_guids 
@endpoint='{{ endpoint }}' --required, 
@minExtInfo={{ minExtInfo }}, 
@ignoreRelationships={{ ignoreRelationships }}
;

create_or_update_entities

Create or update entities in Atlas 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>.

EXEC azure.purview_catalog.entity.create_or_update_entities 
@endpoint='{{ endpoint }}' --required
;

get_by_guid

Get complete definition of an entity given its GUID.

EXEC azure.purview_catalog.entity.get_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minExtInfo={{ minExtInfo }}, 
@ignoreRelationships={{ ignoreRelationships }}
;

partial_update_entity_attribute_by_guid

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_catalog.entity.partial_update_entity_attribute_by_guid 
@guid='{{ guid }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_by_unique_attributes

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.

EXEC azure.purview_catalog.entity.get_by_unique_attributes 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minExtInfo={{ minExtInfo }}, 
@ignoreRelationships={{ ignoreRelationships }}, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;

partial_update_entity_by_unique_attributes

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.

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

get_classification

List classifications for a given entity represented by a GUID.

EXEC azure.purview_catalog.entity.get_classification 
@guid='{{ guid }}' --required, 
@classification_name='{{ classification_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_classification

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

EXEC azure.purview_catalog.entity.delete_classification 
@guid='{{ guid }}' --required, 
@classification_name='{{ classification_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_classifications

List classifications for a given entity represented by a GUID.

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

add_classifications

Add classifications to an existing entity represented by a GUID.

EXEC azure.purview_catalog.entity.add_classifications 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

update_classifications

Update classifications to an existing entity represented by a guid.

EXEC azure.purview_catalog.entity.update_classifications 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_entities_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_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1.

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

get_header

Get entity header given its GUID.

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

get_sample_business_metadata_template

Get the sample Template for uploading/creating bulk BusinessMetaData.

EXEC azure.purview_catalog.entity.get_sample_business_metadata_template 
@endpoint='{{ endpoint }}' --required
;

add_classification

Associate a classification to multiple entities in bulk.

EXEC azure.purview_catalog.entity.add_classification 
@endpoint='{{ endpoint }}' --required
;

delete_classification_by_unique_attribute

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

EXEC azure.purview_catalog.entity.delete_classification_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@classification_name='{{ classification_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;

add_classifications_by_unique_attribute

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

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

update_classifications_by_unique_attribute

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

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

set_classifications

Set classifications on entities in bulk.

EXEC azure.purview_catalog.entity.set_classifications 
@endpoint='{{ endpoint }}' --required
;

delete_business_metadata

Remove business metadata from an entity.

EXEC azure.purview_catalog.entity.delete_business_metadata 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

add_or_update_business_metadata

Add business metadata to an entity.

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

delete_business_metadata_attributes

Delete business metadata attributes from an entity.

EXEC azure.purview_catalog.entity.delete_business_metadata_attributes 
@bm_name='{{ bm_name }}' --required, 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

add_or_update_business_metadata_attributes

Add or update business metadata attributes.

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

delete_labels

delete given labels to a given entity.

EXEC azure.purview_catalog.entity.delete_labels 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

set_labels

Set labels to a given entity.

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

add_label

add given labels to a given entity.

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

delete_labels_by_unique_attribute

Delete given labels to a given entity identified by its type and unique attributes, 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_catalog.entity.delete_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_catalog.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_catalog.entity.add_labels_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@attr:qualifiedName='{{ attr:qualifiedName }}'
;