RegistryManager 类

  • 参考

定义

包:
com.microsoft.azure.sdk.iot.service

Use the RegistryManager client to manage the identity registry in IoT hubs. To access twins, use the DeviceTwin client. 

public class RegistryManager
继承
java.lang.Object
RegistryManager

构造函数

RegistryManager()

Previously was the java default constructor, should not be used.

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>As of release 1.22.0, replaced by <xref uid="com.microsoft.azure.sdk.iot.service.RegistryManager.createFromConnectionString(String)" data-throw-if-not-resolved="false" data-raw-source="createFromConnectionString(String)"></xref></p>

</xrefdescription>

RegistryManager(String connectionString)

Constructor to create instance from connection string
RegistryManager(String connectionString, RegistryManagerOptions options)

Constructor to create instance from connection string
RegistryManager(String hostName, AzureSasCredential azureSasCredential)

Create a new RegistryManager instance.
RegistryManager(String hostName, AzureSasCredential azureSasCredential, RegistryManagerOptions options)

Create a new RegistryManager instance.
RegistryManager(String hostName, TokenCredential credential)

Create a new RegistryManager instance.
RegistryManager(String hostName, TokenCredential credential, RegistryManagerOptions options)

Create a new RegistryManager instance.

方法

addConfiguration(Configuration configuration)

Add configuration using the given Configuration object Return with the response configuration object from IotHub
addDevice(Device device)

Add device using the given Device object Return with the response device object from IotHub
addDeviceAsync(Device device)

Async wrapper for add() operation
addModule(Module module)

Add module using the given Module object Return with the response module object from IotHub
applyConfigurationContentOnDevice(String deviceId, ConfigurationContent content)

Apply the provided configuration content to the provided device

close()

Gracefully close running threads, and then shutdown the underlying executor service

createFromConnectionString(String connectionString)

Static constructor to create instance from connection string

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>because this method declares a thrown IOException even though it never throws an IOException. Users are recommended to use <xref uid="com.microsoft.azure.sdk.iot.service.RegistryManager.RegistryManager(String)" data-throw-if-not-resolved="false" data-raw-source="RegistryManager(String)"></xref> instead since it does not declare this exception even though it constructs the same RegistryManager. </p>

</xrefdescription>

createFromConnectionString(String connectionString, RegistryManagerOptions options)

Static constructor to create instance from connection string

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>because this method declares a thrown IOException even though it never throws an IOException. Users are recommended to use <xref uid="com.microsoft.azure.sdk.iot.service.RegistryManager.RegistryManager(String,RegistryManagerOptions)" data-throw-if-not-resolved="false" data-raw-source="RegistryManager(String, RegistryManagerOptions)"></xref> instead since it does not declare this exception even though it constructs the same RegistryManager. </p>

</xrefdescription>

exportDevices(JobProperties exportDevicesParameters)

Create a bulk export job.
exportDevices(String exportBlobContainerUri, Boolean excludeKeys)

Create a bulk export job.
exportDevicesAsync(JobProperties exportDevicesParameters)

Async wrapper for exportDevices() operation

exportDevicesAsync(String exportBlobContainerUri, Boolean excludeKeys)

Async wrapper for exportDevices() operation

getConfiguration(String configurationId)

Get configuration by configuration Id from IotHub
getConfigurations(Integer maxCount)

Get list of Configuration
getDevice(String deviceId)

Get device data by device Id from IotHub
getDeviceAsync(String deviceId)

Async wrapper for getDevice() operation
getDeviceConnectionString(Device device)

Return the iothub device connection string for a provided device.

getDevices(Integer maxCount)

Get list of devices

getDevicesAsync(Integer maxCount)

Async wrapper for getDevices() operation

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>as of release 1.12.0. Please use <xref uid="com.microsoft.azure.sdk.iot.service.devicetwin.DeviceTwin.queryTwin(String,Integer)" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.azure.sdk.iot.service.devicetwin.DeviceTwin#queryTwin(String sqlQuery, Integer pageSize)"></xref> to query for all devices.</p>

</xrefdescription>

getJob(String jobId)

Get the properties of an existing job.
getJobAsync(String jobId)

Async wrapper for getJob() operation

getModule(String deviceId, String moduleId)

Get module data by device Id and module Id from IotHub
getModulesOnDevice(String deviceId)

Get modules data by device Id from IotHub
getStatistics()

Get device statistics
getStatisticsAsync()

Async wrapper for getStatistics() operation
importDevices(JobProperties importDevicesParameters)

Create a bulk import job.
importDevices(String importBlobContainerUri, String outputBlobContainerUri)

Create a bulk import job.
importDevicesAsync(JobProperties importParameters)

Async wrapper for importDevices() operation
importDevicesAsync(String importBlobContainerUri, String outputBlobContainerUri)

Async wrapper for importDevices() operation
open() 

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>as of release 1.13.0 this API is no longer supported and open is done implicitly by the respective APIs Opens this registry manager's executor service after it has been closed. </p>

</xrefdescription>

removeConfiguration(Configuration config)

Send remove configuration request and verify response
removeConfiguration(String configurationId)

Send remove configuration request and verify response
removeDevice(Device device)

Remove device
removeDevice(String deviceId)

Remove device
removeDeviceAsync(String deviceId)

Async wrapper for removeDevice() operation
removeModule(Module module)

Remove module
removeModule(String deviceId, String moduleId)

Remove module
updateConfiguration(Configuration configuration)

Update configuration not forced
updateConfiguration(Configuration configuration, Boolean forceUpdate)

Update configuration with forceUpdate input parameter

updateDevice(Device device)

Update device not forced
updateDevice(Device device, Boolean forceUpdate)

Update device with forceUpdate input parameter

updateDeviceAsync(Device device)

Async wrapper for updateDevice() operation
updateDeviceAsync(Device device, Boolean forceUpdate)

Async wrapper for forced updateDevice() operation

updateModule(Module module)

Update module not forced
updateModule(Module module, Boolean forceUpdate)

Update module with forceUpdate input parameter

适用于