Registry class
Registry クラスは、IoT Hubデバイス ID サービスへのアクセスを提供します。 SDK のユーザーは、ファクトリ メソッド ( fromConnectionString または fromSharedAccessSignature) のいずれかを使用して、このクラスをインスタンス化する必要があります。
デバイス ID レジストリ操作に使用されるプロトコルは HTTPS です。
メソッド
メソッドの詳細
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
戻り値
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)
デバイスの配列を追加します。
function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)パラメーター
- devices
有効なデバイス識別子の値を持つプロパティを 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>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
cancelJob(string)
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 持つプロパティを含める必要があります。
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>
ジョブが作成されたときに呼び出す省略可能な関数。2 つの引数があります。エラーが発生した場合は error オブジェクト、それ以外の場合は null、デバイスのエクスポートの進行状況を追跡するために使用できるジョブの状態です。
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
適切な (読み取り/書き込み) レジストリのアクセス許可をカプセル化する接続文字列。
戻り値
fromSharedAccessSignature(string)
指定された共有アクセス署名から Registry オブジェクトを構築します。
static function fromSharedAccessSignature(value: string): Registryパラメーター
- value
-
string
適切な (読み取りまたは書き込み) レジストリのアクセス許可をカプセル化する共有アクセス署名。
戻り値
fromTokenCredential(string, TokenCredential)
指定された Azure TokenCredential から Registry オブジェクトを構築します。
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registryパラメーター
- hostName
-
string
Azure サービスのホスト名。
- tokenCredential
- TokenCredential
Azure サービスで認証するために使用される Azure TokenCredential
戻り値
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 の識別子。
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)
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>
ジョブが作成されたときに呼び出す省略可能な関数。2 つの引数があります。エラーが発生した場合は error オブジェクト、それ以外の場合は null、デバイスのインポートの進行状況を追跡するために使用できるジョブの状態です。
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[]>)パラメーター
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>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
removeDevices(DeviceDescription[], boolean)
function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>パラメーター
- devices
- forceRemove
-
boolean
戻り値
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
デバイスの配列を更新します。
function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)パラメーター
- devices
有効なデバイス識別子である値を持つプロパティを deviceId 含める必要がある オブジェクトの配列。
- forceRemove
-
boolean
が true の場合 forceRemove 、etag に関係なくデバイスが削除されます。 それ以外の場合は、etag が一致する必要があります。
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、BulkRegistryOperationResult、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
removeModule(Module, TripleValueCallback<any, any>)
レジストリから特定のモジュールを削除する
function removeModule(module: Module, done?: TripleValueCallback<any, any>)パラメーター
- module
- Module
- done
-
TripleValueCallback<any, any>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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 持つプロパティを含める必要がある オブジェクト。
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>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
updateDevices(DeviceDescription[], boolean)
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>パラメーター
- devices
- 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
有効なデバイス識別子である値を持つプロパティを deviceId 含める必要がある オブジェクトの配列。
- forceUpdate
-
boolean
が true の場合 forceUpdate 、etag に関係なくデバイスが更新されます。 それ以外の場合は、etag が一致する必要があります。
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、BulkRegistryOperationResult、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null)、応答の本文、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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 オブジェクトまたはデバイス ツイン インスタンスで呼び出される省略可能なコールバック。