published on May 12, 2024 in gacor

azure.purview.catalog.rest.entity package Azure SDK for Python 2.0.0 documentation

azure.purview.catalog.rest.entity.build_create_or_update_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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:code:<int>>, array<map<string, int>>.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – Atlas entity with extended information.
content (Any) – Atlas entity with extended information.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = { "entity": { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } } # response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_list_by_guids_request(*, guids: List[str], min_ext_info: Optional[bool] = False, ignore_relationships: Optional[bool] = False, exclude_relationship_types: Optional[List[str]] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

List entities in bulk identified by its GUIDs.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

guids (list[str]) – An array of GUIDs of entities to create.
min_ext_info (bool) – Whether to return minimal information for referred entities.
ignore_relationships (bool) – Whether to ignore relationship attributes.
exclude_relationship_types (list[str]) – An array of the relationship types need to be excluded from the response.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "entities": [ { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } ] }

azure.purview.catalog.rest.entity.build_create_or_update_entities_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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:code:<int>>, array<map<string, int>>.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – An array of entities to create or update.
content (Any) – An array of entities to create or update.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = { "entities": [ { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } ] } # response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_delete_by_guids_request(*, guids: List[str], **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

guids (list[str]) – An array of GUIDs of entities to delete.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_add_classification_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Associate a classification to multiple entities in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – The request to associate a classification to multiple entities.
content (Any) – The request to associate a classification to multiple entities.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = { "classification": { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] }, "entityGuids": [ "str (optional)" ] }

azure.purview.catalog.rest.entity.build_get_by_guid_request(guid: str, *, min_ext_info: Optional[bool] = False, ignore_relationships: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get complete definition of an entity given its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Keyword Arguments

min_ext_info (bool) – Whether to return minimal information for referred entities.
ignore_relationships (bool) – Whether to ignore relationship attributes.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "entity": { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } }

azure.purview.catalog.rest.entity.build_partial_update_entity_attribute_by_guid_request(guid: str, *, json: Any = None, content: Any = None, name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Keyword Arguments

json (Any) – The value of the attribute.
content (Any) – The value of the attribute.
name (str) – The name of the attribute.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = "object (optional)" # response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_delete_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete an entity identified by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_get_classification_request(guid: str, classification_name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

List classifications for a given entity represented by a GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.
classification_name (str) – The name of the classification.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_delete_classification_request(guid: str, classification_name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.
classification_name (str) – The name of the classification.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

azure.purview.catalog.rest.entity.build_get_classifications_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

List classifications for a given entity represented by a GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == {}

azure.purview.catalog.rest.entity.build_add_classifications_request(guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Add classifications to an existing entity represented by a GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Keyword Arguments

json (Any) – An array of classifications to be added.
content (Any) – An array of classifications to be added.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ]

azure.purview.catalog.rest.entity.build_update_classifications_request(guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update classifications to an existing entity represented by a guid.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Keyword Arguments

json (Any) – An array of classifications to be updated.
content (Any) – An array of classifications to be updated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ]

azure.purview.catalog.rest.entity.build_get_by_unique_attributes_request(type_name: str, *, min_ext_info: Optional[bool] = False, ignore_relationships: Optional[bool] = False, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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::code:<attrName>`=:code:`<attrValue>. 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.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

min_ext_info (bool) – Whether to return minimal information for referred entities.
ignore_relationships (bool) – Whether to ignore relationship attributes.
attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "entity": { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } }

azure.purview.catalog.rest.entity.build_partial_update_entity_by_unique_attributes_request(type_name: str, *, json: Any = None, content: Any = None, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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:<attrName>`=:code:`<attrValue>. 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.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

json (Any) – Atlas entity with extended information.
content (Any) – Atlas entity with extended information.
attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = { "entity": { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } } # response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_delete_by_unique_attribute_request(type_name: str, *, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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::code:<attrName>`=:code:`<attrValue>. 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.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "guidAssignments": { "str": "str (optional)" }, "mutatedEntities": { "str": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }, "partialUpdatedEntities": [ { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } ] }

azure.purview.catalog.rest.entity.build_delete_classification_by_unique_attribute_request(type_name: str, classification_name: str, *, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.
classification_name (str) – The name of the classification.

Keyword Arguments

attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

azure.purview.catalog.rest.entity.build_add_classifications_by_unique_attribute_request(type_name: str, *, json: Any = None, content: Any = None, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

json (Any) – An array of classification to be added.
content (Any) – An array of classification to be added.
attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ]

azure.purview.catalog.rest.entity.build_update_classifications_by_unique_attribute_request(type_name: str, *, json: Any = None, content: Any = None, attr_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

json (Any) – An array of classification to be updated.
content (Any) – An array of classification to be updated.
attr_qualified_name (str) – The qualified name of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ]

azure.purview.catalog.rest.entity.build_set_classifications_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Set classifications on entities in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – Atlas entity headers.
content (Any) – Atlas entity headers.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# JSON input template you can fill out and use as your `json` input. json = { "guidHeaderMap": { "str": { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" } } } # response body for status code(s): 200 response_body == [ "str (optional)" ]

azure.purview.catalog.rest.entity.build_get_entities_by_unique_attributes_request(type_name: str, *, min_ext_info: Optional[bool] = False, ignore_relationships: Optional[bool] = False, attr_n_qualified_name: Optional[str] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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=:code:<typeName>`&attr_1::code:`<attrName>`=:code:`<attrValue>`&attr_2::code:`<attrName>`=:code:`<attrValue>`&attr_3::code:`<attrName>`=:code:`<attrValue>

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.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

type_name (str) – The name of the type.

Keyword Arguments

min_ext_info (bool) – Whether to return minimal information for referred entities.
ignore_relationships (bool) – Whether to ignore relationship attributes.
attr_n_qualified_name (str) – Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "entities": [ { "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "contacts": { "str": [ { "id": "str (optional)", "info": "str (optional)" } ] }, "createTime": "float (optional)", "createdBy": "str (optional)", "guid": "str (optional)", "homeId": "str (optional)", "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "provenanceType": "float (optional)", "proxy": "bool (optional)", "relationshipAttributes": { "str": "object (optional)" }, "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } ] }

azure.purview.catalog.rest.entity.build_get_header_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get entity header given its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

Example

# response body for status code(s): 200 response_body == { "classificationNames": [ "str (optional)" ], "classifications": [ { "entityGuid": "str (optional)", "entityStatus": "str (optional)", "removePropagationsOnEntityDelete": "bool (optional)", "source": "str (optional)", "sourceDetails": { "str": "object (optional)" }, "validityPeriods": [ { "endTime": "str (optional)", "startTime": "str (optional)", "timeZone": "str (optional)" } ] } ], "displayText": "str (optional)", "guid": "str (optional)", "meaningNames": [ "str (optional)" ], "meanings": [ { "confidence": "int (optional)", "createdBy": "str (optional)", "description": "str (optional)", "displayText": "str (optional)", "expression": "str (optional)", "relationGuid": "str (optional)", "source": "str (optional)", "status": "str (optional)", "steward": "str (optional)", "termGuid": "str (optional)" } ], "status": "str (optional)" }

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnploqKmptbC6jpqxrqqVYr22vtWinLBlk5bBorjOoGZqZmBjfaN9jpqxrqqVY722vtWinLBmk5bBorjOoGWrnaOpe6a606KrsmaYqbqt