ユーザー定義関数クライアントライブラリリファレンス

[アーティクル]
01/17/2020

重要

Azure Digital Twins サービスの新しいバージョンがリリースされました。新しいサービスの拡張された機能に照らして、元の Azure Digital Twins サービス (このドキュメントセットで説明) は廃止されました。

新しいサービスのドキュメントを表示するには、アクティブな Azure Digital Twins のドキュメントを参照してください。

このドキュメントでは、Azure Digital Twins ユーザー定義関数クライアントライブラリの参照情報を示します。

ヘルパーメソッド

クライアントライブラリでは、よく使用される操作のヘルパーメソッドが定義されています。

getSpaceMetadata(id) ⇒ `space`

空間識別子が指定されると、この関数はグラフから空間を取得します。

種類: グローバル関数

パラメーター	Type	説明
id	`guid`	空間識別子

getSensorMetadata(id) ⇒ `sensor`

センサーの識別子が指定されると、この関数はグラフからセンサーを取得します。

種類: グローバル関数

パラメーター	Type	説明
id	`guid`	センサーの識別子

getDeviceMetadata(id) ⇒ `device`

デバイスの識別子が指定されると、この関数はグラフからデバイスを取得します。

種類: グローバル関数

パラメーター	Type	説明
id	`guid`	デバイスの識別子

getSensorValue(sensorId, dataType) ⇒ `value`

センサーの識別子とそのデータ型が指定されると、この関数はそのセンサーの現在の値を取得します。

種類: グローバル関数

パラメーター	Type	説明
sensorId	`guid`	センサーの識別子
dataType	`string`	センサーのデータ型

getSpaceValue(spaceId, valueName) ⇒ `value`

空間識別子と値名が指定されると、この関数はその空間プロパティの現在の値を取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子
Valuename	`string`	空間プロパティの名前

getSensorHistoryValues(sensorId, dataType) ⇒ `value[]`

センサーの識別子とそのデータ型が指定されると、この関数はそのセンサーの履歴の値を取得します。

種類: グローバル関数

パラメーター	Type	説明
sensorId	`guid`	センサーの識別子
dataType	`string`	センサーのデータ型

getSpaceHistoryValues(spaceId, dataType) ⇒ `value[]`

空間識別子と値名が指定されると、この関数は空間のそのプロパティの履歴の値を取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子
Valuename	`string`	空間プロパティの名前

getSpaceChildSpaces(spaceId) ⇒ `space[]`

空間識別子が指定されると、この関数はその親空間の子空間を取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

空間識別子が指定されると、この関数はその親空間の子センサーを取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子

getSpaceChildDevices(spaceId) ⇒ `device[]`

空間識別子が指定されると、この関数はその親空間の子デバイスを取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

デバイスの識別子が指定されると、この関数はその親デバイスの子センサーを取得します。

種類: グローバル関数

パラメーター	Type	説明
deviceId	`guid`	デバイスの識別子

getSpaceParentSpace(childSpaceId) ⇒ `space`

空間識別子が指定されると、この関数はその親空間を取得します。

種類: グローバル関数

パラメーター	Type	説明
childSpaceId	`guid`	空間識別子

getSensorParentSpace(childSensorId) ⇒ `space`

センサーの識別子が指定されると、この関数はその親空間を取得します。

種類: グローバル関数

パラメーター	Type	説明
childSensorId	`guid`	センサーの識別子

getDeviceParentSpace(childDeviceId) ⇒ `space`

デバイスの識別子が指定されると、この関数はその親空間を取得します。

種類: グローバル関数

パラメーター	Type	説明
childDeviceId	`guid`	デバイスの識別子

getSensorParentDevice(childSensorId) ⇒ `space`

センサーの識別子が指定されると、この関数はその親デバイスを取得します。

種類: グローバル関数

パラメーター	Type	説明
childSensorId	`guid`	センサーの識別子

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

空間識別子が指定されると、この関数は空間からプロパティとその値を取得します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子
propertyName	`string`	空間プロパティの名前

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

センサーの識別子が指定されると、この関数はセンサーからプロパティとその値を取得します。

種類: グローバル関数

パラメーター	Type	説明
sensorId	`guid`	センサーの識別子
propertyName	`string`	センサープロパティの名前

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

デバイスの識別子が指定されると、この関数はデバイスからプロパティとその値を取得します。

種類: グローバル関数

パラメーター	Type	説明
deviceId	`guid`	デバイスの識別子
propertyName	`string`	デバイスプロパティの名前

setSensorValue(sensorId, dataType, value)

この関数は、指定されたデータ型のセンサーオブジェクトの値を設定します。

種類: グローバル関数

パラメーター	Type	説明
sensorId	`guid`	センサーの識別子
dataType	`string`	センサーのデータ型
value	`string`	値

setSpaceValue(spaceId, dataType, value)

この関数は、指定されたデータ型の空間オブジェクトの値を設定します。

種類: グローバル関数

パラメーター	Type	説明
spaceId	`guid`	空間識別子
dataType	`string`	データ型
value	`string`	値

log(message)

この関数は、ユーザー定義関数内での次のメッセージをログに記録します。

種類: グローバル関数

パラメーター	Type	説明
message	`string`	記録されるメッセージ

sendNotification(topologyObjectId, topologyObjectType, payload)

この関数は、ディスパッチされるカスタム通知を送信します。

種類: グローバル関数

パラメーター	Type	説明
topologyObjectId	`guid`	グラフのオブジェクト識別子。例: 空間、センサー、デバイスの ID。
topologyObjectType	`string`	例: センサー、デバイス。
payload	`string`	通知と共に送信される JSON ペイロード。

戻り値の型

以下に、クライアントリファレンスヘルパーメソッドから返される応答モデルを示します。

Space

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Space",
  "friendlyName": "Conference Room",
  "typeId": 0,
  "parentSpaceId": "00000000-0000-0000-0000-000000000001",
  "subtypeId": 0
}

空間メソッド

Parent() ⇒ `space`

この関数は、現在の空間の親空間を返します。

ChildSensors() ⇒ `sensor[]`

この関数は、現在の空間の子センサーを返します。

ChildDevices() ⇒ `device[]`

この関数は、現在の空間の子デバイスを返します。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

この関数は、現在の空間の拡張プロパティとその値を返します。

パラメーター	Type	説明
propertyName	`string`	拡張プロパティの名前

Value(valueName) ⇒ `value`

この関数は、現在の空間の値を返します。

パラメーター	Type	説明
Valuename	`string`	値の名前

History(valueName) ⇒ `value[]`

この関数は、現在の空間の履歴の値を返します。

パラメーター	Type	説明
Valuename	`string`	値の名前

Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。

パラメーター	Type	説明
payload	`string`	通知に含める JSON ペイロード

Device

{
  "id": "00000000-0000-0000-0000-000000000002",
  "name": "Device",
  "friendlyName": "Temperature Sensing Device",
  "description": "This device contains a sensor that captures temperature readings.",
  "type": "None",
  "subtype": "None",
  "typeId": 0,
  "subtypeId": 0,
  "hardwareId": "ABC123",
  "gatewayId": "ABC",
  "spaceId": "00000000-0000-0000-0000-000000000000"
}

デバイスのメソッド

Parent() ⇒ `space`

この関数は、現在のデバイスの親空間を返します。

ChildSensors() ⇒ `sensor[]`

この関数は、現在のデバイスの子センサーを返します。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

この関数は、現在のデバイスの拡張プロパティとその値を返します。

パラメーター	Type	説明
propertyName	`string`	拡張プロパティの名前

Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。

パラメーター	Type	説明
payload	`string`	通知に含める JSON ペイロード

Sensor

{
  "id": "00000000-0000-0000-0000-000000000003",
  "port": "30",
  "pollRate": 3600,
  "dataType": "Temperature",
  "dataSubtype": "None",
  "type": "Classic",
  "portType": "None",
  "dataUnitType": "FahrenheitTemperature",
  "spaceId": "00000000-0000-0000-0000-000000000000",
  "deviceId": "00000000-0000-0000-0000-000000000001",
  "portTypeId": 0,
  "dataUnitTypeId": 0,
  "dataTypeId": 0,
  "dataSubtypeId": 0,
  "typeId": 0  
}

センサーのメソッド

Space() ⇒ `space`

この関数は、現在のセンサーの親空間を返します。

Device() ⇒ `device`

この関数は、現在のセンサーの親デバイスを返します。

ExtendedProperty(propertyName) ⇒ `extendedProperty`

この関数は、現在のセンサーの拡張プロパティとその値を返します。

パラメーター	Type	説明
propertyName	`string`	拡張プロパティの名前

Value() ⇒ `value`

この関数は、現在のセンサーの値を返します。

History() ⇒ `value[]`

この関数は、現在のセンサーの履歴の値を返します。

Notify(payload)

この関数は、指定されたペイロードを含む通知を送信します。

パラメーター	Type	説明
payload	`string`	通知に含める JSON ペイロード

値

{
  "dataType": "Temperature",
  "value": "70",
  "createdTime": ""
}

拡張プロパティ

{
  "name": "OccupancyStatus",
  "value": "Occupied"
}

次の手順

Azure Digital Twins ユーザー定義関数について学習します。
ユーザー定義関数を作成する方法について学習します。
ユーザー定義関数をデバッグする方法について学習します。

ユーザー定義関数クライアント ライブラリ リファレンス

ヘルパー メソッド

getSpaceMetadata(id) ⇒ space

getSensorMetadata(id) ⇒ sensor

getDeviceMetadata(id) ⇒ device

getSensorValue(sensorId, dataType) ⇒ value

getSpaceValue(spaceId, valueName) ⇒ value

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

getSpaceChildSpaces(spaceId) ⇒ space[]

getSpaceChildSensors(spaceId) ⇒ sensor[]

getSpaceChildDevices(spaceId) ⇒ device[]

getDeviceChildSensors(deviceId) ⇒ sensor[]

getSpaceParentSpace(childSpaceId) ⇒ space

getSensorParentSpace(childSensorId) ⇒ space

getDeviceParentSpace(childDeviceId) ⇒ space

getSensorParentDevice(childSensorId) ⇒ space

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

setSensorValue(sensorId, dataType, value)

setSpaceValue(spaceId, dataType, value)

log(message)

sendNotification(topologyObjectId, topologyObjectType, payload)

戻り値の型

Space

空間メソッド

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ChildDevices() ⇒ device[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Value(valueName) ⇒ value

History(valueName) ⇒ value[]

Notify(payload)

Device

デバイスのメソッド

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Notify(payload)

Sensor

センサーのメソッド

Space() ⇒ space

Device() ⇒ device

ExtendedProperty(propertyName) ⇒ extendedProperty

Value() ⇒ value

History() ⇒ value[]

Notify(payload)

値

拡張プロパティ

次の手順

その他のリソース

ユーザー定義関数クライアントライブラリリファレンス

ヘルパーメソッド

getSpaceMetadata(id) ⇒ `space`

getSensorMetadata(id) ⇒ `sensor`

getDeviceMetadata(id) ⇒ `device`

getSensorValue(sensorId, dataType) ⇒ `value`

getSpaceValue(spaceId, valueName) ⇒ `value`

getSensorHistoryValues(sensorId, dataType) ⇒ `value[]`

getSpaceHistoryValues(spaceId, dataType) ⇒ `value[]`

getSpaceChildSpaces(spaceId) ⇒ `space[]`

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

getSpaceChildDevices(spaceId) ⇒ `device[]`

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

getSpaceParentSpace(childSpaceId) ⇒ `space`

getSensorParentSpace(childSensorId) ⇒ `space`

getDeviceParentSpace(childDeviceId) ⇒ `space`

getSensorParentDevice(childSensorId) ⇒ `space`

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ChildDevices() ⇒ `device[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value(valueName) ⇒ `value`

History(valueName) ⇒ `value[]`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Space() ⇒ `space`

Device() ⇒ `device`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value() ⇒ `value`

History() ⇒ `value[]`