Microsoft Azure Devices API
The Devices API from Microsoft Azure — 61 operation(s) for devices.
Microsoft Azure Devices API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes 93 operations across 61 paths, and defines 128 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
93 operations
61 paths
128 schemas
7 DELETE39 GET11 PATCH26 POST10 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 93
Across 61 paths, the API surfaces 93 operations — 7 DELETE, 39 GET, 11 PATCH, 26 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.
Devices 93
GET
/sensor-partners/{sensorPartnerId}/devices
Microsoft Azure Get Sensor Partners Sensorpartnerid Devices
PATCH
/sensor-partners/{sensorPartnerId}/devices/{deviceId}
Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid
GET
/sensor-partners/{sensorPartnerId}/devices/{deviceId}
Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid
DELETE
/sensor-partners/{sensorPartnerId}/devices/{deviceId}
Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid
GET
/devices
Microsoft Azure Get The List Of Devices In An Application With Basic Odata Support Maxpagesize, Filter, Orderby , [more Details] Https: Aka Ms Iotcentralodatasupport
GET
/devices/{deviceId}
Microsoft Azure Get A Device By Id
PUT
/devices/{deviceId}
Microsoft Azure Create Or Update A Device
PATCH
/devices/{deviceId}
Microsoft Azure Update A Device Via Patch
DELETE
/devices/{deviceId}
Microsoft Azure Delete A Device
POST
/devices/{deviceId}/applyDeploymentManifest
Microsoft Azure Apply A Deployment Manifest To An Edge Device
GET
/devices/{deviceId}/attestation
Microsoft Azure Get Device Attestation
PUT
/devices/{deviceId}/attestation
Microsoft Azure Create An Individual Device Attestation
PATCH
/devices/{deviceId}/attestation
Microsoft Azure Update An Individual Device Attestation Via Patch
DELETE
/devices/{deviceId}/attestation
Microsoft Azure Remove An Individual Device Attestation
GET
/devices/{deviceId}/commands/{commandName}
Microsoft Azure Get Device Command History
POST
/devices/{deviceId}/commands/{commandName}
Microsoft Azure Run A Device Command
GET
/devices/{deviceId}/components
Microsoft Azure List The Components Present In A Device
GET
/devices/{deviceId}/components/{componentName}/commands/{commandName}
Microsoft Azure Get Component Command History
POST
/devices/{deviceId}/components/{componentName}/commands/{commandName}
Microsoft Azure Run A Component Command
GET
/devices/{deviceId}/components/{componentName}/properties
Microsoft Azure Get Device Properties For A Specific Component
PUT
/devices/{deviceId}/components/{componentName}/properties
Microsoft Azure Replace Device Properties For A Specific Component
PATCH
/devices/{deviceId}/components/{componentName}/properties
Microsoft Azure Update Device Properties For A Specific Component Via Patch
GET
/devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}
Microsoft Azure Get Component Telemetry Value
GET
/devices/{deviceId}/credentials
Microsoft Azure Get Device Credentials
GET
/devices/{deviceId}/modules
Microsoft Azure List The Modules Present In A Device
GET
/devices/{deviceId}/modules/{moduleName}/commands/{commandName}
Microsoft Azure Get Module Command History
POST
/devices/{deviceId}/modules/{moduleName}/commands/{commandName}
Microsoft Azure Run A Module Command
GET
/devices/{deviceId}/modules/{moduleName}/components
Microsoft Azure List The Components Present In A Module
GET
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
Microsoft Azure Get Module Component Command History
POST
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
Microsoft Azure Run A Module Component Command
GET
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
Microsoft Azure Get Module Properties For A Specific Component
PUT
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
Microsoft Azure Replace Module Properties For A Specific Component
PATCH
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
Microsoft Azure Update Module Properties For A Specific Component Via Patch
GET
/devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName}
Microsoft Azure Get Module Component Telemetry Value
GET
/devices/{deviceId}/modules/{moduleName}/properties
Microsoft Azure Get Module Properties
PUT
/devices/{deviceId}/modules/{moduleName}/properties
Microsoft Azure Replace Module Properties
PATCH
/devices/{deviceId}/modules/{moduleName}/properties
Microsoft Azure Update Module Properties Via Patch
GET
/devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName}
Microsoft Azure Get Module Telemetry Value
GET
/devices/{deviceId}/properties
Microsoft Azure Get Device Properties
PUT
/devices/{deviceId}/properties
Microsoft Azure Replace Device Properties
PATCH
/devices/{deviceId}/properties
Microsoft Azure Update Device Properties Via Patch
GET
/devices/{deviceId}/relationships
Microsoft Azure Given The Id For An Upstream Device, Will Return The Upstream And The Downstream Relationships Associated With That Gateway These Downstream Relationships Are Only Those Associated Wi…
GET
/devices/{deviceId}/relationships/{relationshipId}
Microsoft Azure Given The Id For A Device And A Relationship Id Associated With This Device, Get The Details Of The Relationship
PUT
/devices/{deviceId}/relationships/{relationshipId}
Microsoft Azure Given The Id For A Device And A Relationship Id Associated With This Device, Create A New Relationship For Between The Given Device And A Second Device Specified In The Body
PATCH
/devices/{deviceId}/relationships/{relationshipId}
Microsoft Azure Patch A Given Relationship Given The Relationship Id And A Given Device Id
DELETE
/devices/{deviceId}/relationships/{relationshipId}
Microsoft Azure Given The Id For A Device And An Associated Relationship Id, Delete The Relationship The Given Device Id Can Be That Of The Upstream Or Downstream Device
GET
/devices/{deviceId}/telemetry/{telemetryName}
Microsoft Azure Get Device Telemetry Value
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename Generateca…
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databoxedge Databoxedgedevices
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates
Microsoft Azure Downloads The Updates On A Data Box Edge Data Box Gateway Device
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Generatecertificate
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Getextendedinformation
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates
Microsoft Azure Installs The Updates On The Data Box Edge Data Box Gateway Device
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Networksettings Default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates
Microsoft Azure Scans For Updates On A Data Box Edge Data Box Gateway Device
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Securitysettings Default Update
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Updateextendedinformation
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default
Microsoft Azure Gets Information About The Availability Of Updates Based On The Last Scan Of The Device It Also Gets Information About Any Ongoing Download Or Install Jobs On The Device
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Uploadcertificate
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Configuredevice
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/authorizeForServiceEncryptionKeyRollover
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Authorizeforserviceencryptionkeyrollover
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Deactivate
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/installUpdates
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Installupdates
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Listfailoversets
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metrics
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metricsdefinitions
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/scanForUpdates
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Scanforupdates
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/updateSummary/default
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Updatesummary Default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/failover
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Failover
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Listfailovertargets
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/download
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Download
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failover
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failover
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failoverTargets
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failovertargets
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/install
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Install
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Networksettings Default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/update
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default Update
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Timesettings Default
Schemas 128
The contract defines 128 schemas that model the data the API accepts and returns. The most detailed are DeviceProperties_3 (27 properties), UpdateSummaryProperties (25 properties), DataBoxEdgeDeviceProperties (20 properties), Device (18 properties). Each schema is shown below with its type and property counts.
UploadCertificateResponse
object
The upload registration certificate response.
8 properties
Message
object
2 properties
DeviceProperties_4
object
Encases all the properties of the Device
13 properties
DevicePatchProperties
object
The properties of the device patch.
1 property
Collection
object
The collection of entities.
2 properties
1 required
SecuritySettingsProperties
object
The properties of security settings.
1 property
1 required
EdgeProfileSubscription
object
Subscription details for the Edge Profile
6 properties
Device
object
Device API model.
18 properties
InnerError
object
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.mdinnererror--object for InnerError reference docum…
2 properties
NetworkSettingsProperties_2
object
The properties of NetworkSettings
3 properties
2 required
Secret
object
Holds device secret either as a KeyVault reference or as an encrypted value.
2 properties
ARMBaseModel
object
Represents the base class for all object models.
3 properties
AsymmetricEncryptedSecret
object
Represent the secrets intended for encryption with asymmetric key pair.
3 properties
2 required
ComputeVersionInformation
object
This contains the compute information
3 properties
EdgeProfileSubscriptionPatch
object
The Data Box Edge/Gateway Edge Profile Subscription patch.
1 property
ErrorDetails
object
The detail information of the error.
4 properties
2 required
NetworkAdapter_2
object
Represents a networkAdapter in a particular node.
5 properties
2 required
DeploymentManifest
object
The deployment manifest used for edge devices.
5 properties
1 required
SecuritySettings
object
The security settings of a device.
1 property
1 required
DataBoxEdgeDeviceExtendedInfoProperties
object
The properties of the Data Box Edge/Gateway device extended info.
15 properties
Location
object
Location model class.
2 properties
2 required
DeviceListResponse
object
Paged response contains list of requested objects and a URL link to get the next set of results.
3 properties
1 required
DeviceProperties_2
object
The properties of device
7 properties
CloudError
object
An error response from the service.
1 property
DeviceProperties
object
Property values associated with the device.
FailoverSetEligibilityResult
object
The eligibility result of failover set, for failover.
2 properties
ResourceIdentity
object
Msi identity details of the resource
3 properties
UpdatesProperties
object
The properties of the updates profile.
4 properties
TargetEligibilityErrorMessage
object
The error/warning message due to which the device is ineligible as a failover target device.
3 properties
VolumeFailoverMetadata
object
The metadata of a volume that has valid cloud snapshot.
7 properties
Device_2
object
The device definition.
10 properties
DeviceRelationshipCollection
object
The paged results of device relationships.
2 properties
1 required
TimeSettingsProperties
object
The properties of TimeSettings
3 properties
2 required
Attestation
object
The attestation definition.
1 property
1 required
SecuritySettings_2
object
The SecuritySettings of a device
1 property
1 required
SubscriptionProperties
object
5 properties
GenerateCertResponse
object
Used in activation key generation flow.
3 properties
BaseModel_2
object
Base class for models
3 properties
DeviceCommand
object
The device command definition.
6 properties
NetworkSettings
object
The network settings of a device.
2 properties
SecondaryDNSSettings
object
The secondary DNS settings.
1 property
BaseModel
object
Represents the base class for all other ARM object models
4 properties
FailoverSetsList
object
The list of failover sets.
1 property
DeviceUpdateProperties
object
The updatable properties of the Device.
1 property
UpdateSummaryProperties
object
The device update information summary.
25 properties
X509
object
The X509 definition.
1 property
NetworkInterfaceData0Settings
object
The 'Data 0' network interface card settings.
2 properties
MetricData
object
The metric data.
6 properties
DataBoxEdgeDeviceProperties
object
The properties of the Data Box Edge/Gateway device.
20 properties
ConfigureDeviceRequest
object
The mandatory device configuration request.
1 property
1 required
FailoverTargetsList
object
The list of all devices in a resource and their eligibility status as a failover target device.
1 property
MetricDefinitionList
object
The list of metric definitions.
1 property
DeviceRolloverDetails
object
The additional device details for the service data encryption key rollover.
3 properties
MetricList
object
The metric list.
1 property
Error_2
object
The response error definition.
1 property
1 required
SymmetricKey
object
The symmetric key definition.
2 properties
2 required
ListFailoverTargetsRequest
object
The request object for fetching the list of failover targets (eligible devices for failover).
1 property
Ipv6Config
object
Details related to the IPv6 address configuration.
3 properties
NodeNetwork
object
Represents a single node in a device.
1 property
1 required
Error
object
An error from the Azure AgPlatform service.
5 properties
2 required
UploadCertificateRequest
object
The upload certificate request.
1 property
1 required
DeviceDetails
object
The additional device details regarding the end point count and volume container count.
2 properties
EdgeProfile
object
Details about Edge Profile for the resource
1 property
NetworkSettings_2
object
The NetworkSettings of a device
1 property
1 required
X509Certificate
object
The X509 certificate definition.
2 properties
UpdateSummary
object
Details about ongoing updates and availability of updates on the device.
2 properties
DataResidency
object
Wraps data-residency related information for edge-resource and this should be used with ARM layer.
1 property
MetricDefinition
object
The monitoring metric definition.
8 properties
ResourceMoveDetails
object
Fields for tracking resource move
2 properties
DataBoxEdgeDeviceList
object
The collection of Data Box Edge/Gateway devices.
2 properties
DataBoxEdgeDeviceExtendedInfo
object
The extended Info of the Data Box Edge/Gateway device.
2 properties
FailoverRequest_2
object
The Failover request object.
4 properties
TimeSettings
object
The TimeSettings of a device
1 property
1 required
NetworkSettingsProperties
object
The properties of network settings.
1 property
FailoverRequest
object
The request object for triggering a failover of volume containers, from a source device to a target device.
2 properties
SignedCapabilityImageResponse
object
Signed device capability image response
1 property
Device_4
object
The StorSimple device.
1 property
1 required
ConfigureDeviceRequestProperties
object
The properties of the configure device request.
5 properties
3 required
EdgeProfilePatch
object
The Data Box Edge/Gateway Edge Profile patch.
1 property
Item
object
2 properties
2 required
VolumeContainerFailoverMetadata
object
The metadata of the volume container, that is being considered as part of a failover set.
2 properties
AlertSettingsProperties
object
Class containing the properties of AlertSettings
4 properties
3 required
NetworkAdapterPosition
object
The network adapter position.
2 properties
UpdateDetails
object
Update Specific attributes
9 properties
DeviceList_2
object
Collection of Devices
1 property
1 required
ProvisioningState
string
Provisioning state of resource.
DeviceCommandCollection
object
The paged results of device command executions.
2 properties
1 required
Tpm
object
The trusted platform module definition.
1 property
1 required
CapabilityType
string
Capability image type
MetricName
object
The metric name.
2 properties
GenerateCapabilityImageRequest
object
Request of the action to create a signed device capability image
1 property
1 required
DeviceCollection
object
The paged results of devices.
2 properties
1 required
DeviceDetails_2
object
Class containing more granular details about the device
10 properties
DeviceTelemetry
object
The device telemetry definition.
2 properties
Device_3
object
An device resource belonging to a device group resource.
1 property
IPConfig
object
Details related to the IP address configuration
3 properties
2 required
AlertSettings
object
AlertSettings on the device which represents how alerts will be processed
1 property
1 required
TargetEligibilityResult
object
The eligibility result of device, as a failover target device.
2 properties
FailoverTarget
object
Represents the eligibility of a device as a failover target device.
11 properties
DevicePatch
object
The device patch.
1 property
1 required
Ipv4Config
object
Details related to the IPv4 address configuration.
3 properties
DataBoxEdgeDeviceExtendedInfoPatch
object
The Data Box Edge/Gateway device extended info patch.
5 properties
SubscriptionRegisteredFeatures
object
2 properties
X509Certificates
object
The X509 certificates definition.
2 properties
1 required
MetricAvailablity
object
The metric availability.
2 properties
DeviceListResult
object
The response of a Device list operation.
2 properties
1 required
X509CertificateInfo
object
The X509 certificate info.
1 property
1 required
DataBoxEdgeDevicePropertiesPatch
object
The Data Box Edge/Gateway device properties patch.
1 property
Sku
object
The SKU type.
2 properties
Device_5
object
Represents a StorSimple device object along with its properties
1 property
DeviceUpdate
object
The type used for update operations of the Device.
1 property
FailoverSet
object
The failover set on a device.
2 properties
Error_3
object
3 properties
2 required
Metrics
object
The monitoring metric.
10 properties
SecuritySettingsProperties_2
object
The properties of SecuritySettings
1 property
1 required
CloudErrorBody
object
An error response from the service.
3 properties
NetworkAdapter
object
Represents the networkAdapter on a device.
15 properties
DeviceCredentials
object
The device credentials definition.
4 properties
1 required
ErrorResponse
object
An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses for…
2 properties
DataBoxEdgeDevicePatch
object
The Data Box Edge/Gateway device patch.
3 properties
DeviceList
object
The collection of devices.
1 property
1 required
MetricDimension
object
The metric dimension. It indicates the source of the metric.
2 properties
DeviceProperties_3
object
The properties of the StorSimple device.
27 properties
13 required
DataBoxEdgeDevice
object
The Data Box Edge/Gateway device.
8 properties
1 required
RawCertificateData
object
Raw Certificate Data.
2 properties
1 required
Updates
object
The updates profile of a device.
1 property
1 required
DeviceRelationship
object
An object representing the relationship between an upstream and a downstream device.
3 properties
AsymmetricEncryptedSecret_2
object
This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret…
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure 12
Other APIs Microsoft Azure publishes across the network.
Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
#Devices
Where this information came from
This is an independent, third-party profile of Microsoft Azure Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.