RegistryManager RegistryManager RegistryManager Class

Definition

Contains methods that services can use to perform create, remove, update and delete operations on devices.

public abstract class RegistryManager : IDisposable
type RegistryManager = class
    interface IDisposable
Public MustInherit Class RegistryManager
Implements IDisposable
Inheritance
RegistryManagerRegistryManagerRegistryManager
Implements

Constructors

RegistryManager() RegistryManager() RegistryManager()

Methods

AddConfigurationAsync(Configuration) AddConfigurationAsync(Configuration) AddConfigurationAsync(Configuration)

Register a new Configuration for Azure IOT Edge in IotHub

AddConfigurationAsync(Configuration, CancellationToken) AddConfigurationAsync(Configuration, CancellationToken) AddConfigurationAsync(Configuration, CancellationToken)

Register a new Configuration for Azure IOT Edge in IotHub

AddDeviceAsync(Device) AddDeviceAsync(Device) AddDeviceAsync(Device)

Register a new device with the system

AddDeviceAsync(Device, CancellationToken) AddDeviceAsync(Device, CancellationToken) AddDeviceAsync(Device, CancellationToken)

Register a new device with the system

AddDevices2Async(IEnumerable<Device>) AddDevices2Async(IEnumerable<Device>) AddDevices2Async(IEnumerable<Device>)

Register a list of new devices with the system

AddDevices2Async(IEnumerable<Device>, CancellationToken) AddDevices2Async(IEnumerable<Device>, CancellationToken) AddDevices2Async(IEnumerable<Device>, CancellationToken)

Register a list of new devices with the system

AddDevicesAsync(IEnumerable<Device>) AddDevicesAsync(IEnumerable<Device>) AddDevicesAsync(IEnumerable<Device>)

Register a list of new devices with the system

AddDevicesAsync(IEnumerable<Device>, CancellationToken) AddDevicesAsync(IEnumerable<Device>, CancellationToken) AddDevicesAsync(IEnumerable<Device>, CancellationToken)

Register a list of new devices with the system

AddDeviceWithTwinAsync(Device, Twin) AddDeviceWithTwinAsync(Device, Twin) AddDeviceWithTwinAsync(Device, Twin)

Adds a Device with Twin information

AddDeviceWithTwinAsync(Device, Twin, CancellationToken) AddDeviceWithTwinAsync(Device, Twin, CancellationToken) AddDeviceWithTwinAsync(Device, Twin, CancellationToken)

Adds a Device with Twin information

AddModuleAsync(Module, CancellationToken) AddModuleAsync(Module, CancellationToken) AddModuleAsync(Module, CancellationToken)

Register a new module with device in the system

AddModuleAsync(Module) AddModuleAsync(Module) AddModuleAsync(Module)

Register a new module with device in the system

ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent) ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent) ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent)

Applies configuration content to an IoTEdge device.

ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent, CancellationToken) ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent, CancellationToken) ApplyConfigurationContentOnDeviceAsync(String, ConfigurationContent, CancellationToken)

Applies configuration content to an IoTEdge device.

CancelJobAsync(String) CancelJobAsync(String) CancelJobAsync(String)

Cancels/Deletes the job with the specified ID.

CancelJobAsync(String, CancellationToken) CancelJobAsync(String, CancellationToken) CancelJobAsync(String, CancellationToken)

Cancels/Deletes the job with the specified ID.

CloseAsync() CloseAsync() CloseAsync()

Closes the RegistryManager instance and disposes its resources.

CreateFromConnectionString(String) CreateFromConnectionString(String) CreateFromConnectionString(String)

Creates a RegistryManager from the Iot Hub connection string.

CreateFromConnectionString(String, HttpTransportSettings) CreateFromConnectionString(String, HttpTransportSettings) CreateFromConnectionString(String, HttpTransportSettings)

Creates a RegistryManager from the Iot Hub connection string and transport settings

CreateQuery(String) CreateQuery(String) CreateQuery(String)

Retrieves a handle through which a result for a given query can be fetched.

CreateQuery(String, Nullable<Int32>) CreateQuery(String, Nullable<Int32>) CreateQuery(String, Nullable<Int32>)

Retrieves a handle through which a result for a given query can be fetched.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Dispose() Dispose() Dispose()
ExportDevicesAsync(String, String, Boolean, CancellationToken) ExportDevicesAsync(String, String, Boolean, CancellationToken) 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) ExportDevicesAsync(String, String, Boolean) ExportDevicesAsync(String, String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, Boolean) ExportDevicesAsync(String, Boolean) ExportDevicesAsync(String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, Boolean, CancellationToken) ExportDevicesAsync(String, Boolean, CancellationToken) ExportDevicesAsync(String, Boolean, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportRegistryAsync(String, String) ExportRegistryAsync(String, String) ExportRegistryAsync(String, String)

Copies registered device data to a set of blobs in a specific container in a storage account.

ExportRegistryAsync(String, String, CancellationToken) ExportRegistryAsync(String, String, CancellationToken) ExportRegistryAsync(String, String, CancellationToken)

Copies registered device data to a set of blobs in a specific container in a storage account.

GetConfigurationAsync(String) GetConfigurationAsync(String) GetConfigurationAsync(String)

Retrieves the specified Configuration object.

GetConfigurationAsync(String, CancellationToken) GetConfigurationAsync(String, CancellationToken) GetConfigurationAsync(String, CancellationToken)

Retrieves the specified Configuration object.

GetConfigurationsAsync(Int32) GetConfigurationsAsync(Int32) GetConfigurationsAsync(Int32)

Retrieves specified number of configurations from every Iot Hub partition. Results are not ordered.

GetConfigurationsAsync(Int32, CancellationToken) GetConfigurationsAsync(Int32, CancellationToken) GetConfigurationsAsync(Int32, CancellationToken)

Retrieves specified number of configurations from every Iot hub partition. Results are not ordered.

GetDeviceAsync(String) GetDeviceAsync(String) GetDeviceAsync(String)

Retrieves the specified Device object.

GetDeviceAsync(String, CancellationToken) GetDeviceAsync(String, CancellationToken) GetDeviceAsync(String, CancellationToken)

Retrieves the specified Device object.

GetDevicesAsync(Int32, CancellationToken) GetDevicesAsync(Int32, CancellationToken) GetDevicesAsync(Int32, CancellationToken)

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) GetDevicesAsync(Int32) GetDevicesAsync(Int32)

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) GetJobAsync(String, CancellationToken) GetJobAsync(String, CancellationToken)

Gets the job with the specified ID.

GetJobAsync(String) GetJobAsync(String) GetJobAsync(String)

Gets the job with the specified ID.

GetJobsAsync() GetJobsAsync() GetJobsAsync()

List all jobs for the IoT Hub.

GetJobsAsync(CancellationToken) GetJobsAsync(CancellationToken) GetJobsAsync(CancellationToken)

List all jobs for the IoT Hub.

GetModuleAsync(String, String) GetModuleAsync(String, String) GetModuleAsync(String, String)

Retrieves the specified Module object.

GetModuleAsync(String, String, CancellationToken) GetModuleAsync(String, String, CancellationToken) GetModuleAsync(String, String, CancellationToken)

Retrieves the specified Module object.

GetModulesOnDeviceAsync(String) GetModulesOnDeviceAsync(String) GetModulesOnDeviceAsync(String)

Retrieves the module identities on device

GetModulesOnDeviceAsync(String, CancellationToken) GetModulesOnDeviceAsync(String, CancellationToken) GetModulesOnDeviceAsync(String, CancellationToken)

Retrieves the module identities on device

GetRegistryStatisticsAsync(CancellationToken) GetRegistryStatisticsAsync(CancellationToken) GetRegistryStatisticsAsync(CancellationToken)

Gets usage statistics for the Iot Hub.

GetRegistryStatisticsAsync() GetRegistryStatisticsAsync() GetRegistryStatisticsAsync()

Gets usage statistics for the Iot Hub.

GetTwinAsync(String, CancellationToken) GetTwinAsync(String, CancellationToken) GetTwinAsync(String, CancellationToken)

Gets Twin from IotHub

GetTwinAsync(String, String, CancellationToken) GetTwinAsync(String, String, CancellationToken) GetTwinAsync(String, String, CancellationToken)

Gets Module's Twin from IotHub

GetTwinAsync(String) GetTwinAsync(String) GetTwinAsync(String)

Gets Twin from IotHub

GetTwinAsync(String, String) GetTwinAsync(String, String) GetTwinAsync(String, String)

Gets Module's Twin from IotHub

ImportDevicesAsync(String, String, CancellationToken) ImportDevicesAsync(String, String, CancellationToken) ImportDevicesAsync(String, String, CancellationToken)

Creates a new bulk job to import device registrations into the IoT Hub.

ImportDevicesAsync(String, String, String, CancellationToken) ImportDevicesAsync(String, String, String, CancellationToken) ImportDevicesAsync(String, String, String, CancellationToken)

Creates a new bulk job to import device registrations into the IoT Hub.

ImportDevicesAsync(String, String) ImportDevicesAsync(String, String) ImportDevicesAsync(String, String)

Creates a new bulk job to import device registrations into the IoT Hub.

ImportDevicesAsync(String, String, String) ImportDevicesAsync(String, String, String) ImportDevicesAsync(String, String, String)

Creates a new bulk job to import device registrations into the IoT Hub.

ImportRegistryAsync(String, String) ImportRegistryAsync(String, String) ImportRegistryAsync(String, String)

Imports registered device data from a set of blobs in a specific container in a storage account.

ImportRegistryAsync(String, String, CancellationToken) ImportRegistryAsync(String, String, CancellationToken) ImportRegistryAsync(String, String, CancellationToken)

Imports registered device data from a set of blobs in a specific container in a storage account.

OpenAsync() OpenAsync() OpenAsync()

Explicitly open the RegistryManager instance.

RemoveConfigurationAsync(Configuration) RemoveConfigurationAsync(Configuration) RemoveConfigurationAsync(Configuration)

Deletes a previously registered device from the system.

RemoveConfigurationAsync(String) RemoveConfigurationAsync(String) RemoveConfigurationAsync(String)

Deletes a previously registered device from the system.

RemoveConfigurationAsync(Configuration, CancellationToken) RemoveConfigurationAsync(Configuration, CancellationToken) RemoveConfigurationAsync(Configuration, CancellationToken)

Deletes a previously registered device from the system.

RemoveConfigurationAsync(String, CancellationToken) RemoveConfigurationAsync(String, CancellationToken) RemoveConfigurationAsync(String, CancellationToken)

Deletes a previously registered device from the system.

RemoveDeviceAsync(String, CancellationToken) RemoveDeviceAsync(String, CancellationToken) RemoveDeviceAsync(String, CancellationToken)

Deletes a previously registered device from the system.

RemoveDeviceAsync(Device, CancellationToken) RemoveDeviceAsync(Device, CancellationToken) RemoveDeviceAsync(Device, CancellationToken)

Deletes a previously registered device from the system.

RemoveDeviceAsync(Device) RemoveDeviceAsync(Device) RemoveDeviceAsync(Device)

Deletes a previously registered device from the system.

RemoveDeviceAsync(String) RemoveDeviceAsync(String) RemoveDeviceAsync(String)

Deletes a previously registered device from the system.

RemoveDevices2Async(IEnumerable<Device>) RemoveDevices2Async(IEnumerable<Device>) RemoveDevices2Async(IEnumerable<Device>)

Deletes a list of previously registered devices from the system.

RemoveDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) RemoveDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) RemoveDevices2Async(IEnumerable<Device>, Boolean, CancellationToken)

Deletes a list of previously registered devices from the system.

RemoveDevicesAsync(IEnumerable<Device>) RemoveDevicesAsync(IEnumerable<Device>) RemoveDevicesAsync(IEnumerable<Device>)

Deletes a list of previously registered devices from the system.

RemoveDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) RemoveDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) RemoveDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken)

Deletes a list of previously registered devices from the system.

RemoveModuleAsync(Module) RemoveModuleAsync(Module) RemoveModuleAsync(Module)

Deletes a previously registered module from device in the system.

RemoveModuleAsync(Module, CancellationToken) RemoveModuleAsync(Module, CancellationToken) RemoveModuleAsync(Module, CancellationToken)

Deletes a previously registered module from device in the system.

RemoveModuleAsync(String, String) RemoveModuleAsync(String, String) RemoveModuleAsync(String, String)

Deletes a previously registered module from device in the system.

RemoveModuleAsync(String, String, CancellationToken) RemoveModuleAsync(String, String, CancellationToken) RemoveModuleAsync(String, String, CancellationToken)

Deletes a previously registered module from device in the system.

ReplaceTwinAsync(String, String, String, CancellationToken) ReplaceTwinAsync(String, String, String, CancellationToken) ReplaceTwinAsync(String, String, String, CancellationToken)

Updates the mutable fields of Twin

ReplaceTwinAsync(String, String, Twin, String, CancellationToken) ReplaceTwinAsync(String, String, Twin, String, CancellationToken) ReplaceTwinAsync(String, String, Twin, String, CancellationToken)

Updates the mutable fields of Module's Twin

ReplaceTwinAsync(String, String, String, String) ReplaceTwinAsync(String, String, String, String) ReplaceTwinAsync(String, String, String, String)

Updates the mutable fields of Module's Twin

ReplaceTwinAsync(String, String, String, String, CancellationToken) ReplaceTwinAsync(String, String, String, String, CancellationToken) ReplaceTwinAsync(String, String, String, String, CancellationToken)

Updates the mutable fields of Module's Twin

ReplaceTwinAsync(String, Twin, String, CancellationToken) ReplaceTwinAsync(String, Twin, String, CancellationToken) ReplaceTwinAsync(String, Twin, String, CancellationToken)

Updates the mutable fields of Twin

ReplaceTwinAsync(String, String, String) ReplaceTwinAsync(String, String, String) ReplaceTwinAsync(String, String, String)

Updates the mutable fields of Twin

ReplaceTwinAsync(String, Twin, String) ReplaceTwinAsync(String, Twin, String) ReplaceTwinAsync(String, Twin, String)

Updates the mutable fields of Twin

ReplaceTwinAsync(String, String, Twin, String) ReplaceTwinAsync(String, String, Twin, String) ReplaceTwinAsync(String, String, Twin, String)

Updates the mutable fields of Module's Twin

UpdateConfigurationAsync(Configuration) UpdateConfigurationAsync(Configuration) UpdateConfigurationAsync(Configuration)

Update the mutable fields of the Configuration registration

UpdateConfigurationAsync(Configuration, Boolean) UpdateConfigurationAsync(Configuration, Boolean) UpdateConfigurationAsync(Configuration, Boolean)

Update the mutable fields of the Configuration registration

UpdateConfigurationAsync(Configuration, CancellationToken) UpdateConfigurationAsync(Configuration, CancellationToken) UpdateConfigurationAsync(Configuration, CancellationToken)

Update the mutable fields of the Configuration registration

UpdateConfigurationAsync(Configuration, Boolean, CancellationToken) UpdateConfigurationAsync(Configuration, Boolean, CancellationToken) UpdateConfigurationAsync(Configuration, Boolean, CancellationToken)

Update the mutable fields of the Configuration registration

UpdateDeviceAsync(Device) UpdateDeviceAsync(Device) UpdateDeviceAsync(Device)

Update the mutable fields of the device registration

UpdateDeviceAsync(Device, Boolean) UpdateDeviceAsync(Device, Boolean) UpdateDeviceAsync(Device, Boolean)

Update the mutable fields of the device registration

UpdateDeviceAsync(Device, CancellationToken) UpdateDeviceAsync(Device, CancellationToken) UpdateDeviceAsync(Device, CancellationToken)

Update the mutable fields of the device registration

UpdateDeviceAsync(Device, Boolean, CancellationToken) UpdateDeviceAsync(Device, Boolean, CancellationToken) UpdateDeviceAsync(Device, Boolean, CancellationToken)

Update the mutable fields of the device registration

UpdateDevices2Async(IEnumerable<Device>) UpdateDevices2Async(IEnumerable<Device>) UpdateDevices2Async(IEnumerable<Device>)

Update a list of devices with the system

UpdateDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) UpdateDevices2Async(IEnumerable<Device>, Boolean, CancellationToken) UpdateDevices2Async(IEnumerable<Device>, Boolean, CancellationToken)

Update a list of devices with the system

UpdateDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) UpdateDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken) UpdateDevicesAsync(IEnumerable<Device>, Boolean, CancellationToken)

Update a list of devices with the system

UpdateDevicesAsync(IEnumerable<Device>) UpdateDevicesAsync(IEnumerable<Device>) UpdateDevicesAsync(IEnumerable<Device>)

Update a list of devices with the system

UpdateModuleAsync(Module) UpdateModuleAsync(Module) UpdateModuleAsync(Module)

Update the mutable fields of the module registration

UpdateModuleAsync(Module, Boolean) UpdateModuleAsync(Module, Boolean) UpdateModuleAsync(Module, Boolean)

Update the mutable fields of the module registration

UpdateModuleAsync(Module, CancellationToken) UpdateModuleAsync(Module, CancellationToken) UpdateModuleAsync(Module, CancellationToken)

Update the mutable fields of the module registration

UpdateModuleAsync(Module, Boolean, CancellationToken) UpdateModuleAsync(Module, Boolean, CancellationToken) UpdateModuleAsync(Module, Boolean, CancellationToken)

Update the mutable fields of the module registration

UpdateTwinAsync(String, String, Twin, String) UpdateTwinAsync(String, String, Twin, String) UpdateTwinAsync(String, String, Twin, String)

Updates the mutable fields of Module's Twin

UpdateTwinAsync(String, Twin, String) UpdateTwinAsync(String, Twin, String) UpdateTwinAsync(String, Twin, String)

Updates the mutable fields of Twin

UpdateTwinAsync(String, String, String) UpdateTwinAsync(String, String, String) UpdateTwinAsync(String, String, String)

Updates the mutable fields of Twin

UpdateTwinAsync(String, Twin, String, CancellationToken) UpdateTwinAsync(String, Twin, String, CancellationToken) UpdateTwinAsync(String, Twin, String, CancellationToken)

Updates the mutable fields of Twin

UpdateTwinAsync(String, String, String, String) UpdateTwinAsync(String, String, String, String) UpdateTwinAsync(String, String, String, String)

Updates the mutable fields of Module's Twin

UpdateTwinAsync(String, String, String, CancellationToken) UpdateTwinAsync(String, String, String, CancellationToken) UpdateTwinAsync(String, String, String, CancellationToken)

Updates the mutable fields of Twin

UpdateTwinAsync(String, String, Twin, String, CancellationToken) UpdateTwinAsync(String, String, Twin, String, CancellationToken) UpdateTwinAsync(String, String, Twin, String, CancellationToken)

Updates the mutable fields of Module's Twin

UpdateTwinAsync(String, String, String, String, CancellationToken) UpdateTwinAsync(String, String, String, String, CancellationToken) UpdateTwinAsync(String, String, String, String, CancellationToken)

Updates the mutable fields of Module's Twin

UpdateTwins2Async(IEnumerable<Twin>, Boolean) UpdateTwins2Async(IEnumerable<Twin>, Boolean) UpdateTwins2Async(IEnumerable<Twin>, Boolean)

Update the mutable fields for a list of Twins previously created within the system

UpdateTwins2Async(IEnumerable<Twin>, CancellationToken) UpdateTwins2Async(IEnumerable<Twin>, CancellationToken) UpdateTwins2Async(IEnumerable<Twin>, CancellationToken)

Update the mutable fields for a list of Twins previously created within the system

UpdateTwins2Async(IEnumerable<Twin>) UpdateTwins2Async(IEnumerable<Twin>) UpdateTwins2Async(IEnumerable<Twin>)

Update the mutable fields for a list of Twins previously created within the system

UpdateTwins2Async(IEnumerable<Twin>, Boolean, CancellationToken) UpdateTwins2Async(IEnumerable<Twin>, Boolean, CancellationToken) UpdateTwins2Async(IEnumerable<Twin>, Boolean, CancellationToken)

Update the mutable fields for a list of Twins previously created within the system

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to