Microsoft Azure Entity API

The Entity API from Microsoft Azure — 21 operation(s) for entity.

Documentation GitHub OpenAPI

Operations 37

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /entity/moveTo Move data assets into another collection · Microsoft Azure Post Entity Moveto #

Ask an LLM

“Can I move several catalog assets into a different Purview collection at once?”

“What do I need to relocate entities from one collection to another?”

Tell an agent

Move entities {entity_guids} into collection {collection_id}.

Reassign these assets to collection {collection_id}.

POST /atlas/v2/entity Create or update a single data map entity · Microsoft Azure Post Atlas Entity #

Ask an LLM

“How do I register one asset, like a hive table, in the Purview Data Map?”

“Will posting an entity with an existing qualifiedName update it instead of creating a duplicate?”

Tell an agent

Create or update this single entity in the data map: {entity}.

Upsert entity {entity} using business attribute update behavior {behavior}.

GET /atlas/v2/entity/bulk Fetch several entities by their GUIDs · Microsoft Azure Get Atlas Entity Bulk #

Ask an LLM

“How can I look up many catalog entities at once when I have their GUIDs?”

“Can I skip relationship details when pulling a batch of entities by GUID?”

Tell an agent

Get the entities with GUIDs {guids}.

Fetch entities {guids} without their relationships.

POST /atlas/v2/entity/bulk Create or update many entities in one call · Microsoft Azure Post Atlas Entity Bulk #

Ask an LLM

“How do I load a whole batch of assets into the Purview Data Map in one request?”

“Can a bulk entity upsert include the referred entities they point to?”

Tell an agent

Bulk create or update these entities in the data map: {entities}.

Upsert the entity list {entities} in bulk along with referred entities {referred}.

DELETE /atlas/v2/entity/bulk Delete several entities by GUID · Microsoft Azure Delete Atlas Entity Bulk #

Ask an LLM

“Can I remove a whole list of catalog entities at once by GUID?”

“What happens when I bulk delete entities from the data map?”

Tell an agent destructive · confirm first

Delete the entities with GUIDs {guids}.

Bulk remove catalog assets {guids}.

POST /atlas/v2/entity/bulk/classification Apply one classification to many entities · Microsoft Azure Post Atlas Entity Bulk Classification #

Ask an LLM

“How do I tag lots of assets with the same classification in one go?”

“Can one classification be attached to multiple entities in bulk?”

Tell an agent

Apply classification {classification} to entities {entity_guids}.

Mark all of {entity_guids} with the same classification.

GET /atlas/v2/entity/guid/{guid} Get an entity's full definition by GUID · Microsoft Azure Get Atlas Entity Guid Guid #

Ask an LLM

“How do I see everything the catalog knows about one asset by its GUID?”

“Can I get an entity's full definition with minimal extra info?”

Tell an agent

Show the full definition of entity {guid}.

Get entity {guid} and ignore its relationships.

PUT /atlas/v2/entity/guid/{guid} Update one attribute on an entity by GUID · Microsoft Azure Put Atlas Entity Guid Guid #

Ask an LLM

“Can I change just a single attribute of an entity without resending the whole thing?”

“Which attribute types can be updated one at a time on an entity?”

Tell an agent

Set attribute {attribute} on entity {guid}.

Update only the {attribute} attribute of asset {guid}.

DELETE /atlas/v2/entity/guid/{guid} Delete one entity by GUID · Microsoft Azure Delete Atlas Entity Guid Guid #

Ask an LLM

“How do I remove a single data asset from the catalog using its GUID?”

“Is deleting one entity by GUID permanent?”

Tell an agent destructive · confirm first

Delete entity {guid}.

Remove the catalog asset with GUID {guid}.

GET /atlas/v2/entity/guid/{guid}/classification/{classificationName} Get one named classification on an entity · Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname #

Ask an LLM

“How do I check whether an entity carries a specific classification?”

“What are the details of a particular classification on an asset?”

Tell an agent

Get classification {classification} on entity {guid}.

Show the {classification} classification attached to asset {guid}.

DELETE /atlas/v2/entity/guid/{guid}/classification/{classificationName} Remove a classification from an entity by GUID · Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname #

Ask an LLM

“Can I take a single classification off an asset I know by GUID?”

“How do I drop a wrong classification from an entity?”

Tell an agent destructive · confirm first

Remove classification {classification} from entity {guid}.

Delete the {classification} tag from asset {guid}.

GET /atlas/v2/entity/guid/{guid}/classifications List all classifications on an entity · Microsoft Azure Get Atlas Entity Guid Guid Classifications #

Ask an LLM

“Which classifications are applied to this asset?”

“How do I list every classification on an entity by GUID?”

Tell an agent

List all classifications on entity {guid}.

Show every classification attached to asset {guid}.

