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.
Contains classes and interfaces that support creating and using devices.
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. |
BulkRegistryOperationResult |
Encapsulates the result of a bulk registry operation. |
CloudToDeviceMethod |
Parameters to execute a direct method on the device |
CloudToDeviceMethodResult |
Represents the Device Method Invocation Results. |
Configuration |
Azure IoT Edge Configurations. |
ConfigurationContent |
Configurations for Module Management Agent, Edge Hub and Modules on the device. |
ConfigurationMetrics |
Azure IOT Configuration Metrics |
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. |
DigitalTwinClient |
The Digital Twins Service Client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device. For more information, see https://github.com/Azure/azure-iot-sdk-csharp#iot-hub-service-sdk |
DigitalTwinClientOptions |
Options that allow configuration of the DigitalTwinClient instance during initialization. |
DigitalTwinCommandResponse |
Represents the device command invocation results. |
DigitalTwinGetHeaders |
Defines headers for GetAsync operation. |
DigitalTwinInvokeCommandHeaders |
Defines headers for InvokeCommandAsync and InvokeComponentCommandAsync operation. |
DigitalTwinInvokeCommandRequestOptions |
General request options that are applicable, but optional, for invoke command APIs. |
DigitalTwinUpdateHeaders |
Defines headers for UpdateAsync operation. |
DigitalTwinUpdateRequestOptions |
General request options that are applicable, but optional, for update APIs. |
ExportImportDevice |
contains device properties specified during export/import operation |
ExportImportDevice.PropertyContainer | |
ExportImportRequest |
Used to provide storage parameters when making an export or import request. |
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. |
HttpTransportSettings |
Contains Http1 transport-specific settings for Service Client |
IotHubAuthenticationScopes |
This class contains the most commonly used Azure Active Directory token audience scopes. They should be used as inputs when setting the authentication scopes in the client options classes. |
IotHubConnectionStringBuilder |
Builds a connection string for the IoT Hub service based on the properties populated by the user. |
JobClient |
Job management |
JobClientOptions |
Options that allow configuration of the JobClient instance during initialization. |
JobParameters |
Input specific to a job used in JobRequest |
JobProperties |
Contains properties of a Job. |
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/en-us/azure/iot-hub/iot-hub-managed-identity. For more information on managed identities, see https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview |
Message |
The data structure represent the message that is used for interacting with IotHub. |
MessageSystemPropertyNames |
The names of the system properties in the Message class. |
Module |
Contains IoTHub Module properties and their accessors. |
PurgeMessageQueueResult |
Result of a device message queue purge operation. |
QueryOptions |
Specifies the options associated with queries |
QueryResponse<T> |
Represents the template class for the results of an IQuery request |
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. |
RegistryManagerOptions |
Options that allow configuration of the RegistryManager instance during initialization. |
RegistryStatistics |
Contains device registry statistics that can be retrieved from IotHub. |
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 IotHub. |
SymmetricKey |
primary and secondary symmetric keys of a device. |
X509Thumbprint |
X509 client certificate thumbprints of the device |
X509ThumbprintExtensions |
X509 client certificate thumbprints of the device |
Interfaces
IAuthenticationMethod |
Authentication interface to use for IoTHub communications. |
IQuery |
Enums
AuthenticationType |
Used to specify the authentication type used by a device. |
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 command sent to a device. |
ImportMode |
Identifies the behavior when merging a device to the registry during import actions. |
JobStatus |
Specifies the various job status for a job. |
JobType |
Used to delineate job actions. |
StorageAuthenticationType |
Specifies authentication type being used for connecting to storage account. |
TransportType |
Transport types supported by ServiceClient - Amqp and Amqp over WebSocket only |