Registry class

リファレンス

パッケージ:: azure-iothub

Registry クラスは、IoT Hubデバイス ID サービスへのアクセスを提供します。 SDK のユーザーは、ファクトリメソッド ( fromConnectionString または fromSharedAccessSignature) のいずれかを使用して、このクラスをインスタンス化する必要があります。

デバイス ID レジストリ操作に使用されるプロトコルは HTTPS です。

メソッド

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	IoT ハブに構成を追加します。
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	デバイスの配列を追加します。
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	指定したモジュールをレジストリに追加します。
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	IoT Hub上のデバイスに指定された構成を適用する
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	一括インポート/エクスポートジョブを取り消します。
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	IoT ハブに新しいデバイス ID を作成します。
createQuery(string, number)	IoT Hub インスタンスで実行して、デバイスまたはジョブに関する情報を検索できるクエリを作成します。
delete(string)
delete(string, HttpResponseCallback<any>)	IoT ハブから既存のデバイス ID を削除します。
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	デバイスを一括ジョブの BLOB にエクスポートします。
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	構成された ID を使用して、一括ジョブの BLOB にデバイスをエクスポートします。
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	指定された接続文字列から Registry オブジェクトを構築します。
fromSharedAccessSignature(string)	指定された共有アクセス署名から Registry オブジェクトを構築します。
fromTokenCredential(string, TokenCredential)	指定された Azure TokenCredential から Registry オブジェクトを構築します。
get(string)
get(string, HttpResponseCallback<Device>)	IoT ハブ上の既存のデバイス ID に関する情報を要求します。
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	IoT Hubから 1 つの構成を取得する
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	IoT Hubのすべての構成を取得する
getJob(string)
getJob(string, Callback<JobStatus>)	一括インポート/エクスポートジョブの状態を取得します。
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	IoT Hub上のデバイスから 1 つのモジュールを取得する
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	IoT Hub デバイス上のすべてのモジュールの一覧を取得する
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	指定したモジュール識別子を持つモジュールのモジュールツインを取得します。
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	デバイス ID レジストリ内のデバイスに関する統計情報を取得します。
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	指定したデバイス識別子を持つデバイスのデバイスツインを取得します。
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	一括ジョブの BLOB からデバイスをインポートします。
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	構成された ID を使用して、一括ジョブ内の BLOB からデバイスをインポートします。
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	IoT ハブ上の最初の 1000 個のデバイス ID に関する情報を要求します。
listJobs()
listJobs(HttpResponseCallback<any>)	最後のインポート/エクスポートジョブ (アクティブなジョブがある場合は含む) を一覧表示します。
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	指定された ID を持つ構成をIoT Hubから削除する
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	デバイスの配列を更新します。
removeModule(Module, TripleValueCallback<any, any>)	レジストリから特定のモジュールを削除する
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	特定のデバイス情報を使用して、IoT ハブ上の既存のデバイス ID を更新します。パラメーターには `deviceInfo` 、更新可能なすべてのプロパティを含める必要があります。たとえば、プロパティをから `disabled` に`enableddeviceInfo`更新する`status`場合、オブジェクトには statusReason、認証 (およびそのサブプロパティ)、機能、deviceScope がデバイスの現在の値に設定されている必要があります。または、これらのプロパティがリセットされます。更新を行う前に、最初に get API を呼び出しておくことをお勧めします。
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	IoT ハブの構成を更新する
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	デバイスの配列を更新します。パラメーターの個々の要素には、 `devices` 更新可能なすべてのプロパティを含める必要があります。たとえば、プロパティをから `disabled` に`enabled`更新する`status`場合、オブジェクトには statusReason、認証 (およびそのサブプロパティ)、機能、deviceScope がデバイスの現在の値に設定されている必要があります。または、これらのプロパティがリセットされます。更新を行う前に、最初に get API を呼び出しておくことをお勧めします。
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	レジストリ内の特定のモジュールオブジェクトを更新する
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	指定したパッチを使用して、特定のモジュールのツインを更新します。
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	特定のデバイスのデバイスツインを特定のパッチで更新します。

メソッドの詳細

addConfiguration(Configuration)

function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

パラメーター

configuration: Configuration

戻り値

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

IoT ハブに構成を追加します。

function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

パラメーター

configuration: Configuration

module:azure-iothub 型のオブジェクト。ハブに追加する構成

done: HttpResponseCallback<any>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

addDevices(DeviceDescription[])

function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

パラメーター

devices: DeviceDescription[]

戻り値

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

デバイスの配列を追加します。

function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)

パラメーター

devices: DeviceDescription[]

有効なデバイス識別子の値を持つプロパティを deviceId 含める必要があるオブジェクトの配列。

done: HttpResponseCallback<BulkRegistryOperationResult>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、BulkRegistryOperationResult、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

addModule(Module)

function addModule(module: Module): Promise<ResultWithHttpResponse<any>>

パラメーター

module: Module

戻り値

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

指定したモジュールをレジストリに追加します。

function addModule(module: Module, done?: HttpResponseCallback<any>)

パラメーター

module: Module

レジストリに追加するモジュールオブジェクト。

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>

パラメーター

deviceId: string

content: ConfigurationContent

戻り値

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

IoT Hub上のデバイスに指定された構成を適用する

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)

パラメーター

deviceId: string

構成を適用するデバイスの ID

content: ConfigurationContent

適用する構成

done: HttpResponseCallback<any>

cancelJob(string)

function cancelJob(jobId: string): Promise<JobStatus>

パラメーター

jobId: string

戻り値

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

一括インポート/エクスポートジョブを取り消します。

function cancelJob(jobId: string, done?: Callback<JobStatus>)

パラメーター

jobId: string

ユーザーが状態情報を取得するジョブの識別子。

done: Callback<JobStatus>

2 つの引数を指定してを呼び出す省略可能な関数。エラーが発生した場合は error オブジェクト、それ以外の場合は null、識別子が引数として渡されたジョブの (取り消された) 状態。

create(DeviceDescription)

function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

パラメーター

deviceInfo: DeviceDescription

戻り値

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

IoT ハブに新しいデバイス ID を作成します。

function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

パラメーター

deviceInfo: DeviceDescription

オブジェクトには、有効なデバイス識別子を deviceId 持つプロパティを含める必要があります。

done: HttpResponseCallback<Device>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、作成されたデバイス ID を表す Device オブジェクト、ログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

createQuery(string, number)

IoT Hub インスタンスで実行して、デバイスまたはジョブに関する情報を検索できるクエリを作成します。

function createQuery(sqlQuery: string, pageSize?: number): Query

パラメーター

sqlQuery: string

SQL 文字列として書き込まれたクエリ。

pageSize: number

1 ページあたりの結果の必要な数 (省略可能。既定値は 1000、最大: 10000)。

戻り値

Query

delete(string)

function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>

パラメーター

deviceId: string

戻り値

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

IoT ハブから既存のデバイス ID を削除します。

function delete(deviceId: string, done?: HttpResponseCallback<any>)

パラメーター

deviceId: string

既存のデバイス ID の識別子。

done: HttpResponseCallback<any>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、always-null 引数 (他のメソッドとの一貫性を保つ)、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

exportDevicesToBlob(string, boolean)

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

パラメーター

outputBlobContainerUri: string

excludeKeys: boolean

戻り値

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

デバイスを一括ジョブの BLOB にエクスポートします。

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

パラメーター

outputBlobContainerUri: string

デバイスの一覧を含む "devices.txt" という名前の BLOB が作成されるコンテナーへの URI。

excludeKeys: boolean

エクスポートされたデータからセキュリティキーを除外するかどうかを示すブール値。

done: Callback<JobStatus>

ジョブが作成されたときに呼び出す省略可能な関数。2 つの引数があります。エラーが発生した場合は error オブジェクト、それ以外の場合は null、デバイスのエクスポートの進行状況を追跡するために使用できるジョブの状態です。

exportDevicesToBlobByIdentity(string, boolean)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

パラメーター

outputBlobContainerUri: string

excludeKeys: boolean

戻り値

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

構成された ID を使用して、一括ジョブの BLOB にデバイスをエクスポートします。

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

パラメーター

outputBlobContainerUri: string

デバイスの一覧を含む "devices.txt" という名前の BLOB が作成されるコンテナーへの URI。

excludeKeys: boolean

エクスポートされたデータからセキュリティキーを除外するかどうかを示すブール値。

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>

パラメーター

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

戻り値

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)

パラメーター

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

指定された接続文字列から Registry オブジェクトを構築します。

static function fromConnectionString(value: string): Registry

パラメーター

value: string

適切な (読み取り/書き込み) レジストリのアクセス許可をカプセル化する接続文字列。

戻り値

Registry

fromSharedAccessSignature(string)

指定された共有アクセス署名から Registry オブジェクトを構築します。

static function fromSharedAccessSignature(value: string): Registry

パラメーター

value: string

適切な (読み取りまたは書き込み) レジストリのアクセス許可をカプセル化する共有アクセス署名。

戻り値

Registry

fromTokenCredential(string, TokenCredential)

指定された Azure TokenCredential から Registry オブジェクトを構築します。

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registry

パラメーター

hostName: string

Azure サービスのホスト名。

tokenCredential: TokenCredential

Azure サービスで認証するために使用される Azure TokenCredential

戻り値

Registry

get(string)

function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>

パラメーター

deviceId: string

戻り値

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

IoT ハブ上の既存のデバイス ID に関する情報を要求します。

function get(deviceId: string, done?: HttpResponseCallback<Device>)

パラメーター

deviceId: string

既存のデバイス ID の識別子。

done: HttpResponseCallback<Device>

getConfiguration(string)

function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>

パラメーター

configurationId: string

戻り値

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

IoT Hubから 1 つの構成を取得する

function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)

パラメーター

configurationId: string

取得する構成の ID

done: HttpResponseCallback<Configuration>

Error オブジェクトまたは module:azure-iothub で呼び出される省略可能なコールバック。構成の詳細を含む構成オブジェクト。

getConfigurations()

function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>

戻り値

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

IoT Hubのすべての構成を取得する

function getConfigurations(done?: HttpResponseCallback<Configuration[]>)

パラメーター

done: HttpResponseCallback<Configuration[]>

Error オブジェクトまたは module:azure-iothub の配列を使用して呼び出される省略可能なコールバック。すべての構成の構成オブジェクト。

getJob(string)

function getJob(jobId: string): Promise<JobStatus>

パラメーター

jobId: string

戻り値

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

一括インポート/エクスポートジョブの状態を取得します。

function getJob(jobId: string, done?: Callback<JobStatus>)

パラメーター

jobId: string

ユーザーが状態情報を取得するジョブの識別子。

done: Callback<JobStatus>

2 つの引数を指定してを呼び出す省略可能な関数。エラーが発生した場合のエラーオブジェクト (それ以外の場合は null) と、識別子が引数として渡されたジョブの状態。

getModule(string, string)

function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>

パラメーター

deviceId: string

moduleId: string

戻り値

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

IoT Hub上のデバイスから 1 つのモジュールを取得する

function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)

パラメーター

deviceId: string

モジュールを所有するデバイス ID。

moduleId: string

取得するモジュール ID

done: HttpResponseCallback<Module>

Error オブジェクトまたは module:azure-iothub で呼び出される省略可能なコールバック。要求されたモジュールの Module オブジェクト

getModulesOnDevice(string)

function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>

パラメーター

deviceId: string

戻り値

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

IoT Hub デバイス上のすべてのモジュールの一覧を取得する

function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)

パラメーター

deviceId: string

モジュールを取得するデバイスの ID

done: HttpResponseCallback<Module[]>

Error オブジェクトまたは module:azure-iothub の配列を使用して呼び出される省略可能なコールバック。すべてのモジュールのモジュールオブジェクト。

getModuleTwin(string, string)

function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>

パラメーター

deviceId: string

moduleId: string

戻り値

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

指定したモジュール識別子を持つモジュールのモジュールツインを取得します。

function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)

パラメーター

deviceId: string

デバイス識別子。

moduleId: string

モジュールの ID です。

done: HttpResponseCallback<Twin>

Error オブジェクトまたはモジュールツインインスタンスを使用して呼び出される省略可能なコールバック。

getRegistryStatistics()

function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>

戻り値

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

デバイス ID レジストリ内のデバイスに関する統計情報を取得します。

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

パラメーター

done: HttpResponseCallback<RegistryStatistics>

Error オブジェクトまたはデバイスレジストリ統計を使用して呼び出される省略可能なコールバック。

getTwin(string)

function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>

パラメーター

deviceId: string

戻り値

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

指定したデバイス識別子を持つデバイスのデバイスツインを取得します。

function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)

パラメーター

deviceId: string

デバイス識別子。

done: HttpResponseCallback<Twin>

Error オブジェクトまたはデバイスツインインスタンスで呼び出される省略可能なコールバック。

importDevicesFromBlob(string, string)

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

パラメーター

inputBlobContainerUri: string

outputBlobContainerUri: string

戻り値

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

一括ジョブの BLOB からデバイスをインポートします。

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

パラメーター

inputBlobContainerUri: string

インポートするデバイスの一覧を含む "devices.txt" という名前の BLOB を持つコンテナーへの URI。

outputBlobContainerUri: string

インポートプロセスのログを含む BLOB が作成されるコンテナーへの URI。

done: Callback<JobStatus>

ジョブが作成されたときに呼び出す省略可能な関数。2 つの引数があります。エラーが発生した場合は error オブジェクト、それ以外の場合は null、デバイスのインポートの進行状況を追跡するために使用できるジョブの状態です。

importDevicesFromBlobByIdentity(string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

パラメーター

inputBlobContainerUri: string

outputBlobContainerUri: string

戻り値

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

構成された ID を使用して、一括ジョブ内の BLOB からデバイスをインポートします。

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

パラメーター

inputBlobContainerUri: string

インポートするデバイスの一覧を含む "devices.txt" という名前の BLOB を持つコンテナーへの URI。

outputBlobContainerUri: string

インポートプロセスのログを含む BLOB が作成されるコンテナーへの URI。

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>

パラメーター

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

戻り値

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)

パラメーター

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

function list(): Promise<ResultWithHttpResponse<Device[]>>

戻り値

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

IoT ハブ上の最初の 1000 個のデバイス ID に関する情報を要求します。

function list(done?: HttpResponseCallback<Device[]>)

パラメーター

done: HttpResponseCallback<Device[]>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、一覧表示されているデバイス ID を表す Device オブジェクトの配列、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

listJobs()

function listJobs(): Promise<ResultWithHttpResponse<any>>

戻り値

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

最後のインポート/エクスポートジョブ (アクティブなジョブがある場合は含む) を一覧表示します。

function listJobs(done?: HttpResponseCallback<any>)

パラメーター

done: HttpResponseCallback<any>

2 つの引数を指定してを呼び出す省略可能な関数。エラーが発生した場合は error オブジェクト、それ以外の場合は null、引数として過去のジョブの一覧です。

removeConfiguration(string)

function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>

パラメーター

configurationId: string

戻り値

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

指定された ID を持つ構成をIoT Hubから削除する

function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)

パラメーター

configurationId: string

削除する構成の ID

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

パラメーター

devices: DeviceDescription[]

forceRemove: boolean

戻り値

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

デバイスの配列を更新します。

function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

パラメーター

devices: DeviceDescription[]

有効なデバイス識別子である値を持つプロパティを deviceId 含める必要があるオブジェクトの配列。

forceRemove: boolean

が true の場合 forceRemove 、etag に関係なくデバイスが削除されます。それ以外の場合は、etag が一致する必要があります。

done: HttpResponseCallback<BulkRegistryOperationResult>

removeModule(Module, TripleValueCallback<any, any>)

レジストリから特定のモジュールを削除する

function removeModule(module: Module, done?: TripleValueCallback<any, any>)

パラメーター

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>

パラメーター

moduleOrDeviceId: string | Module

戻り値

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>

パラメーター

moduleOrDeviceId: string | Module

moduleId: string

戻り値

Promise<ResultWithHttpResponse<any>>

removeModule(string, string, TripleValueCallback<any, any>)

function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)

パラメーター

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

パラメーター

deviceInfo: DeviceDescription

戻り値

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

特定のデバイス情報を使用して、IoT ハブ上の既存のデバイス ID を更新します。パラメーターには deviceInfo 、更新可能なすべてのプロパティを含める必要があります。たとえば、プロパティをから disabled にenableddeviceInfo更新するstatus場合、オブジェクトには statusReason、認証 (およびそのサブプロパティ)、機能、deviceScope がデバイスの現在の値に設定されている必要があります。または、これらのプロパティがリセットされます。更新を行う前に、最初に get API を呼び出しておくことをお勧めします。

function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

パラメーター

deviceInfo: DeviceDescription

有効なデバイス識別子である値を deviceId 持つプロパティを含める必要があるオブジェクト。

done: HttpResponseCallback<Device>

操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、更新されたデバイス ID を表す Device オブジェクト、ログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。

updateConfiguration(Configuration)

function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

パラメーター

configuration: Configuration

戻り値

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

パラメーター

configuration: Configuration

forceUpdate: boolean

戻り値

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)

パラメーター

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

IoT ハブの構成を更新する

function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

パラメーター

configuration: Configuration

module:azure-iothub 型のオブジェクト。ハブに追加する構成

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

パラメーター

devices: DeviceDescription[]

forceUpdate: boolean

戻り値

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

デバイスの配列を更新します。パラメーターの個々の要素には、 devices 更新可能なすべてのプロパティを含める必要があります。たとえば、プロパティをから disabled にenabled更新するstatus場合、オブジェクトには statusReason、認証 (およびそのサブプロパティ)、機能、deviceScope がデバイスの現在の値に設定されている必要があります。または、これらのプロパティがリセットされます。更新を行う前に、最初に get API を呼び出しておくことをお勧めします。

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

パラメーター

devices: DeviceDescription[]

有効なデバイス識別子である値を持つプロパティを deviceId 含める必要があるオブジェクトの配列。

forceUpdate: boolean

が true の場合 forceUpdate 、etag に関係なくデバイスが更新されます。それ以外の場合は、etag が一致する必要があります。

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>

パラメーター

module: Module

戻り値

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

パラメーター

module: Module

forceUpdate: boolean

戻り値

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)

パラメーター

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

レジストリ内の特定のモジュールオブジェクトを更新する

function updateModule(module: Module, done?: TripleValueCallback<any, any>)

パラメーター

module: Module

更新するモジュールオブジェクト。

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

パラメーター

deviceId: string

moduleId: string

patch: any

etag: string

戻り値

Promise<ResultWithHttpResponse<Twin>>

updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

指定したパッチを使用して、特定のモジュールのツインを更新します。

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

パラメーター

deviceId: string

デバイス識別子。

moduleId: string

モジュール識別子

patch: any

モジュールツインにパッチを適用するために必要なプロパティとタグ。

etag: string

etag が取得されてからモジュールツインが更新された場合でも、更新を強制する、このモジュールツインまたは '*' の最新の etag。

done: HttpResponseCallback<Twin>

Error オブジェクトまたはモジュールツインインスタンスを使用して呼び出される省略可能なコールバック。

updateTwin(string, any, string)

function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

パラメーター

deviceId: string

patch: any

etag: string

戻り値

Promise<ResultWithHttpResponse<Twin>>

updateTwin(string, any, string, HttpResponseCallback<Twin>)

特定のデバイスのデバイスツインを特定のパッチで更新します。

function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

パラメーター

deviceId: string

デバイス識別子。

patch: any

デバイスツインにパッチを適用するために必要なプロパティとタグ。

etag: string

etag が取得されてからデバイスツインが更新された場合でも、このデバイスツインまたは '*' の最新の etag によって強制的に更新されます。

done: HttpResponseCallback<Twin>

Error オブジェクトまたはデバイスツインインスタンスで呼び出される省略可能なコールバック。

Share via

Registry class

メソッド

メソッドの詳細

addConfiguration(Configuration)

パラメーター

戻り値

addConfiguration(Configuration, HttpResponseCallback<any>)

パラメーター

addDevices(DeviceDescription[])

パラメーター

戻り値

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

パラメーター

addModule(Module)

パラメーター

戻り値

addModule(Module, HttpResponseCallback<any>)

パラメーター

applyConfigurationContentOnDevice(string, ConfigurationContent)

パラメーター

戻り値

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

パラメーター

cancelJob(string)

パラメーター

戻り値

cancelJob(string, Callback<JobStatus>)

パラメーター

create(DeviceDescription)

パラメーター

戻り値

create(DeviceDescription, HttpResponseCallback<Device>)

パラメーター

createQuery(string, number)

パラメーター

戻り値

delete(string)

パラメーター

戻り値

delete(string, HttpResponseCallback<any>)

パラメーター

exportDevicesToBlob(string, boolean)

パラメーター

戻り値

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

パラメーター

exportDevicesToBlobByIdentity(string, boolean)

パラメーター

戻り値

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

パラメーター

exportDevicesToBlobByIdentity(string, boolean, string)

パラメーター

戻り値

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

パラメーター

fromConnectionString(string)

パラメーター

戻り値

fromSharedAccessSignature(string)

パラメーター

戻り値

fromTokenCredential(string, TokenCredential)

パラメーター

戻り値

get(string)

パラメーター

戻り値

get(string, HttpResponseCallback<Device>)

パラメーター

getConfiguration(string)

パラメーター

戻り値

getConfiguration(string, HttpResponseCallback<Configuration>)

パラメーター

getConfigurations()

戻り値

getConfigurations(HttpResponseCallback<Configuration[]>)

パラメーター