Microsoft Azure Device Groups API

The Device Groups API from Microsoft Azure — 7 operation(s) for device groups.

Documentation GitHub OpenAPI

Operations 13

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 /deviceGroups List IoT Central device groups · Microsoft Azure Get The List Of Device Groups In An Application #

Ask an LLM

“Which device groups are defined in my IoT Central application?”

“Can I sort or filter the list of device groups in IoT Central?”

Tell an agent

List all device groups in my IoT Central app.

List IoT Central device groups matching {filter}, ordered by {orderby}.

GET /deviceGroups/{deviceGroupId} Get an IoT Central device group · Microsoft Azure Get The Device Group By Id #

Ask an LLM

“What filter and organizations does a given IoT Central device group use?”

“Can I look up an IoT Central device group by its ID?”

Tell an agent

Show IoT Central device group {group}.

Get the definition of IoT Central device group {group}.

PUT /deviceGroups/{deviceGroupId} Create or replace an IoT Central device group · Microsoft Azure Create Or Update A Device Group #

Ask an LLM

“How do I create a device group in IoT Central that selects devices by a filter query?”

“Does a new IoT Central device group need a display name and a filter?”

Tell an agent

Create IoT Central device group {group} named {name} with filter {filter}.

Create device group {group} scoped to organizations {orgs}.

PATCH /deviceGroups/{deviceGroupId} Update an existing IoT Central device group · Microsoft Azure Update A Device Group Via Patch #

Ask an LLM

“How do I patch an IoT Central device group without recreating it?”

“Can I guard an IoT Central device group update with an ETag?”

Tell an agent

Update IoT Central device group {group}.

Patch IoT Central device group {group} only if its ETag is {etag}.

DELETE /deviceGroups/{deviceGroupId} Delete an IoT Central device group · Microsoft Azure Delete A Device Group #

Ask an LLM

“Can I delete a device group from my IoT Central application?”

“Is there a way to get rid of an IoT Central device group I no longer need?”

Tell an agent destructive · confirm first

Delete IoT Central device group {group}.

Remove the device group {group} from IoT Central.

GET /deviceGroups/{deviceGroupId}/devices List devices in an IoT Central device group · Microsoft Azure Get The Devices Of A Device Group #

Ask an LLM

“Which devices currently belong to an IoT Central device group?”

“Can I page through the member devices of a device group?”

Tell an agent

List the devices in IoT Central device group {group}.

Show up to {size} devices per page from device group {group}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups List Azure Sphere device groups for a product · Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“Which device groups exist under an Azure Sphere product?”

“Can I filter or page the device groups of a Sphere product?”

Tell an agent

List device groups for product {product} in Azure Sphere catalog {catalog}.

Show the first {top} Sphere device groups of product {product} in catalog {catalog}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName} Get an Azure Sphere device group · Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“What are the settings of one Azure Sphere device group?”

“Can I fetch a Sphere device group by catalog, product and group name?”

Tell an agent

Get Azure Sphere device group {group} of product {product} in catalog {catalog}.

Show the properties of Sphere device group {group} under {product}.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName} Create an Azure Sphere device group · Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“How do I add a new device group to an Azure Sphere product?”

“Are there reserved names I cannot use for a Sphere device group?”

Tell an agent

Create Azure Sphere device group {group} for product {product} in catalog {catalog}.

Create Sphere device group {group} under {product} with properties {props}.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName} Update an Azure Sphere device group · Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“How do I change the properties of an existing Azure Sphere device group?”

“Can I patch a Sphere device group without recreating it?”

Tell an agent

Update Azure Sphere device group {group} of product {product} in catalog {catalog}.

Patch Sphere device group {group} under {product} with properties {props}.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName} Delete an Azure Sphere device group · Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“Can I delete a device group from an Azure Sphere product?”

“Is it possible to remove the system default Sphere device groups?”

Tell an agent destructive · confirm first

Delete Azure Sphere device group {group} of product {product} in catalog {catalog}.

Remove Sphere device group {group} from product {product}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices Bulk claim devices into an Azure Sphere device group · Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“How do I claim many Azure Sphere devices into a device group at once?”

“Can I bulk claim devices to a catalog only using the unassigned group?”

Tell an agent

Claim devices {devices} into Sphere device group {group} of product {product} in catalog {catalog}.

Bulk claim device IDs {devices} into group {group}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices Count devices in an Azure Sphere device group · Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“How many devices are in one of my Azure Sphere device groups?”

“Can I get a device count for a Sphere group without listing every device?”

Tell an agent

Count devices in Sphere device group {group} of product {product} in catalog {catalog}.

Tell me how many devices sit in device group {group}.

Microsoft Azure Device Groups API

Operations 13

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification