Microsoft Azure Devices API

The Devices API from Microsoft Azure — 61 operation(s) for devices.

Documentation GitHub OpenAPI

Operations 93

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 /sensor-partners/{sensorPartnerId}/devices List a sensor partner's farm devices · Microsoft Azure Get Sensor Partners Sensorpartnerid Devices #

Ask an LLM

“Which field sensor devices are registered under a sensor partner in Data Manager for Agriculture?”

“Can I filter a sensor partner's devices by status, parent device or device data model?”

Tell an agent

List devices for sensor partner {partner}.

Show sensor partner {partner}'s devices with status {statuses}.

PATCH /sensor-partners/{sensorPartnerId}/devices/{deviceId} Create or update a sensor partner's farm device · Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid #

Ask an LLM

“How do I register a new field sensor device under a sensor partner?”

“Can I set a device's hardware ID, data model and reporting interval in Data Manager for Agriculture?”

Tell an agent

Create farm device {device} for partner {partner} using data model {model}.

Set the reporting interval of agriculture device {device} to {seconds} seconds.

GET /sensor-partners/{sensorPartnerId}/devices/{deviceId} Get a sensor partner's farm device · Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid #

Ask an LLM

“How do I look up one agriculture sensor device by its ID?”

“What hardware ID and reporting interval does a sensor partner device have?”

Tell an agent

Get device {device} of sensor partner {partner}.

Show the reporting interval and location of farm device {device}.

DELETE /sensor-partners/{sensorPartnerId}/devices/{deviceId} Delete a sensor partner's farm device · Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid #

Ask an LLM

“How do I remove a retired field sensor device from a sensor partner?”

“Can I delete an agriculture device entity by its ID?”

Tell an agent destructive · confirm first

Delete device {device} from sensor partner {partner}.

Remove the farm sensor device {device}.

GET /devices List devices in an IoT Central app · Microsoft Azure Get The List Of Devices In An Application With Basic Odata… #

Ask an LLM

“What devices are connected to my IoT Central application?”

“Can I filter and sort the IoT Central device list with OData options?”

Tell an agent

List all devices in my IoT Central application.

List IoT Central devices matching {filter} ordered by {orderby}.

GET /devices/{deviceId} Get an IoT Central device · Microsoft Azure Get A Device By Id #

Ask an LLM

“How do I see the template, enabled flag and provisioning state of one IoT Central device?”

“Is a given IoT Central device simulated or real?”

Tell an agent

Get IoT Central device {device}.

Show whether device {device} is provisioned and enabled.

PUT /devices/{deviceId} Create or replace an IoT Central device · Microsoft Azure Create Or Update A Device #

Ask an LLM

“How do I add a new device to my IoT Central application?”

“Can I create a simulated device with a specific device template?”

Tell an agent

Create IoT Central device {device} named {name} using template {template}.

Add simulated device {device} to the application.

PATCH /devices/{deviceId} Update an IoT Central device · Microsoft Azure Update A Device Via Patch #

Ask an LLM

“Can I disable or rename an existing IoT Central device without recreating it?”

“How do I make a partial update to an IoT Central device only if its etag still matches?”

Tell an agent

Patch IoT Central device {device}.

Update device {device} only if its etag matches {etag}.

DELETE /devices/{deviceId} Delete an IoT Central device · Microsoft Azure Delete A Device #

Ask an LLM

“How do I remove a device from my IoT Central application?”

“Can I delete an IoT Central device by ID?”

Tell an agent destructive · confirm first

Delete IoT Central device {device}.

Remove device {device} from the IoT Central app.

POST /devices/{deviceId}/applyDeploymentManifest Apply a deployment manifest to an edge device · Microsoft Azure Apply A Deployment Manifest To An Edge Device #

Ask an LLM

“How do I push an IoT Edge deployment manifest to a device in IoT Central?”

“Can I change which modules an edge device runs by applying a manifest?”

Tell an agent

Apply deployment manifest {manifest} to edge device {device}.

Deploy the module configuration {manifest} to IoT Edge device {device}.

GET /devices/{deviceId}/attestation Get a device's individual attestation · Microsoft Azure Get Device Attestation #

Ask an LLM

“Which attestation mechanism does a specific IoT Central device use?”

“How do I view the individual enrollment attestation of a device?”

Tell an agent

Get the attestation for device {device}.

Show how device {device} authenticates when provisioning.

PUT /devices/{deviceId}/attestation Create an individual device attestation · Microsoft Azure Create An Individual Device Attestation #

Ask an LLM

“How do I give one IoT Central device its own X.509 or symmetric key attestation?”

“Can I set up an individual enrollment for a device instead of a group one?”

Tell an agent

Create a {type} attestation for device {device}.

Set up individual enrollment attestation on device {device}.

PATCH /devices/{deviceId}/attestation Update a device's individual attestation · Microsoft Azure Update An Individual Device Attestation Via Patch #

Ask an LLM

“Can I rotate or modify the individual attestation already set on a device?”

“How do I patch an existing device attestation in IoT Central?”

Tell an agent

Patch the existing attestation of device {device}.

Update individual attestation keys for device {device}.

DELETE /devices/{deviceId}/attestation Remove a device's individual attestation · Microsoft Azure Remove An Individual Device Attestation #

Ask an LLM

“How do I delete the individual attestation from an IoT Central device?”

“Can a device go back to group enrollment after removing its own attestation?”

Tell an agent destructive · confirm first

Remove the individual attestation from device {device}.

Delete device {device}'s enrollment credentials.

GET /devices/{deviceId}/commands/{commandName} Get a device command's history · Microsoft Azure Get Device Command History #

Ask an LLM

“How do I see past runs and responses of a command sent to a device?”

“Did the last reboot command on my IoT Central device succeed?”

Tell an agent

Pull the device-level run log for {command} on {device}.

Show past executions of {command} for device {device}.

POST /devices/{deviceId}/commands/{commandName} Run a command on a device · Microsoft Azure Run A Device Command #

Ask an LLM

“How do I send a direct command to an IoT Central device?”

“Can I set connection and response timeouts when running a device command?”

Tell an agent

Run command {command} on device {device}.

Send {command} to device {device} with payload {request}.

GET /devices/{deviceId}/components List a device's components · Microsoft Azure List The Components Present In A Device #

Ask an LLM

“Which components does an IoT Central device expose?”

“What are the component names defined on a device's model?”

Tell an agent

List the components on device {device}.

Show every component present on {device}.

GET /devices/{deviceId}/components/{componentName}/commands/{commandName} Get a component command's history · Microsoft Azure Get Component Command History #

Ask an LLM

“How do I check previous runs of a command on a specific device component?”

“What did a component-level command return last time it ran?”

Tell an agent

Get the history of command {command} on component {component} of device {device}.

Show past {command} results for component {component}.

POST /devices/{deviceId}/components/{componentName}/commands/{commandName} Run a command on a device component · Microsoft Azure Run A Component Command #

Ask an LLM

“How do I invoke a command defined on one component of a device?”

“Can I run a component command with a custom request payload?”

Tell an agent

Run command {command} on component {component} of device {device}.

Call {command} on the {component} component of {device}, sending {request}.

GET /devices/{deviceId}/components/{componentName}/properties Get a device component's properties · Microsoft Azure Get Device Properties For A Specific Component #

Ask an LLM

“What property values does one component of my device currently report?”

“Can I include unmodeled properties when reading a component's properties?”

Tell an agent

Get the properties of component {component} on device {device}.

Show component {component}'s properties on {device}, including unmodeled ones.

PUT /devices/{deviceId}/components/{componentName}/properties Replace a device component's properties · Microsoft Azure Replace Device Properties For A Specific Component #

Ask an LLM

“How do I overwrite every writable property on a device component at once?”

“Can I replace all of a component's property values in one call?”

Tell an agent

Replace all properties of component {component} on device {device}.

Overwrite the full property set of {component} for {device}.

PATCH /devices/{deviceId}/components/{componentName}/properties Update some device component properties · Microsoft Azure Update Device Properties For A Specific Component Via Patch #

Ask an LLM

“Can I change a single writable property on a device component without touching the rest?”

“How do I partially update a component's properties?”

Tell an agent

Patch selected properties of component {component} on device {device}.

Change one setting in the {component} component of {device}.

GET /devices/{deviceId}/components/{componentName}/telemetry/{telemetryName} Get last telemetry value from a component · Microsoft Azure Get Component Telemetry Value #

Ask an LLM

“What was the most recent temperature reading from a device component?”

“How do I read the latest telemetry value a specific component sent?”

Tell an agent

Get the last {telemetry} value from component {component} of device {device}.

Show component {component}'s latest {telemetry} reading.

GET /devices/{deviceId}/credentials Get a device's connection credentials · Microsoft Azure Get Device Credentials #

Ask an LLM

“How do I get the keys or certificates a device uses to connect to IoT Central?”

“Where do I find the ID scope and credentials for provisioning a device?”

Tell an agent

Get the connection credentials for device {device}.

Show the provisioning keys of {device}.

GET /devices/{deviceId}/modules List modules on an edge device · Microsoft Azure List The Modules Present In A Device #

Ask an LLM

“Which IoT Edge modules are running on a device?”

“What modules does my IoT Central edge device contain?”

Tell an agent

List the modules on device {device}.

Show all edge modules present on {device}.

GET /devices/{deviceId}/modules/{moduleName}/commands/{commandName} Get a module command's history · Microsoft Azure Get Module Command History #

Ask an LLM

“How do I review previous runs of a command sent to an edge module?”

“What response did an IoT Edge module give to its last command?”

Tell an agent

Get the history of command {command} on module {module} of device {device}.

Show past {command} runs on module {module}.

POST /devices/{deviceId}/modules/{moduleName}/commands/{commandName} Run a command on an edge module · Microsoft Azure Run A Module Command #

Ask an LLM

“How do I send a command to an IoT Edge module on a device?”

“Can I call a module's command with a response timeout?”

Tell an agent

Run command {command} on module {module} of device {device}.

Send {command} to edge module {module} with payload {request}.

GET /devices/{deviceId}/modules/{moduleName}/components List components inside an edge module · Microsoft Azure List The Components Present In A Module #

Ask an LLM

“Which components does an IoT Edge module on my device define?”

“What are the component names within a device's module?”

Tell an agent

List the components in module {module} of device {device}.

Show module {module}'s components.

GET /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName} Get a module component command's history · Microsoft Azure Get Module Component Command History #

Ask an LLM

“How do I see past results of a command on a component inside an edge module?”

“Did a command on a module's component succeed previously?”

Tell an agent

Get history of {command} on component {component} in module {module} of device {device}.

Show earlier runs of {command} for module {module}'s {component} component.

POST /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName} Run a command on a module component · Microsoft Azure Run A Module Component Command #

Ask an LLM

“How do I invoke a command on a component that lives inside an edge module?”

“Can I target one component of an IoT Edge module with a command?”

Tell an agent

Run {command} on component {component} of module {module} on device {device}.

Invoke {command} on module {module}'s {component} component with payload {request}.

GET /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties Get a module component's properties · Microsoft Azure Get Module Properties For A Specific Component #

Ask an LLM

“What properties does a component inside an edge module report?”

“How do I read property values for one component of a module?”

Tell an agent

Get the properties of component {component} in module {module} on device {device}.

Show property values for module {module}'s {component} component.

PUT /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties Replace a module component's properties · Microsoft Azure Replace Module Properties For A Specific Component #

Ask an LLM

“How do I overwrite all properties of a component inside an edge module?”

“Can I replace a module component's whole property set in one request?”

Tell an agent

Replace all properties of component {component} in module {module} on device {device}.

Overwrite every property on module {module}'s {component} component.

PATCH /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties Update some module component properties · Microsoft Azure Update Module Properties For A Specific Component Via Patch #

Ask an LLM

“Can I change just one property on a component inside an edge module?”

“How do I partially patch a module component's writable properties?”

Tell an agent

Patch selected properties of component {component} in module {module} on device {device}.

Change a single setting on module {module}'s {component} component.

GET /devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName} Get last telemetry from a module component · Microsoft Azure Get Module Component Telemetry Value #

Ask an LLM

“What is the latest telemetry reading from a component inside an edge module?”

“How do I read the last value a module component reported for a metric?”

Tell an agent

Get the last {telemetry} value from component {component} in module {module} on device {device}.

Show module {module} component {component}'s latest {telemetry}.

GET /devices/{deviceId}/modules/{moduleName}/properties Get an edge module's properties · Microsoft Azure Get Module Properties #

Ask an LLM

“What property values does an IoT Edge module currently have?”

“How do I read all properties of a module on a device?”

Tell an agent

Get all properties of module {module} on device {device}.

Show edge module {module}'s current property values.

PUT /devices/{deviceId}/modules/{moduleName}/properties Replace an edge module's properties · Microsoft Azure Replace Module Properties #

Ask an LLM

“How do I overwrite every property value of an IoT Edge module?”

“Can I replace a module's whole property set at once?”

Tell an agent

Replace all property values of module {module} on device {device}.

Overwrite edge module {module}'s full property set.

PATCH /devices/{deviceId}/modules/{moduleName}/properties Update some edge module properties · Microsoft Azure Update Module Properties Via Patch #

Ask an LLM

“Can I update a few module property values without replacing the others?”

“How do I patch the writable properties of an edge module?”

Tell an agent

Patch selected property values of module {module} on device {device}.

Change one setting on edge module {module}.

GET /devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName} Get last telemetry value from a module · Microsoft Azure Get Module Telemetry Value #

Ask an LLM

“What was the latest telemetry value an edge module sent?”

“How do I read the most recent metric reported by a module?”

Tell an agent

Get the last {telemetry} value from module {module} on device {device}.

Show edge module {module}'s newest {telemetry} reading.

GET /devices/{deviceId}/properties Get an IoT Central device's properties · Microsoft Azure Get Device Properties #

Ask an LLM

“What reported and writable property values does my IoT Central device have?”

“Can I include unmodeled properties when reading a device's properties?”

Tell an agent

Get all property values of device {device}.

Show device {device}'s properties including unmodeled ones.

PUT /devices/{deviceId}/properties Replace an IoT Central device's properties · Microsoft Azure Replace Device Properties #

Ask an LLM

“How do I overwrite every writable property of a device at once?”

“Can I replace a device's entire property set in IoT Central?”

Tell an agent

Replace all property values of device {device}.

Overwrite the full set of writable properties on {device}.

PATCH /devices/{deviceId}/properties Update some IoT Central device properties · Microsoft Azure Update Device Properties Via Patch #

Ask an LLM

“Can I change one writable property on a device without resending the others?”

“How do I partially update a device's property values?”

Tell an agent

Patch selected property values of device {device}.

Change the fan speed setting on device {device}.

GET /devices/{deviceId}/relationships List a gateway device's relationships · Microsoft Azure Given The Id For An Upstream Device, Will Return The Upstream… #

Ask an LLM

“Which downstream devices are attached to my IoT Central gateway?”

“How do I see the upstream and downstream relationships of a device?”

Tell an agent

List the relationships of device {device}.

Show up to {max} downstream relationships for gateway {device}.

GET /devices/{deviceId}/relationships/{relationshipId} Get a device relationship · Microsoft Azure Given The Id For A Device And A Relationship Id Associated With… #

Ask an LLM

“How do I look up the source and target of one device relationship?”

“Can I fetch a specific gateway relationship by its ID?”

Tell an agent

Get relationship {relationship} of device {device}.

Show the source and target of relationship {relationship}.

PUT /devices/{deviceId}/relationships/{relationshipId} Create a device relationship · Microsoft Azure Given The Id For A Device And A Relationship Id Associated With… #

Ask an LLM

“How do I attach a downstream device to a gateway in IoT Central?”

“Can I link two devices with a new relationship?”

Tell an agent

Create relationship {relationship} from device {device} to {target}.

Attach downstream device {target} to gateway {device} as relationship {relationship}.

PATCH /devices/{deviceId}/relationships/{relationshipId} Update a device relationship · Microsoft Azure Patch A Given Relationship Given The Relationship Id And A… #

Ask an LLM

“Can I modify an existing relationship between a gateway and a device?”

“How do I patch a device relationship that already exists?”

Tell an agent

Patch relationship {relationship} on device {device}.

Update the existing gateway relationship {relationship}.

DELETE /devices/{deviceId}/relationships/{relationshipId} Delete a device relationship · Microsoft Azure Given The Id For A Device And An Associated Relationship Id… #

Ask an LLM

“How do I detach a downstream device from its gateway?”

“Can I delete a relationship from either the upstream or the downstream device?”

Tell an agent destructive · confirm first

Delete relationship {relationship} on device {device}.

Detach the gateway link {relationship}.

GET /devices/{deviceId}/telemetry/{telemetryName} Get a device's last telemetry value · Microsoft Azure Get Device Telemetry Value #

Ask an LLM

“What was the last humidity reading my IoT Central device sent?”

“How do I read a device's most recent telemetry value for one metric?”

Tell an agent

Get the last {telemetry} value from device {device}.

Show device {device}'s latest {telemetry}.

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

Ask an LLM

“Which Azure Sphere devices belong to a device group?”

“How do I list devices for a product and device group in a Sphere catalog?”

Tell an agent

List Azure Sphere devices in group {group} of product {product} in catalog {catalog}.

Show all devices assigned to Sphere device group {group}.

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

Ask an LLM

“How do I look up one Azure Sphere device in my catalog?”

“Can I get a Sphere device that is not in any device group?”

Tell an agent

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

Show Sphere device {device}'s details.

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

Ask an LLM

“How do I claim an Azure Sphere device into my catalog?”

“Can I claim a Sphere device to the catalog only without a device group?”

Tell an agent

Claim Azure Sphere device {device} into catalog {catalog}, product {product}, group {group}.

Add Sphere device {device} to my catalog as unassigned.

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

Ask an LLM

“How do I move an Azure Sphere device to a different device group?”

“Can I move a Sphere device back to the catalog level?”

Tell an agent

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

Move Sphere device {device} with properties {properties}.

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

Ask an LLM

“How do I remove an Azure Sphere device from my catalog?”

“Can I delete a Sphere device record from a device group?”

Tell an agent destructive · confirm first

Delete Azure Sphere device {device} from group {group}, product {product}, catalog {catalog}.

Remove Sphere device {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage Generate an Azure Sphere capability image · Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers… #

Ask an LLM

“How do I generate a capability image to unlock debugging on an Azure Sphere device?”

“Which capabilities can be included in a Sphere device capability image?”

Tell an agent

Generate a capability image for Sphere device {device} with capabilities {capabilities}.

Create a capability image for device {device} in group {group}, product {product}, catalog {catalog}.

GET /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices List Data Box Edge devices in a subscription · Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft… #

Ask an LLM

“Which Azure Stack Edge and Data Box Gateway devices exist across my subscription?”

“How do I see every Data Box Edge device regardless of resource group?”

Tell an agent

List all Data Box Edge devices in subscription {sub}.

Show every Data Box Gateway device in my subscription.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices List Data Box Edge devices in a resource group · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which Data Box Edge devices are in a particular resource group?”

“How do I list Azure Stack Edge devices for one resource group?”

Tell an agent

List Data Box Edge devices in resource group {rg} of subscription {sub}.

Show the Azure Stack Edge devices in group {rg}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName} Get a Data Box Edge device · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I see the properties of one Azure Stack Edge device?”

“What SKU and status does my Data Box Gateway device have?”

Tell an agent

Get Data Box Edge device {device} in group {rg}, subscription {sub}.

Show Azure Stack Edge device {device}'s properties.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName} Create or update a Data Box Edge resource · Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I create a new Azure Stack Edge resource in a region?”

“Can I choose the SKU when creating a Data Box Gateway resource?”

Tell an agent

Create Data Box Edge device {device} in {location} under group {rg}, subscription {sub}.

Create Azure Stack Edge resource {device} with SKU {sku}.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName} Delete a Data Box Edge device · Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I delete an Azure Stack Edge resource I no longer use?”

“Can I remove a Data Box Gateway device from my subscription?”

Tell an agent destructive · confirm first

Delete Data Box Edge device {device} in group {rg}, subscription {sub}.

Remove Azure Stack Edge device {device}.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName} Modify a Data Box Edge resource · Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Can I change the tags on an existing Azure Stack Edge device?”

“How do I modify a Data Box Gateway resource's identity or properties?”

Tell an agent

Update tags on Data Box Edge device {device} in group {rg}, subscription {sub} to {tags}.

Patch Azure Stack Edge device {device} with properties {properties}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates Download updates to a Data Box Edge device · Microsoft Azure Downloads The Updates On A Data Box Edge Data Box Gateway Device #

Ask an LLM

“How do I start downloading pending updates onto my Azure Stack Edge device?”

“Can I pre-download Data Box Gateway updates before installing them?”

Tell an agent

Download updates on Data Box Edge device {device} in group {rg}, subscription {sub}.

Start the update download for Azure Stack Edge {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate Generate an activation key certificate · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I generate the certificate for a Data Box Edge activation key?”

“Where do I get the activation certificate for an Azure Stack Edge device?”

Tell an agent

Generate the activation key certificate for Data Box Edge device {device} in group {rg}, subscription {sub}.

Create an activation certificate for {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation Get extended info for a Data Box Edge device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“What extended information, like encryption key details, does my Azure Stack Edge device have?”

“How do I fetch additional details about a Data Box Gateway device?”

Tell an agent

Get extended information for Data Box Edge device {device} in group {rg}, subscription {sub}.

Show the additional details of Azure Stack Edge {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates Install updates on a Data Box Edge device · Microsoft Azure Installs The Updates On The Data Box Edge Data Box Gateway… #

Ask an LLM

“How do I install downloaded updates on an Azure Stack Edge device?”

“Can I trigger update installation on a Data Box Gateway remotely?”

Tell an agent

Install updates on Data Box Edge device {device} in group {rg}, subscription {sub}.

Apply the downloaded updates to Azure Stack Edge {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default Get a Data Box Edge device's network settings · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“What network adapters and IP settings does my Azure Stack Edge device use?”

“How do I view the network configuration of a Data Box Gateway?”

Tell an agent

Get network settings of Data Box Edge device {device} in group {rg}, subscription {sub}.

Show the IP configuration of Azure Stack Edge {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates Scan for updates on a Data Box Edge device · Microsoft Azure Scans For Updates On A Data Box Edge Data Box Gateway Device #

Ask an LLM

“How do I check whether new updates are available for my Azure Stack Edge device?”

“Can I make a Data Box Gateway look for updates now?”

Tell an agent

Scan for updates on Data Box Edge device {device} in group {rg}, subscription {sub}.

Check Azure Stack Edge {device} for available updates.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update Update a Data Box Edge device's security settings · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I change the device admin password on an Azure Stack Edge device?”

“Can I update security settings on a Data Box Gateway remotely?”

Tell an agent

Update security settings on Data Box Edge device {device} in group {rg}, subscription {sub} to {properties}.

Reset the admin password on Azure Stack Edge {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation Update extended info on a Data Box Edge device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I point my Azure Stack Edge device at a new client secret store?”

“Can I change the channel integrity key used by a Data Box Edge device?”

Tell an agent

Set the client secret store of Data Box Edge device {device} in group {rg}, subscription {sub} to {store_url}.

Update channel integrity key {key} on Azure Stack Edge {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default Get update summary for a Data Box Edge device · Microsoft Azure Gets Information About The Availability Of Updates Based On The… #

Ask an LLM

“Are there updates available from the last scan of my Azure Stack Edge device?”

“Is an update download or install job running on my Data Box Gateway?”

Tell an agent

Get the update summary of Data Box Edge device {device} in group {rg}, subscription {sub}.

Show pending updates and running update jobs on Azure Stack Edge {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate Upload a Data Box Edge registration certificate · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I upload the registration certificate for an Azure Stack Edge device?”

“What do I send to register a Data Box Gateway with a certificate?”

Tell an agent

Upload registration certificate {certificate} to Data Box Edge device {device} in group {rg}, subscription {sub}.

Register Azure Stack Edge {device} with a certificate.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice Complete initial setup of a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I finish the minimal setup on a new StorSimple device before using it?”

“What settings are needed to configure a StorSimple device for the first time?”

Tell an agent

Configure a StorSimple device under manager {manager} in group {rg}, subscription {sub} with {properties}.

Run first-time setup for a device in StorSimple manager {manager}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices List devices in a StorSimple manager · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which devices are registered to my StorSimple Device Manager?”

“How do I list all StorSimple appliances for a manager?”

Tell an agent

List devices in StorSimple manager {manager} in group {rg}, subscription {sub}.

Show every StorSimple appliance registered to {manager}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName} Get a StorSimple device · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I see the properties and status of one StorSimple device?”

“What model and software version is a StorSimple appliance running?”

Tell an agent

Get StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show StorSimple appliance {device}'s properties.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName} Delete a StorSimple device · Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I remove a deactivated StorSimple device from the manager?”

“Can I delete a StorSimple appliance record?”

Tell an agent destructive · confirm first

Delete StorSimple device {device} from manager {manager} in group {rg}, subscription {sub}.

Remove StorSimple appliance {device}.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName} Update a StorSimple device · Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Can I change the description or settings on a StorSimple device?”

“How do I patch a StorSimple appliance's properties?”

Tell an agent

Patch StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} with {properties}.

Update the properties of StorSimple appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/authorizeForServiceEncryptionKeyRollover Authorize a device for encryption key rollover · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I authorize a StorSimple device to roll over the service data encryption key?”

“Which device should start a service encryption key rollover?”

Tell an agent

Authorize StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} for key rollover.

Allow {device} to roll the service data encryption key.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate Deactivate a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I deactivate a StorSimple device before retiring it?”

“Is deactivating a StorSimple appliance reversible?”

Tell an agent destructive · confirm first

Deactivate StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Deactivate appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/installUpdates Download and install StorSimple updates · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I download and install updates on a StorSimple device in one step?”

“Can I have a StorSimple appliance fetch and apply its updates together?”

Tell an agent

Download and install updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Fetch and apply all updates to appliance {device} in one go.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets List failover sets for a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which volume container sets on a StorSimple device can be failed over together?”

“Are my StorSimple volume containers eligible to participate in a failover?”

Tell an agent

List failover sets of StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show failover eligibility for volume container sets on {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics Get metrics for a StorSimple device · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I pull capacity or throughput metrics for a StorSimple device?”

“Can I filter StorSimple device metrics by name and time range?”

Tell an agent

Get metrics for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} filtered by {filter}.

Show metrics matching {filter} for appliance {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions List metric definitions for a StorSimple device · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which metrics can I query for a StorSimple device?”

“What metric names and units does a StorSimple appliance expose?”

Tell an agent

List metric definitions for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show the available metric names for appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/scanForUpdates Scan for updates on a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I make a StorSimple appliance check for new updates?”

“Can I trigger an update scan on a StorSimple device?”

Tell an agent

Scan for updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Look for new software updates on appliance {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/updateSummary/default Get update summary for a StorSimple device · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“What updates are pending on my StorSimple appliance?”

“When was a StorSimple device last updated?”

Tell an agent

Get the update summary for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show the update status of appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/failover Fail over volume containers to another device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I fail over a set of StorSimple volume containers to a target device?”

“Can I choose which volume containers move during a StorSimple 8000 failover?”

Tell an agent

Fail over volume containers {containers} from {source} to target device {target}.

Move volume containers from source device {source} in manager {manager}, group {rg}, subscription {sub}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets Check failover target eligibility · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which StorSimple devices are eligible targets for failing over given volume containers?”

“Before failover, how do I confirm a target device can accept my volume containers?”

Tell an agent

List eligible failover targets for volume containers {containers} from {source}.

Check failover targets for source device {source} in manager {manager}, group {rg}, subscription {sub}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default Get a StorSimple device's alert settings · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Who receives email alerts from my StorSimple device?”

“Are alert notifications turned on for a StorSimple appliance?”

Tell an agent

Get alert settings for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show the alert email recipients for {device}.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default Set a StorSimple device's alert settings · Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I change which emails get StorSimple device alerts?”

“Can I enable alert notifications on a StorSimple appliance?”

Tell an agent

Set alert settings on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} to {properties}.

Turn on email alerts for appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/download Download updates to a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I download available updates onto a StorSimple device without installing them?”

“Can I stage StorSimple updates for installation later?”

Tell an agent

Download updates to StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Stage the pending updates on appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failover Fail over a StorSimple device · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I fail over a whole StorSimple device to another device?”

“Can I keep the source device or skip validation during a StorSimple failover?”

Tell an agent

Fail over StorSimple device {device} to {target} in manager {manager}, group {rg}, subscription {sub}.

Fail over {device} to {target} and keep the source device.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failoverTargets List devices usable as failover targets · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which StorSimple devices can act as failover targets for a given device?”

“Where can I fail over my StorSimple appliance to?”

Tell an agent

List failover target devices for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show which appliances could take over for {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/install Install downloaded StorSimple updates · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I install updates already downloaded on a StorSimple device?”

“Can I apply staged updates on a StorSimple appliance?”

Tell an agent

Install updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Apply staged updates to appliance {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default Get a StorSimple device's network settings · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“What DNS and network interface settings does my StorSimple device use?”

“How do I review a StorSimple appliance's network configuration?”

Tell an agent

Get network settings of StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show DNS and interface settings on appliance {device}.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/update Update a StorSimple device's security settings · Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“How do I change the remote management or password settings on a StorSimple device?”

“Can I update the security configuration of a StorSimple appliance?”

Tell an agent

Update security settings on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} to {properties}.

Change remote management settings on appliance {device}.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default Get a StorSimple device's time settings · Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… #

Ask an LLM

“Which time zone and NTP servers is my StorSimple device using?”

“How do I check the clock settings on a StorSimple appliance?”

Tell an agent

Get time settings for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.

Show the time zone and NTP servers on {device}.

Microsoft Azure Devices API

Operations 93

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification