Microsoft Azure Types API

The Types API from Microsoft Azure — 18 operation(s) for types.

Documentation GitHub OpenAPI

Business capability

Operations 22

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

GET /types/termtemplatedef/guid/{guid} Get a glossary term template by its GUID · Microsoft Azure Get Types Termtemplatedef Guid Guid #

Ask an LLM

“How can I look up a Purview term template when all I have is its GUID?”

“What attributes does a given glossary term template define, looked up by id?”

Tell an agent

Fetch the term template definition with GUID {guid}.

Show me which custom attributes term template {guid} adds to glossary terms.

GET /types/termtemplatedef/name/{name} Get a glossary term template by its name · Microsoft Azure Get Types Termtemplatedef Name Name #

Ask an LLM

“Can I retrieve a term template from the data catalog using its unique name?”

“Where do I find the definition of the term template my stewards call by name?”

Tell an agent

Get the term template named {name}.

Pull up the glossary template definition called {name} and list its fields.

GET /atlas/v2/types/businessmetadatadef/guid/{guid} Get a business metadata definition by GUID · Microsoft Azure Get Atlas Types Businessmetadatadef Guid Guid #

Ask an LLM

“How do I read a business metadata definition in Microsoft Purview using its GUID?”

“Which attributes belong to the business metadata type with a particular id?”

Tell an agent

Retrieve business metadata definition {guid}.

Show the attributes of the businessMetadata type whose GUID is {guid}.

GET /atlas/v2/types/businessmetadatadef/name/{name} Get a business metadata definition by name · Microsoft Azure Get Atlas Types Businessmetadatadef Name Name #

Ask an LLM

“Can I look up a business metadata type in the catalog by its unique name?”

“What does the business metadata definition we named for data owners contain?”

Tell an agent

Get the business metadata definition named {name}.

Open businessMetadata type {name} and list the attributes it applies to entities.

GET /atlas/v2/types/classificationdef/guid/{guid} Get a classification definition by GUID · Microsoft Azure Get Atlas Types Classificationdef Guid Guid #

Ask an LLM

“How do I inspect a classification type when I only have its GUID?”

“Which entity types can a classification with a known id be applied to?”

Tell an agent

Retrieve classification definition {guid}.

Show the attributes and allowed entity types of classification type {guid}.

GET /atlas/v2/types/classificationdef/name/{name} Get a classification definition by name · Microsoft Azure Get Atlas Types Classificationdef Name Name #

Ask an LLM

“Can I fetch a classification such as a PII label definition by its unique name?”

“What's in the classification definition my team created under a specific name?”

Tell an agent

Get the classification definition named {name}.

Look up classification {name} by name and describe its super types.

GET /atlas/v2/types/entitydef/guid/{guid} Get an entity type definition by GUID · Microsoft Azure Get Atlas Types Entitydef Guid Guid #

Ask an LLM

“How can I see the schema of an entity type in the Atlas type system from its GUID?”

“Which attributes and relationships does the entity type with a given id declare?”

Tell an agent

Retrieve entity type definition {guid}.

List the attributes declared by entity def {guid}.

GET /atlas/v2/types/entitydef/name/{name} Get an entity type definition by name · Microsoft Azure Get Atlas Types Entitydef Name Name #

Ask an LLM

“Can I look up an entity type like azure_sql_table by its name?”

“What does the entity definition for a named asset type look like?”

Tell an agent

Get the entity type definition named {name}.

Show the schema of entity type {name}, including its super types.

GET /atlas/v2/types/enumdef/guid/{guid} Get an enum definition by GUID · Microsoft Azure Get Atlas Types Enumdef Guid Guid #

Ask an LLM

“How do I read the allowed values of an enum type when I know its GUID?”

“Which elements does the catalog enum with a specific id contain?”

Tell an agent

Retrieve enum definition {guid}.

List the element values of the enumeration type identified by {guid}.

GET /atlas/v2/types/enumdef/name/{name} Get an enum definition by name · Microsoft Azure Get Atlas Types Enumdef Name Name #

Ask an LLM

“Can I get an enum type from the data map using its unique name?”

“What values are permitted by the enum my attributes reference by name?”

Tell an agent

Get the enum definition named {name}.

Show every allowed value of enum {name}.

GET /atlas/v2/types/relationshipdef/guid/{guid} Get a relationship definition by GUID · Microsoft Azure Get Atlas Types Relationshipdef Guid Guid #

Ask an LLM

“How do I inspect a relationship type between entities using its GUID?”

“Which two entity ends does the relationship definition with a given id connect?”

