Service

Operations

Apply Configuration On Edge Device

Applies the provided configuration content to the specified edge device.
Applies the provided configuration content to the specified edge device. Configuration content must have modules content

Bulk Create Or Update Devices

Create, update, or delete the identities of multiple devices from the IoT hub identity registry.
Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

Cancel Import Export Job

Cancels an import or export job in an IoT hub.
Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

Cancel Job

Cancels a scheduled job on an IoT hub.
Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

Create Import Export Job

Create a new import/export job on an IoT hub.
Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

Create Job

Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time.
Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

Create Or Update Configuration

Create or update the configuration for devices or modules of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that configuration Id and Content cannot be updated by the user.

Create Or Update Device

Create or update the identity of a device in the identity registry of an IoT hub.
Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user.

Create Or Update Module

Create or update the module identity for device in IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that moduleId and generation cannot be updated by the user.

Delete Configuration

Delete the configuration for devices or modules of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).

Delete Device

Delete the identity of a device from the identity registry of an IoT hub.
Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).

Delete Module

Delete the module identity for device of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).

Get Configuration

Retrieve a configuration for Iot Hub devices and modules by it identifier.

Get Configurations

Get multiple configurations for devices or modules of an IoT Hub. Returns the specified number of configurations for Iot Hub. Pagination is not supported.

Get Device

Retrieve a device from the identity registry of an IoT hub.

Get Device Registry Statistics

Retrieves statistics about device identities in the IoT hub’s identity registry.

Get Devices

Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query language to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information.

Get Import Export Job

Gets the status of an import or export job in an iot hub
Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

Get Import Export Jobs

Gets the status of all import/export jobs in an iot hub
Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

Get Job

Retrieves details of a scheduled job from an IoT hub.
Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

Get Module

Retrieve the specified module identity on the device.

Get Modules On Device

Retrieve all the module identities on the device.

Get Module Twin

Gets a module twin.
Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.

Get Service Statistics

Retrieves service statistics for this IoT hub’s identity registry.

Get Twin

Gets a device twin.
Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.

Invoke Device Method

Invoke a direct method on a device.
Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information.

Invoke Device Module Method

Invoke a direct method on a module of a device.
Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information

Purge Command Queue

Deletes all the pending commands for this device from the IoT hub.
Deletes all the pending commands for this device from the IoT hub

Query Iot Hub

Query an IoT hub to retrieve information regarding device twins using a SQL-like language.
Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only.

Query Jobs

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language
Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only.

Replace Module Twin

Replaces tags and desired properties of a module twin.
Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.

Replace Twin

Replaces tags and desired properties of a device twin.
Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.

Send Device Command

Applies the provided configuration content to the specified edge device.
Applies the provided configuration content to the specified edge device. Configuration content must have modules content

Test Configuration Queries

Validates the target condition query and custom metric queries for a configuration.

Update Module Twin

Updates tags and desired properties of a module twin.
Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.

Update Twin

Updates tags and desired properties of a device twin.
Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.