Microsoft Azure Type API

The Type API from Microsoft Azure — 18 operation(s) for type.

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 /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 look up a business metadata type definition in the Purview catalog using its GUID?”

“What attributes does the business metadata definition with a given GUID declare?”

Tell an agent

Fetch the business metadata definition with GUID {guid}.

Show me the attribute list of business metadata type {guid}, looked up by 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 fetch a business metadata definition just by its unique name?”

“What does the business metadata type called 'Governance' look like in my data catalog?”

Tell an agent

Get the business metadata definition named {name}.

Look up business metadata type {name} by name and show its attributes.

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 retrieve a classification type definition when I only have its GUID?”

“Which entity types can a classification apply to, given the classification def GUID?”

Tell an agent

Fetch the classification definition with GUID {guid}.

Show the classification type identified by GUID {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 look up a classification definition such as PII by its name?”

“What are the attributes and supertypes of a named classification in the Atlas type system?”

Tell an agent

Get the classification definition named {name}.

Look up classification type {name} by its unique name.

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

Ask an LLM

“How do I get an entity type definition from the catalog using its GUID?”

“Which attributes and relationships does the entity type with this GUID define?”

Tell an agent

Fetch the entity definition with GUID {guid}.

Show the entity type whose definition GUID is {guid}.

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

Ask an LLM

“Can I fetch the entity type definition for azure_sql_table by name?”

“What attributes does a named entity type like DataSet declare in the Atlas type system?”

Tell an agent

Get the entity definition named {name}.

Look up entity type {name} by name and list its attributes.

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 an enum type definition when I know its GUID?”

“What values does the enum definition with this GUID allow?”

Tell an agent

Fetch the enum definition with GUID {guid}.

List the allowed values of enum type {guid}, looked up 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 look up an enum type definition by its unique name?”

“Which values are allowed in the enum type called 'Status' in my catalog?”

Tell an agent

Get the enum definition named {name}.

Show the allowed values of enum type {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 retrieve a relationship type definition using its GUID?”

“Which two entity types does the relationship definition with this GUID connect?”

Tell an agent

Fetch the relationship definition with GUID {guid}.

Show both ends of relationship type {guid}, looked up by 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 definition by name, like dataset_process_inputs?”

“What cardinality and end types does a named relationship definition declare?”

Tell an agent

Get the relationship definition named {name}.

Look up relationship type {name} by name and show its end definitions.

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 read a struct type definition from its GUID?”

“What fields does the struct definition with this GUID contain?”

Tell an agent

Fetch the struct definition with GUID {guid}.

Show the fields of struct type {guid}, looked up by 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 look up a struct type definition by its unique name?”

“Which attributes make up the struct type with a particular name?”

Tell an agent

Get the struct definition named {name}.

Look up struct type {name} by 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

“How do I fetch a type definition by GUID when I don't know which category of type it is?”

“Is there a generic lookup for any Atlas typedef by GUID, whatever its kind?”

Tell an agent

Fetch the type definition with GUID {guid}, whatever kind of type it is.

Tell me what kind of typedef GUID {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 typedef by name without knowing whether it's an entity, enum or classification?”

“What category of type is the typedef with a given name?”

Tell an agent

Get the type definition named {name}, whatever category it belongs to.

Tell me which kind of typedef {name} is.

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

Ask an LLM

“How do I remove a single custom type definition from my Purview catalog by name?”

“Can I delete one typedef without touching the rest of the type system?”

Tell an agent destructive · confirm first

Delete the type definition named {name}.

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

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

Ask an LLM

“How do I export every type definition in my data catalog in one call?”

“Can I list only entity or classification typedefs, and include term templates?”

Tell an agent

List all type definitions in the catalog with their full details.

List all {type} type definitions in full.

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

Ask an LLM

“How do I register a batch of new custom types in the Atlas type system?”

“What happens to changes to existing typedefs when I bulk-create new ones?”

Tell an agent

Create these new entity types in bulk: {entityDefs}.

Register new classification definitions {classificationDefs} and enum definitions {enumDefs}.

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

Ask an LLM

“How do I push changes to several existing type definitions at once?”

“Can I update entity and classification typedefs together in a single request?”

Tell an agent

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

Apply my changes to classification definitions {classificationDefs} 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 delete several custom type definitions in one request?”

“Can I bulk-remove a set of classification and entity typedefs together?”

Tell an agent destructive · confirm first

Delete these entity type definitions in bulk: {entityDefs}.

Bulk-delete classification definitions {classificationDefs} from the type system.

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 just the names and GUIDs of all typedefs?”

“Which type headers exist for a given category, without the full definitions?”

Tell an agent

List the minimal headers of every type definition.

List just the names and GUIDs of all {type} types.

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

Ask an LLM

“How do I read a glossary term template definition by its GUID?”

“What custom attributes does the term template with this GUID add to glossary terms?”

Tell an agent

Fetch the term template definition with GUID {guid}.

Show the attributes of glossary term template {guid}, looked up by GUID.

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

Ask an LLM

“Can I look up a glossary term template by its name?”

“Which attributes does the term template with a particular name define?”

Tell an agent

Get the term template definition named {name}.

Look up glossary term template {name} by name.

Microsoft Azure Type 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