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

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

重要

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

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

このドキュメントでは、Azure Digital Twins ユーザー定義関数クライアントライブラリのリファレンス情報を提供します。

ヘルパーメソッド

クライアントライブラリは、一般的に使用される操作のヘルパーメソッドを定義します。

getSpaceMetadata(id) ⇒ `space`

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

Kind: グローバル関数

パラメーター	タイプ	説明
ID	`guid`	スペース識別子

getSensorMetadata(id) ⇒ `sensor`

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

Kind: グローバル関数

パラメーター	タイプ	説明
ID	`guid`	センサー識別子

getDeviceMetadata(id) ⇒ `device`

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

Kind: グローバル関数

パラメーター	タイプ	説明
ID	`guid`	デバイス識別子

getSensorValue(sensorId, dataType) ⇒ `value`

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

Kind: グローバル関数

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

getSpaceValue(spaceId, valueName) ⇒ `value`

スペース識別子と値名を指定すると、この関数はそのスペースプロパティの現在の値を取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
を spaceId する	`guid`	スペース識別子
に valueName を設定する	`string`	Space プロパティ名

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

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

Kind: グローバル関数

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

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

スペース識別子と値名を指定すると、この関数はスペース上のそのプロパティの履歴値を取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
スペースIDをする	`guid`	スペース識別子
valueName をする	`string`	スペースプロパティ名

getSpaceChildSpaces(spaceId) ⇒ `space[]`

スペース識別子を指定すると、この関数はその親スペースの子スペースを取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
のspaceId	`guid`	スペース識別子

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

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

Kind: グローバル関数

パラメーター	タイプ	説明
spaceId をする	`guid`	スペース識別子

スペース子デバイスを取得する(spaceId) ⇒ `device[]`

スペース識別子を指定すると、この関数はその親スペースの子デバイスを取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
spaceId をする	`guid`	スペース識別子

getDeviceChildSensors(deviceId) はデバイスの子センサーを取得します ⇒ `sensor[]`

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

Kind: グローバル関数

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

getSpaceParentSpace(childSpaceId) ⇒ `space`

スペース識別子を指定すると、この関数は親スペースを取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
子スペースID	`guid`	スペース識別子

getSensorParentSpace(childSensorId) ⇒ `space`

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

Kind: グローバル関数

パラメーター	タイプ	説明
childSensorId をする	`guid`	センサー識別子

getDeviceParentSpace(childDeviceId) ⇒ `space`

デバイス識別子を指定すると、この関数は親スペースを取得します。

Kind: グローバル関数

パラメーター	タイプ	説明
: 子デバイスID	`guid`	デバイス識別子

getSensorParentDevice(childSensorId) ⇒ `space`

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

Kind: グローバル関数

パラメーター	タイプ	説明
を childSensorId に適用する	`guid`	センサー識別子

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

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

Kind: グローバル関数

パラメーター	タイプ	説明
spaceId をする	`guid`	スペース識別子
プロパティ名	`string`	スペースプロパティ名

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

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

Kind: グローバル関数

パラメーター	タイプ	説明
sensorIdを設定する	`guid`	センサー識別子
PropertyName	`string`	センサーのプロパティ名

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

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

Kind: グローバル関数

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

setSensorValue(sensorId, dataType, value)

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

Kind: グローバル関数

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

setSpaceValue(spaceId, dataType, value)

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

Kind: グローバル関数

パラメーター	タイプ	説明
で spaceId を行う	`guid`	スペース識別子
dataType	`string`	データ型
の値	`string`	価値

log(message)

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

Kind: グローバル関数

パラメーター	タイプ	説明
メッセージ	`string`	ログに記録されるメッセージ

sendNotification(topologyObjectId, topologyObjectType, payload)

この関数は、カスタム通知を送信して配信されるようにします。

Kind: グローバル関数

パラメーター	タイプ	説明
のトポロジーオブジェクトID	`guid`	グラフオブジェクト識別子。たとえば、スペース、センサー、デバイス ID などです。
トポロジオブジェクトタイプ	`string`	例として、センサーとデバイスがあります。
ペイロード	`string`	通知と共に送信される JSON ペイロード。

戻り値の型

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

宇宙

{
  "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`

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

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

Value(valueName) ⇒ `value`

この関数は、現在のスペースの値を返します。

パラメーター	タイプ	説明
のvalueName	`string`	値の名前

History(valueName) ⇒ `value[]`

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

パラメーター	タイプ	説明
valueName をする	`string`	値の名前

通知(payload)

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

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

デバイス

{
  "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`

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

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

通知(ペイロード)

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

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

センサー

{
  "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`

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

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

Value() ⇒ `value`

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

History() ⇒ `value[]`

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

通知(ペイロード)

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

パラメーター	タイプ	説明
ペイロード	`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[]

スペース子デバイスを取得する(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)

戻り値の型

宇宙

スペースメソッド

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ChildDevices() ⇒ device[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Value(valueName) ⇒ value

History(valueName) ⇒ value[]

通知(payload)

デバイス

デバイス メソッド

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ExtendedProperty(propertyName) ⇒ extendedProperty

通知(ペイロード)

センサー

センサーメソッド

Space() ⇒ space

Device() ⇒ device

ExtendedProperty(propertyName) ⇒ extendedProperty

Value() ⇒ value

History() ⇒ value[]

通知(ペイロード)

価値

拡張された特性

次のステップ

その他のリソース

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

ヘルパーメソッド

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[]`

スペース子デバイスを取得する(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[]`