Tell an agent

Retrieve relationship definition {guid}.

Show both end definitions and the category of relationship type {guid}.

GET /atlas/v2/types/relationshipdef/name/{name} Get a relationship definition by name · Microsoft Azure Get Atlas Types Relationshipdef Name Name #

Ask an LLM

“Can I fetch a relationship type such as table-to-columns by its unique name?”

“What does the named relationship definition in our catalog link together?”

Tell an agent

Get the relationship definition named {name}.

Explain which entity types relationship {name} joins.

GET /atlas/v2/types/structdef/guid/{guid} Get a struct definition by GUID · Microsoft Azure Get Atlas Types Structdef Guid Guid #

Ask an LLM

“How do I look up a struct type in the Atlas type system from its GUID?”

“Which fields make up the struct definition with a particular id?”

Tell an agent

Retrieve struct definition {guid}.

List the fields of struct type {guid}.

GET /atlas/v2/types/structdef/name/{name} Get a struct definition by name · Microsoft Azure Get Atlas Types Structdef Name Name #

Ask an LLM

“Can I get a struct type from the catalog by its unique name?”

“What attributes does the struct called by a given name hold?”

Tell an agent

Get the struct definition named {name}.

Describe the structure of struct type {name}.

GET /atlas/v2/types/typedef/guid/{guid} Get any type definition by GUID · Microsoft Azure Get Atlas Types Typedef Guid Guid #

Ask an LLM

“I have a type GUID but don't know if it's an entity, enum or classification. How do I read it?”

“Is there a generic lookup for any kind of type definition by its id?”

Tell an agent

Fetch the type definition with GUID {guid}, whatever its category.

Tell me what kind of type {guid} is and show its definition.

GET /atlas/v2/types/typedef/name/{name} Get any type definition by name · Microsoft Azure Get Atlas Types Typedef Name Name #

Ask an LLM

“Can I look up a type definition by name without knowing its category first?”

“Which generic endpoint returns whatever type is registered under a given name?”

Tell an agent

Get the type definition named {name} regardless of its category.

Find out what category type {name} belongs to and return its definition.

DELETE /atlas/v2/types/typedef/name/{name} Delete a single type definition by name · Microsoft Azure Delete Atlas Types Typedef Name Name #

Ask an LLM

“How do I remove one custom type from the data map by its name?”

“Can I delete a single type definition without touching the others?”

Tell an agent destructive · confirm first

Delete the type definition named {name}.

Remove custom type {name} from the catalog type system.

GET /atlas/v2/types/typedefs Get all type definitions in bulk · Microsoft Azure Get Atlas Types Typedefs #

Ask an LLM

“How do I export every type definition in the Purview data map at once?”

“Can I pull all type definitions but only of one category, like entity types?”

Tell an agent

Get the full definitions of all types in the catalog.

Return all type definitions of category {type} in full.

POST /atlas/v2/types/typedefs Create new type definitions in bulk · Microsoft Azure Post Atlas Types Typedefs #

Ask an LLM

“How do I register new custom entity types in the data map?”

“What happens to changes on existing types when I bulk-create definitions?”

Tell an agent

Create these new entity types in the catalog: {entityDefs}.

Register new business metadata types {businessMetadataDefs} and relationship types {relationshipDefs}.

PUT /atlas/v2/types/typedefs Update type definitions in bulk · Microsoft Azure Put Atlas Types Typedefs #

Ask an LLM

“How do I change several existing type definitions in a single request?”

“Can I update entity and classification types together and have the changes persisted?”

Tell an agent

Update these existing entity type definitions in bulk: {entityDefs}.

Apply changes to classification types {classificationDefs} and enum types {enumDefs} in one bulk update.

DELETE /atlas/v2/types/typedefs Delete type definitions in bulk · Microsoft Azure Delete Atlas Types Typedefs #

Ask an LLM

“How do I remove several type definitions from the catalog at once?”

“Can I bulk-delete a set of classification and struct types in one request?”

Tell an agent destructive · confirm first

Bulk delete these entity type definitions: {entityDefs}.

Remove classification types {classificationDefs} and struct types {structDefs} together.

GET /atlas/v2/types/typedefs/headers List type definition headers · Microsoft Azure Get Atlas Types Typedefs Headers #

Ask an LLM

“Is there a lightweight way to list type names and GUIDs without full definitions?”

“Which types exist in the data map, just as a quick header list?”

Tell an agent

List minimal headers for all type definitions.

Give me the name and GUID headers of every {type} type.

Microsoft Azure Types API

Operations 22

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification