Microsoft.Azure.Devices Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AuthenticationMechanism |
Used to specify the authentication mechanism used by a device. |
| AuthenticationMethodFactory |
Creates an instance of an implementation of IAuthenticationMethod based on known authentication parameters. |
| BasicDigitalTwin |
An optional, helper class for deserializing a digital twin. |
| BulkRegistryOperationResult |
Encapsulates the result of a bulk registry operation. |
| ClientCapabilities |
Status of capabilities enabled on the device. |
| ClientTwin |
Properties of a device or module stored on the service. |
| ClientTwinDocument |
Represents twin properties. |
| ClientTwinMetadata |
Metadata for properties in ClientTwinProperties. |
| ClientTwinProperties |
Represents a collection of properties for the twin. |
| ClientTwinPropertyArray |
Represents a property array in a ClientTwinProperties. |
| ClientTwinPropertyValue |
Represents a property value in a ClientTwinProperties. |
| CloudToDeviceMethod |
Parameters to execute a direct method on the device |
| CloudToDeviceMethodResult |
Represents the Device Method Invocation Results. |
| CloudToDeviceMethodScheduledJob |
Contains properties of a cloud-to-device method scheduled job. |
| ComponentMetadata |
An optional, helper class for deserializing a digital twin. The $metadata class on a component of a BasicDigitalTwin. |
| Configuration |
The configuration for IoT hub device and module twins. |
| ConfigurationContent |
Configurations for devices, modules, the module management agent, and Edge hub. |
| ConfigurationInfo |
Details of the configuration. |
| ConfigurationMetrics |
Metrics for device/module configurations. |
| ConfigurationsClient |
Subclient of IotHubServiceClient that handles creating, getting, setting and deleting configurations. |
| Device |
Contains Device properties and their accessors. |
| DeviceJob |
Contains DeviceJob properties and their accessors. |
| DeviceJobError |
Contains DeviceJob Errors information |
| DeviceJobOutcome |
Contains the DeviceJob outcome |
| DeviceJobParameters |
Extend JobParameters with device Ids |
| DeviceJobStatistics |
The job counts, e.g., number of failed/succeeded devices. |
| DeviceRegistryOperationError |
Encapsulates device registry operation error details. |
| DevicesClient |
Subclient of IotHubServiceClient that handles all device registry operations including getting/creating/setting/deleting device identities, getting modules on a device, and getting device registry statistics. |
| DigitalTwinClient |
This client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device. |
| DigitalTwinCommandResponse |
Represents the device command invocation results. |
| DigitalTwinGetHeaders |
Defines headers for GetAsync operation. |
| DigitalTwinGetResponse<T> |
The service response to a get digital twin request. |
| DigitalTwinInvokeCommandHeaders |
Defines headers for InvokeCommandAsync and InvokeComponentCommandAsync operation. |
| DigitalTwinInvokeCommandRequestOptions |
General request options that are applicable, but optional, for invoke command APIs. |
| DigitalTwinMetadata |
An optional, helper class for deserializing a digital twin. The $metadata class on a BasicDigitalTwin. |
| DigitalTwinsClient |
This client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device. |
| DigitalTwinUpdateHeaders |
Defines headers for UpdateAsync operation. |
| DigitalTwinUpdateRequestOptions |
General request options that are applicable, but optional, for update APIs. |
| DigitalTwinUpdateResponse |
The service response to a digital twin update operation. |
| DirectMethodClientResponse |
The device/module's response to a direct method invocation. |
| DirectMethodsClient |
Subclient of IotHubServiceClient to invoke direct methods on devices and modules in IoT hub. |
| DirectMethodServiceRequest |
Parameters to execute a direct method on a device or module. |
| ErrorContext |
The context for a given connection loss event for MessageFeedbackProcessorClient, FileUploadNotificationProcessorClient, and MessagesClient. |
| ExportImportDevice |
Contains device properties specified during export/import job operation. |
| ExportImportDevice.PropertyContainer |
The desired and reported properties of the twin. |
| ExportImportRequest |
Used to provide storage parameters when making an export or import request. |
| ExportJobProperties |
Contains properties of an export job. |
| FeedbackBatch |
Contains a batch of feedback records. |
| FeedbackReceiver<T> |
Contains methods that services can use to perform feedback receive operations. |
| FeedbackRecord |
Contains properties of an individual feedback record. |
| FileNotification |
Contains properties for file upload notifications |
| FileNotificationReceiver<T> |
Contains methods that services can use to perform file notification receive operations. |
| FileUploadNotification |
Contains properties for file upload notifications. |
| FileUploadNotificationProcessorClient |
Subclient of IotHubServiceClient for receiving file upload notifications. |
| HttpTransportSettings |
Contains Http1 transport-specific settings for Service Client |
| ImportConfiguration |
A class for creating and serializing a configuration for a bulk import job using Microsoft.Azure.Devices.DevicesClient.CreateJobAsync``1(Microsoft.Azure.Devices.JobProperties,System.Threading.CancellationToken). |
| ImportJobProperties |
Contains properties of an import job. |
| InvokeDigitalTwinCommandOptions |
General request options that are applicable, but optional, for invoke command operations. |
| InvokeDigitalTwinCommandResponse |
Represents the device command invocation results. |
| IotHubConnectionStringBuilder |
Builds a connection string for the IoT hub service based on the properties populated by the user. |
| IotHubJobResponse |
Contains the properties set by the service import/export job. |
| IotHubScheduledJobResponse |
Contains properties set by the service for scheduled job. |
| IotHubServiceClient |
The client for making service requests to IoT hub. This client contains subclients for the various feature sets within IoT hub including managing device/module identities, getting/setting twin for device/modules, invoking direct methods on devices/modules, and more. |
| IotHubServiceClientOptions |
The configurable options for IotHubServiceClient instances. |
| IotHubServiceException |
The exception thrown when the client receives an error while communicating with IoT hub service. |
| IotHubServiceExponentialBackoffRetryPolicy |
Represents a retry policy that performs a specified number of retries, using a exponential back-off scheme, with option jitter, to determine the interval between retries. |
| IotHubServiceFixedDelayRetryPolicy |
Represents a retry policy that performs a specified number of retries, using a fixed retry delay with jitter. |
| IotHubServiceIncrementalDelayRetryPolicy |
Represents a retry policy that performs a specified number of retries, using an incrementally increasing retry delay with jitter. |
| IotHubServiceNoRetry |
Represents a retry policy that performs no retries. |
| IotHubServiceRetryPolicyBase |
A base retry policy. |
| JobClient |
Job management. |
| JobParameters |
Input specific to a job used in JobRequest |
| JobProperties |
Contains the properties available for import/export job. |
| JobQueryOptions |
Specifies the options associated with job queries. |
| JobRequest |
Job input |
| JobResponse |
Provides current job report when fetched |
| ManagedIdentity |
The managed identity used to access the storage account for IoT hub import and export jobs. For more information on managed identity configuration on IoT hub, see https://docs.microsoft.com/azure/iot-hub/iot-hub-managed-identity. For more information on managed identities, see https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview |
| Message |
The data structure represent the message that is used for interacting with IoT hub. |
| MessageFeedbackProcessorClient |
Subclient of IotHubServiceClient for receiving cloud-to-device message feedback. |
| MessagesClient |
Subclient of IotHubServiceClient for sending cloud-to-device and cloud-to-module messages. |
| MessageSystemPropertyNames |
The names of the system properties in the Message class. |
| Module |
Contains IoTHub Module properties and their accessors. |
| ModulesClient |
Subclient of IotHubServiceClient that handles all module registry operations including getting/creating/setting/deleting module identities. |
| PurgeMessageQueueResult |
Result of a device message queue purge operation. |
| QueryClient |
Subclient of IotHubServiceClient for executing queries using a SQL-like syntax. |
| QueryOptions |
Specifies the options associated with queries. |
| QueryResponse<T> |
An iterable set of queried items. |
| Receiver<T> |
Contains methods that services can use to perform receive operations. |
| RegistryManager |
Contains methods that services can use to perform create, remove, update and delete operations on devices. |
| RegistryStatistics |
The device registry statistics that can be retrieved from IoT hub. |
| ScheduledJob |
Provides current job report when fetched. |
| ScheduledJobsClient |
Subclient of IotHubServiceClient for Scheduled jobs management. |
| ScheduledJobsOptions |
Contains optional fields when creating a job. |
| ServiceAuthenticationWithDeviceSharedAccessPolicyKey |
Authentication method that uses a device's shared access key to authenticate with service. |
| ServiceAuthenticationWithDeviceSharedAccessPolicyToken |
Authentication method that uses a device's shared access signature to authenticate with service. |
| ServiceAuthenticationWithSharedAccessPolicyKey |
Authentication method that uses a shared access policy key. |
| ServiceAuthenticationWithSharedAccessPolicyToken |
Authentication method that uses a shared access policy token. |
| ServiceClient |
Contains methods that services can use to send messages to devices. |
| ServiceClientOptions |
Options that allow configuration of the service client instance during initialization. |
| ServiceClientTransportSettings |
The transport settings configurable on a service client instance. |
| ServiceStatistics |
Contains service statistics that can be retrieved from IoT hub. |
| SharedAccessSignatureBuilder |
Builds Shared Access Signature (SAS) tokens. |
| SymmetricKey |
Primary and secondary symmetric keys of a device or module. |
| TwinScheduledJob |
Contains properties of twin scheduled job. |
| TwinsClient |
Subclient of IotHubServiceClient that handles getting, updating, and replacing device and module twins. |
| UpdateDigitalTwinOptions |
General request options that are applicable, but optional, for update digital twin operations. |
| WritableProperty |
An optional, helper class for deserializing a digital twin. |
| X509Thumbprint |
X509 client certificate thumbprints of the device. |
| X509ThumbprintExtensions |
X509 client certificate thumbprints of the device |
Interfaces
| IAuthenticationMethod |
Authentication interface to use for IoT hub communications. |
| IIotHubServiceRetryPolicy |
Represents a retry policy for the IoT hub service client. |
| IQuery |
This wraps underlying paged query result access logic. |
Enums
| AcknowledgementType |
The possible acknowledgement types for a received file upload notification and/or for a received cloud-to-device feedback message. |
| AuthenticationType |
Used to specify the authentication type used by a device. |
| ClientAuthenticationType |
Used to specify the authentication type used by a device. |
| ClientConnectionState |
Specifies the different connection states of a device or module. |
| ClientStatus |
Specifies the different states of a device. |
| ConfigurationImportMode |
Identifies the behavior when merging a configuration to the registry during import actions. |
| ConfigurationStatus |
Specifies the configuration status. |
| DeliveryAcknowledgement |
Specifies the different acknowledgement levels for message delivery. |
| DeviceConnectionState |
Specifies the different connection states of a device. |
| DeviceJobStatus |
DeviceJob Status enumeration |
| DeviceJobType |
DeviceJob type |
| DeviceStatus |
Specifies the different states of a device. |
| EndpointKind |
Endpoints exposed by IoT hub |
| FeedbackStatusCode |
Specifies the various feedback status codes for a cloud-to-device message sent to a device. |
| ImportMode |
Identifies the behavior when merging a device to the registry during import actions. |
| IotHubServiceErrorCode |
Error codes for common IoT hub response errors. |
| IotHubTransportProtocol |
Transport protocol types supported by MessagingClient, FileUploadNotificationProcessorClient and MessageFeedbackProcessorClient. |
| JobStatus |
Specifies the various job status for a job. |
| JobType |
Used to specify the type of job. |
| SdkAssignsMessageId |
The different configurations available for setting a value of MessageId on an IoT hub message. |
| StorageAuthenticationType |
Specifies authentication type being used for connecting to storage account. |
| TransportType |
Transport types supported by ServiceClient - Amqp and Amqp over WebSocket only |
