Microsoft Azure Twins API

The Twins API from Microsoft Azure — 7 operation(s) for twins.

Documentation GitHub OpenAPI

Operations 14

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 /digitaltwins/{id} Get a digital twin · Microsoft Azure Get Digitaltwins Id #

Ask an LLM

“How do I fetch the current state of one digital twin by its id?”

“What happens if the digital twin I ask for doesn't exist?”

Tell an agent

Get digital twin {id}.

Show me the properties of twin {id} in Azure Digital Twins.

PUT /digitaltwins/{id} Create or replace a digital twin · Microsoft Azure Put Digitaltwins Id #

Ask an LLM

“Can I create a digital twin only if it doesn't already exist?”

“Why would adding a twin fail because its model is decommissioned or the twin limit is reached?”

Tell an agent

Create digital twin {id}.

Replace digital twin {id} with a new payload.

DELETE /digitaltwins/{id} Delete a digital twin · Microsoft Azure Delete Digitaltwins Id #

Ask an LLM

“Do I have to delete a twin's relationships before deleting the twin itself?”

“Can I delete a digital twin only when its ETag still matches?”

Tell an agent destructive · confirm first

Delete digital twin {id}.

Delete twin {id} if its ETag is still {ifMatch}.

PATCH /digitaltwins/{id} Patch a digital twin's properties · Microsoft Azure Patch Digitaltwins Id #

Ask an LLM

“How do I change a few properties on a twin with a JSON Patch?”

“What makes a JSON Patch on a digital twin fail validation?”

Tell an agent

Apply a JSON Patch to digital twin {id}.

Update twin {id} properties only if its ETag matches {ifMatch}.

GET /digitaltwins/{id}/relationships/{relationshipId} Get a relationship between two twins · Microsoft Azure Get Digitaltwins Id Relationships Relationshipid #

Ask an LLM

“How do I read one specific relationship on a digital twin?”

“Can I look up a twin relationship by its relationship id?”

Tell an agent

Get relationship {relationshipId} on digital twin {id}.

Show the relationship {relationshipId} from twin {id}.

PUT /digitaltwins/{id}/relationships/{relationshipId} Create a relationship between two twins · Microsoft Azure Put Digitaltwins Id Relationships Relationshipid #

Ask an LLM

“How do I connect two digital twins with a relationship?”

“Why would a new twin relationship be rejected as invalid?”

Tell an agent

Create relationship {relationshipId} from twin {id}.

Add relationship {relationshipId} on twin {id} only if it doesn't exist yet, If-None-Match {ifNoneMatch}.

DELETE /digitaltwins/{id}/relationships/{relationshipId} Delete a relationship between two twins · Microsoft Azure Delete Digitaltwins Id Relationships Relationshipid #

Ask an LLM

“Can I remove a link between two digital twins without deleting either twin?”

“Is there an ETag check when deleting a twin relationship?”

Tell an agent destructive · confirm first

Delete relationship {relationshipId} from digital twin {id}.

Remove relationship {relationshipId} on twin {id} if its ETag is {ifMatch}.

PATCH /digitaltwins/{id}/relationships/{relationshipId} Update properties on a twin relationship · Microsoft Azure Patch Digitaltwins Id Relationships Relationshipid #

Ask an LLM

“Can I change the properties on an existing relationship between twins?”

“How do I patch a relationship rather than recreating it?”

Tell an agent

Patch the properties of relationship {relationshipId} on twin {id}.

Update relationship {relationshipId} of twin {id} only if its ETag matches {ifMatch}.

GET /digitaltwins/{id}/relationships List a twin's outgoing relationships · Microsoft Azure Get Digitaltwins Id Relationships #

Ask an LLM

“Which twins does a given digital twin point to?”

“Can I list only relationships with a particular name, like 'contains'?”

Tell an agent

List the outgoing relationships of digital twin {id}.

List relationships named {relationshipName} from twin {id}.

GET /digitaltwins/{id}/incomingrelationships List a twin's incoming relationships · Microsoft Azure Get Digitaltwins Id Incomingrelationships #

Ask an LLM

“Which other twins have relationships pointing at this twin?”

“How do I find everything that references a digital twin before deleting it?”

Tell an agent

List incoming relationships for digital twin {id}.

Show which twins point to twin {id}.

POST /digitaltwins/{id}/telemetry Send telemetry for a digital twin · Microsoft Azure Post Digitaltwins Id Telemetry #

Ask an LLM

“How do I publish telemetry on behalf of a digital twin?”

“Is a message id required when sending twin telemetry?”

Tell an agent

Send telemetry for twin {id} with message id {messageId}.

Publish telemetry from twin {id} as message {messageId} with source time {sourceTime}.

POST /digitaltwins/{id}/components/{componentPath}/telemetry Send telemetry for a twin component · Microsoft Azure Post Digitaltwins Id Components Componentpath Telemetry #

Ask an LLM

“Can I send telemetry for a single component of a twin instead of the whole twin?”

“What does a component path look like when sending component telemetry?”

Tell an agent

Send telemetry for component {componentPath} of twin {id} with message id {messageId}.

Publish component {componentPath} telemetry on twin {id} as message {messageId}.

GET /digitaltwins/{id}/components/{componentPath} Get a component of a digital twin · Microsoft Azure Get Digitaltwins Id Components Componentpath #

Ask an LLM

“How do I read just one component from a digital twin?”

“What error comes back if the component path isn't on the twin?”

Tell an agent

Get component {componentPath} of digital twin {id}.

Show the current values of component {componentPath} on twin {id}.

PATCH /digitaltwins/{id}/components/{componentPath} Patch a component on a digital twin · Microsoft Azure Patch Digitaltwins Id Components Componentpath #

Ask an LLM

“Can I patch the properties of a single twin component?”

“Is there optimistic concurrency when updating a twin component?”

Tell an agent

Apply a JSON Patch to component {componentPath} of twin {id}.

Update component {componentPath} on twin {id} only if ETag is {ifMatch}.

Microsoft Azure Twins API

Operations 14

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification