RegistryManager Class
Definition
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 methods that services can use to perform create, remove, update and delete operations on devices.
public class RegistryManager : IDisposabletype RegistryManager = class
interface IDisposablePublic Class RegistryManager
Implements IDisposable- Inheritance
-
RegistryManager
- Implements
Remarks
For more information, see https://github.com/Azure/azure-iot-sdk-csharp#iot-hub-service-sdk.
This client creates lifetime long instances of HttpClient that are tied to the URI of the IoT hub specified, configure any proxy settings, and connection lease timeout. For that reason, the instances are not static and an application using this client should create and save it for all use. Repeated creation may cause socket exhaustion.
Constructors
| RegistryManager() |
Creates an instance of RegistryManager, provided for unit testing purposes only. |
Methods
| AddConfigurationAsync(Configuration, CancellationToken) |
Register a new Configuration for Azure IoT Edge in IoT hub |
| AddConfigurationAsync(Configuration) |
Register a new Configuration for Azure IoT Edge in IoT hub |
| AddDeviceAsync(Device, CancellationToken) |
Register a new device with the system |
| AddDeviceAsync(Device) |
Register a new device with the system |
| AddDevices2Async(IEnumerable<Device>, CancellationToken) |
Register a list of new devices with the system |
| AddDevices2Async(IEnumerable<Device>) |
Register a list of new devices with the system |
| AddDevicesAsync(IEnumerable<Device>, CancellationToken) |
Obsolete.
Register a list of new devices with the system |
| AddDevicesAsync(IEnumerable<Device>) |
Obsolete.
Register a list of new devices with the system |
| AddDeviceWithTwinAsync(Device, Twin, CancellationToken) |
Adds a Device with Twin information |
| AddDeviceWithTwinAsync(Device, Twin) |
Adds a Device with Twin information |
| AddModuleAsync(Module, CancellationToken) |
Register a new module with device in the system |
| AddModuleAsync(Module) |
Register a new module with device in the system |
| ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent, CancellationToken) |
Applies configuration content to an Edge device. |
| ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent) |
Applies configuration content to an Edge device to create a deployment. |
| CancelJobAsync(String, CancellationToken) |
Cancels/Deletes the job with the specified Id. |
| CancelJobAsync(String) |
Cancels/Deletes the job with the specified Id. |
| CloseAsync() |
Closes the RegistryManager instance and disposes its resources. |
| Create(String, AzureSasCredential, HttpTransportSettings) |
Creates RegistryManager using a shared access signature provided and refreshed as necessary by the caller. |
| Create(String, TokenCredential, HttpTransportSettings) |
Creates RegistryManager, authenticating using an identity in Azure Active Directory (AAD). |
| CreateFromConnectionString(String, HttpTransportSettings) |
Creates an instance of RegistryManager, authenticating using an IoT hub connection string, and specifying HTTP transport settings. |
| CreateFromConnectionString(String) |
Creates RegistryManager from an IoT hub connection string. |
| CreateQuery(String, Nullable<Int32>) |
Retrieves a handle through which a result for a given query can be fetched. |
| CreateQuery(String) |
Retrieves a handle through which a result for a given query can be fetched. |
| Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources. |
| ExportDevicesAsync(JobProperties, CancellationToken) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| ExportDevicesAsync(String, Boolean, CancellationToken) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| ExportDevicesAsync(String, Boolean) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| ExportDevicesAsync(String, String, Boolean, CancellationToken) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| ExportDevicesAsync(String, String, Boolean) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| ExportRegistryAsync(String, String, CancellationToken) |
Copies registered device data to a set of blobs in a specific container in a storage account. |
| ExportRegistryAsync(String, String) |
Copies registered device data to a set of blobs in a specific container in a storage account. |
| GetConfigurationAsync(String, CancellationToken) |
Retrieves the specified Configuration object. |
| GetConfigurationAsync(String) |
Retrieves the specified Configuration object. |
| GetConfigurationsAsync(Int32, CancellationToken) |
Retrieves specified number of configurations from every IoT hub partition. Results are not ordered. |
| GetConfigurationsAsync(Int32) |
Retrieves specified number of configurations from every IoT hub partition. Results are not ordered. |
| GetDeviceAsync(String, CancellationToken) |
Retrieves the specified Device object. |
| GetDeviceAsync(String) |
Retrieves the specified Device object. |
| GetDevicesAsync(Int32, CancellationToken) |
Obsolete.
Retrieves specified number of devices from every IoT hub partition. This is an approximation and not a definitive list. Results are not ordered. |
| GetDevicesAsync(Int32) |
Obsolete.
Retrieves specified number of devices from every IoT hub partition. This is an approximation and not a definitive list. Results are not ordered. |
| GetJobAsync(String, CancellationToken) |
Gets the job with the specified Id. |
| GetJobAsync(String) |
Gets the job with the specified Id. |
| GetJobsAsync() |
List all jobs for the IoT hub. |
| GetJobsAsync(CancellationToken) |
List all jobs for the IoT hub. |
| GetModuleAsync(String, String, CancellationToken) |
Retrieves the specified Module object. |
| GetModuleAsync(String, String) |
Retrieves the specified Module object. |
| GetModulesOnDeviceAsync(String, CancellationToken) |
Retrieves the module identities on device |
| GetModulesOnDeviceAsync(String) |
Retrieves the module identities on device |
| GetRegistryStatisticsAsync() |
Gets usage statistics for the IoT hub. |
| GetRegistryStatisticsAsync(CancellationToken) |
Gets usage statistics for the IoT hub. |
| GetTwinAsync(String, CancellationToken) |
Gets Twin from IotHub |
| GetTwinAsync(String, String, CancellationToken) |
Gets Module's Twin from IotHub |
| GetTwinAsync(String, String) |
Gets Module's Twin from IotHub |
| GetTwinAsync(String) |
Gets Twin from IotHub |
| ImportDevicesAsync(JobProperties, CancellationToken) |
Creates a new bulk job to import device registrations into the IoT hub. |
| ImportDevicesAsync(String, String, CancellationToken) |
Creates a new bulk job to import device registrations into the IoT hub. |
| ImportDevicesAsync(String, String, String, CancellationToken) |
Creates a new bulk job to import device registrations into the IoT hub. |
| ImportDevicesAsync(String, String, String) |
Creates a new bulk job to import device registrations into the IoT hub. |
| ImportDevicesAsync(String, String) |
Creates a new bulk job to import device registrations into the IoT hub. |
| ImportRegistryAsync(String, String, CancellationToken) |
Imports registered device data from a set of blobs in a specific container in a storage account. |
| ImportRegistryAsync(String, String) |
Imports registered device data from a set of blobs in a specific container in a storage account. |
| OpenAsync() |
Explicitly open the RegistryManager instance. |
| RemoveConfigurationAsync(Configuration, CancellationToken) |
Deletes a previously registered device from the system. |
| RemoveConfigurationAsync(Configuration) |
Deletes a previously registered device from the system. |
| RemoveConfigurationAsync(String, CancellationToken) |
Deletes a previously registered device from the system. |
| RemoveConfigurationAsync(String) |
Deletes a previously registered device from the system. |
| RemoveDeviceAsync(Device, CancellationToken) |
Deletes a previously registered device from the system. |
| RemoveDeviceAsync(Device) |
Deletes a previously registered device from the system. |
| RemoveDeviceAsync(String, CancellationToken) |
Deletes a previously registered device from the system. |
| RemoveDeviceAsync(String) |
Deletes a previously registered device from the system. |
| RemoveDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) |
Deletes a list of previously registered devices from the system. |
| RemoveDevices2Async(IEnumerable<Device>) |
Deletes a list of previously registered devices from the system. |
| RemoveDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Obsolete.
Deletes a list of previously registered devices from the system. |
| RemoveDevicesAsync(IEnumerable<Device>) |
Obsolete.
Deletes a list of previously registered devices from the system. |
| RemoveModuleAsync(Module, CancellationToken) |
Deletes a previously registered module from device in the system. |
| RemoveModuleAsync(Module) |
Deletes a previously registered module from device in the system. |
| RemoveModuleAsync(String, String, CancellationToken) |
Deletes a previously registered module from device in the system. |
| RemoveModuleAsync(String, String) |
Deletes a previously registered module from device in the system. |
| ReplaceTwinAsync(String, String, String, CancellationToken) |
Updates the mutable fields of Twin |
| ReplaceTwinAsync(String, String, String, String, CancellationToken) |
Updates the mutable fields of Module's Twin |
| ReplaceTwinAsync(String, String, String, String) |
Updates the mutable fields of Module's Twin |
| ReplaceTwinAsync(String, String, String) |
Updates the mutable fields of Twin |
| ReplaceTwinAsync(String, String, Twin, String, CancellationToken) |
Updates the mutable fields of Module's Twin |
| ReplaceTwinAsync(String, String, Twin, String) |
Updates the mutable fields of Module's Twin |
| ReplaceTwinAsync(String, Twin, String, CancellationToken) |
Updates the mutable fields of Twin |
| ReplaceTwinAsync(String, Twin, String) |
Updates the mutable fields of Twin |
| UpdateConfigurationAsync(Configuration, Boolean, CancellationToken) |
Update the mutable fields of the Configuration registration |
| UpdateConfigurationAsync(Configuration, Boolean) |
Update the mutable fields of the Configuration registration |
| UpdateConfigurationAsync(Configuration, CancellationToken) |
Update the mutable fields of the Configuration registration |
| UpdateConfigurationAsync(Configuration) |
Update the mutable fields of the Configuration registration |
| UpdateDeviceAsync(Device, Boolean, CancellationToken) |
Update the mutable fields of the device registration |
| UpdateDeviceAsync(Device, Boolean) |
Update the mutable fields of the device registration |
| UpdateDeviceAsync(Device, CancellationToken) |
Update the mutable fields of the device registration |
| UpdateDeviceAsync(Device) |
Update the mutable fields of the device registration |
| UpdateDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) |
Update a list of devices with the system |
| UpdateDevices2Async(IEnumerable<Device>) |
Update a list of devices with the system |
| UpdateDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Obsolete.
Update a list of devices with the system |
| UpdateDevicesAsync(IEnumerable<Device>) |
Obsolete.
Update a list of devices with the system |
| UpdateModuleAsync(Module, Boolean, CancellationToken) |
Update the mutable fields of the module registration |
| UpdateModuleAsync(Module, Boolean) |
Update the mutable fields of the module registration |
| UpdateModuleAsync(Module, CancellationToken) |
Update the mutable fields of the module registration |
| UpdateModuleAsync(Module) |
Update the mutable fields of the module registration |
| UpdateTwinAsync(String, String, String, CancellationToken) |
Updates the mutable fields of Twin |
| UpdateTwinAsync(String, String, String, String, CancellationToken) |
Updates the mutable fields of Module's Twin |
| UpdateTwinAsync(String, String, String, String) |
Updates the mutable fields of Module's Twin |
| UpdateTwinAsync(String, String, String) |
Updates the mutable fields of Twin |
| UpdateTwinAsync(String, String, Twin, String, CancellationToken) |
Updates the mutable fields of Module's Twin |
| UpdateTwinAsync(String, String, Twin, String) |
Updates the mutable fields of Module's Twin |
| UpdateTwinAsync(String, Twin, String, CancellationToken) |
Updates the mutable fields of Twin |
| UpdateTwinAsync(String, Twin, String) |
Updates the mutable fields of Twin |
| UpdateTwins2Async(IEnumerable<Twin>, Boolean, CancellationToken) |
Update the mutable fields for a list of Twins previously created within the system |
| UpdateTwins2Async(IEnumerable<Twin>, Boolean) |
Update the mutable fields for a list of Twins previously created within the system |
| UpdateTwins2Async(IEnumerable<Twin>, CancellationToken) |
Update the mutable fields for a list of Twins previously created within the system |
| UpdateTwins2Async(IEnumerable<Twin>) |
Update the mutable fields for a list of Twins previously created within the system |