POST /atlas/v2/entity/guid/{guid}/classifications Add classifications to an entity by GUID · Microsoft Azure Post Atlas Entity Guid Guid Classifications #

Ask an LLM

“How do I attach new classifications to a single asset?”

“Can I add more than one classification to an entity at a time?”

Tell an agent

Add classifications to entity {guid}.

Attach new classification tags to asset {guid}.

PUT /atlas/v2/entity/guid/{guid}/classifications Update existing classifications on an entity · Microsoft Azure Put Atlas Entity Guid Guid Classifications #

Ask an LLM

“Can I change the attributes of classifications already on an entity?”

“How do I edit classifications that are already applied to an asset by GUID?”

Tell an agent

Update the existing classifications on entity {guid}.

Modify classification values already applied to asset {guid}.

GET /atlas/v2/entity/uniqueAttribute/type/{typeName} Get an entity by type and qualified name · Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename #

Ask an LLM

“How do I find an entity when I know its type and qualifiedName but not its GUID?”

“Can I look up a single asset by unique attribute instead of GUID?”

Tell an agent

Get the {type_name} entity with qualified name {qualified_name}.

Look up the {type_name} asset named {qualified_name} without relationships.

PUT /atlas/v2/entity/uniqueAttribute/type/{typeName} Update part of an entity by qualified name · Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename #

Ask an LLM

“Can I update some attributes of an entity identified by type and qualifiedName?”

“Is a null value allowed when partially updating an entity by unique attribute?”

Tell an agent

Update {type_name} entity {qualified_name} with {entity}.

Patch attributes on the {type_name} asset whose qualified name is {qualified_name}.

DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName} Delete an entity by type and qualified name · Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename #

Ask an LLM

“How do I delete an asset when I only know its type and qualifiedName?”

“Can I remove an entity without looking up its GUID first?”

Tell an agent destructive · confirm first

Delete the {type_name} entity with qualified name {qualified_name}.

Remove {type_name} asset {qualified_name} from the catalog.

DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName} Remove a classification by qualified name · Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename… #

Ask an LLM

“Can I drop a classification from an entity identified by qualifiedName?”

“How do I untag an asset found by type and unique attribute?”

Tell an agent destructive · confirm first

Using qualified name {qualified_name}, strip classification {classification} from that {type_name}.

Take the {classification} tag off the {type_name} asset named {qualified_name}.

POST /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications Add classifications by qualified name · Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications #

Ask an LLM

“Can I classify an asset using its type and qualifiedName instead of GUID?”

“What's needed to attach a classification to an entity by unique attribute?”

Tell an agent

Look up {type_name} by qualified name {qualified_name} and attach classifications to it.

Classify the {type_name} asset named {qualified_name}.

PUT /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications Update classifications by qualified name · Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications #

Ask an LLM

“How do I edit classifications on an entity I know by type and qualifiedName?”

“Can existing classifications be modified without the entity GUID?”

Tell an agent

Update classifications on {type_name} entity {qualified_name}.

Revise the classification values on the {type_name} asset {qualified_name}.

POST /atlas/v2/entity/bulk/setClassifications Set classifications across entities in bulk · Microsoft Azure Post Atlas Entity Bulk Setclassifications #

Ask an LLM

“How do I set classifications on many entities with one request?”

“Can I replace classifications for a set of entity headers in bulk?”

Tell an agent

Set classifications in bulk using {guid_header_map}.

Apply these per-entity classification sets in one call: {guid_header_map}.

GET /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName} Fetch several entities by qualified names · Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename #

Ask an LLM

“Can I retrieve many entities of one type by their qualifiedNames at once?”

“How do I bulk look up assets by unique attribute?”

Tell an agent

Get all {type_name} entities matching qualified names {qualified_names}.

Bulk fetch {type_name} assets by unique attribute.

GET /atlas/v2/entity/guid/{guid}/header Get an entity's header summary · Microsoft Azure Get Atlas Entity Guid Guid Header #

Ask an LLM

“Is there a lightweight way to get just the header of an entity?”

“What does an entity header include compared with the full definition?”

Tell an agent

Get the header for entity {guid}.

Show only the summary header of asset {guid}.

DELETE /atlas/v2/entity/guid/{guid}/businessmetadata Remove business metadata from an entity · Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata #

Ask an LLM

“How do I clear business metadata off an asset?”

“Can business metadata be removed from a single entity?”

Tell an agent destructive · confirm first

Remove business metadata from entity {guid}.

Strip the business metadata off asset {guid}.

POST /atlas/v2/entity/guid/{guid}/businessmetadata Add business metadata to an entity · Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata #

Ask an LLM

“How do I attach business metadata to a catalog asset?”

“Can I overwrite all existing business metadata on an entity?”

Tell an agent

Add business metadata to entity {guid}.

Replace the business metadata on asset {guid} with overwrite set to {is_overwrite}.

DELETE /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName} Delete attributes of a named business metadata · Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname #

Ask an LLM

“How do I remove the attributes of one business metadata type from an entity?”

“Can I delete just a single business metadata set from an asset?”

Tell an agent destructive · confirm first

Delete {bm_name} business metadata attributes from entity {guid}.

Clear the {bm_name} values on asset {guid}.

POST /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName} Set attributes of a named business metadata · Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname #

Ask an LLM

“Can I update the attributes of one business metadata type on an entity?”

“How do I fill in a specific business metadata set on an asset?”

Tell an agent

Update business metadata {bm_name} attributes on entity {guid}.

Add {bm_name} business metadata values to asset {guid}.

GET /atlas/v2/entity/businessmetadata/import/template Download the business metadata import template · Microsoft Azure Get Atlas Entity Businessmetadata Import Template #

Ask an LLM

“Where do I get a sample file for bulk-importing business metadata?”

“What format does the business metadata upload template use?”

Tell an agent

Download the sample business metadata import template.

Get the template for bulk business metadata uploads.

POST /atlas/v2/entity/businessmetadata/import Import business metadata definitions from a file · Microsoft Azure Post Atlas Entity Businessmetadata Import #

Ask an LLM

“How do I bulk create business metadata by uploading a file?”

“Can I import business metadata attributes into the data map from a template file?”

Tell an agent

Upload {file} to create business metadata in bulk.

Import the business metadata file {file} into the data map.

DELETE /atlas/v2/entity/guid/{guid}/labels Delete labels from an entity by GUID · Microsoft Azure Delete Atlas Entity Guid Guid Labels #

Ask an LLM

“How do I remove certain labels from an asset I know by GUID?”

“Can I delete specific labels from an entity?”

Tell an agent destructive · confirm first

Delete the given labels from entity {guid}.

Remove labels from asset {guid}.

POST /atlas/v2/entity/guid/{guid}/labels Replace the labels on an entity by GUID · Microsoft Azure Post Atlas Entity Guid Guid Labels #

Ask an LLM

“Can I overwrite all labels on an entity with a new set?”

“What happens to old labels when I set labels on an asset by GUID?”

Tell an agent

Set the labels on entity {guid}, replacing the current ones.

Overwrite asset {guid}'s labels with a new list.

PUT /atlas/v2/entity/guid/{guid}/labels Add labels to an entity by GUID · Microsoft Azure Put Atlas Entity Guid Guid Labels #

Ask an LLM

“How do I add labels to an asset without removing the ones it has?”

“Can I append labels to an entity identified by GUID?”

Tell an agent

Add labels to entity {guid}.

Append new labels to asset {guid}, keeping existing ones.

DELETE /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels Delete labels from an entity by qualified name · Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels #

Ask an LLM

“Are unknown labels ignored when I delete labels from an entity by qualifiedName?”

“How do I remove labels from an asset I identify by type and unique attribute?”

Tell an agent destructive · confirm first

Delete labels from {type_name} entity {qualified_name}.

Remove the given labels from the {type_name} asset named {qualified_name}.

POST /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels Replace labels on an entity by qualified name · Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels #

Ask an LLM

“Does setting an empty label list clear all labels on an entity found by qualifiedName?”

“How do I overwrite labels on an asset by type and unique attribute?”

Tell an agent

Set labels on {type_name} entity {qualified_name}, replacing existing ones.

Overwrite the labels of the {type_name} asset {qualified_name}.

PUT /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels Add labels to an entity by qualified name · Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels #

Ask an LLM

“Is there a way to append labels when I only have a type name and qualifiedName?”

“What happens if I send an empty label list when adding labels by unique attribute?”

Tell an agent

Find the {type_name} with qualified name {qualified_name} and append labels to it.

Append labels to the {type_name} asset named {qualified_name}.

DELETE /entity/bulk/delete Delete entities along with their hierarchy · Microsoft Azure Delete Entity Bulk Delete #

Ask an LLM

“Can I delete entities together with everything beneath them in the hierarchy?”

“Is there a way to control how many deletions run in parallel for a hierarchy delete?”

Tell an agent destructive · confirm first

Delete entities {guids} and their child hierarchy.

Remove {guids} with hierarchy using {parallel_count} parallel workers.

GET /entity/operations/{operationId} Check status of a long-running entity operation · Microsoft Azure Get Entity Operations Operationid #

Ask an LLM

“How do I find out whether a long-running entity job has finished?”

“What's the status of a background entity operation I started?”

Tell an agent

Get the status of entity operation {operation_id}.

Check whether entity job {operation_id} is done.

Microsoft Azure Entity API

Operations 37

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification