Microsoft.IoTOperations instances/dataflowProfiles/dataflows 2024-08-15-preview

• 最新の を する
• 2024-11-01
• 2024-09-15-preview
• 2024-08-15-preview
• 2024-07-01-preview

Bicep リソース定義

instances/dataflowProfiles/dataflows リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-08-15-preview' = {
  parent: resourceSymbolicName
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  name: 'string'
  properties: {
    mode: 'string'
    operations: [
      {
        builtInTransformationSettings: {
          datasets: [
            {
              description: 'string'
              expression: 'string'
              inputs: [
                'string'
              ]
              key: 'string'
              schemaRef: 'string'
            }
          ]
          filter: [
            {
              description: 'string'
              expression: 'string'
              inputs: [
                'string'
              ]
              type: 'string'
            }
          ]
          map: [
            {
              description: 'string'
              expression: 'string'
              inputs: [
                'string'
              ]
              output: 'string'
              type: 'string'
            }
          ]
          schemaRef: 'string'
          serializationFormat: 'string'
        }
        destinationSettings: {
          dataDestination: 'string'
          endpointRef: 'string'
        }
        name: 'string'
        operationType: 'string'
        sourceSettings: {
          assetRef: 'string'
          dataSources: [
            'string'
          ]
          endpointRef: 'string'
          schemaRef: 'string'
          serializationFormat: 'string'
        }
      }
    ]
  }
}

プロパティ値

DataflowBuiltInTransformationDataset

名前	形容	価値
形容	ユーザーがデータセットの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	Broker State Store からデータをエンリッチする条件。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	糸
入力	Broker State Store からエンリッチメントするためのフィールドの一覧。	string[] (必須)
鍵	データセットのキー。	糸 制約： 最大長 = 64 (必須)
schemaRef	データセットを記述するスキーマへの参照。 許可: JSON スキーマ/draft-7。	糸

DataflowBuiltInTransformationFilter

名前	形容	価値
形容	ユーザーがフィルターの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	データをフィルター処理する条件。 {n} で入力フィールドを参照できます。ここで、n は 1 から始まる入力フィールドのインデックスです。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	string (必須)
入力	JSON パス式でフィルター処理するためのフィールドの一覧。	string[] (必須)
種類	データフロー操作の種類。	'Filter'

DataflowBuiltInTransformationMap

名前	形容	価値
形容	ユーザーがマッピング関数の説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	入力フィールドを最終的な出力フィールドに変更します。 例: $1 * 2.2 (入力セクション $1 が指定されていると仮定)	糸
入力	JSON パス式でのマッピングのフィールドの一覧。	string[] (必須)
アウトプット	出力レコードで入力フィールドを編成する場所と方法。	string (必須)
種類	変換の種類。	'BuiltInFunction' 'Compute' 'NewProperties' 'パススルー' 'Rename'

DataflowBuiltInTransformationSettings

名前	形容	価値
データセット	Broker State Store からデータをエンリッチする。 データセットは、Broker State Store のキーを参照します。	DataflowBuiltInTransformationDataset[]
フィルター	条件に基づいて入力レコードまたはデータポイントをフィルター処理します。	DataflowBuiltInTransformationFilter[]
地図	入力を出力メッセージにマップします。	DataflowBuiltInTransformationMap[]
schemaRef	変換の出力を記述するスキーマへの参照。	糸
serializationFormat	シリアル化形式。 随意;は既定で JSON に設定されます。 許可される値 JSON スキーマ/draft-7、Parquet。 既定値: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名前	形容	価値
dataDestination	宛先の場所は、トピックまたはテーブル名にすることができます。 $topic、$systemProperties、$userProperties、$payload、$context、および$subscriptionで動的な値をサポートします。	string (必須)
endpointRef	エンドポイント CR への参照。 Broker、Kafka、Fabric、ADLS、ADX の種類を指定できます。	string (必須)

DataflowOperation

名前	形容	価値
builtInTransformationSettings	組み込みの変換構成。	DataflowBuiltInTransformationSettings
destinationSettings	変換先の構成。	DataflowDestinationOperationSettings
名前	省略可能なユーザー指定の変換の名前。	糸 制約： 最大長 = 64
operationType	操作の種類。	'BuiltInTransformation' 'Destination' 'Source' (必須)
sourceSettings	ソース構成。	DataflowSourceOperationSettings

DataflowProperties

名前	形容	価値
モード	データフローのモード。 随意;は既定で [有効] に設定されます。	'Disabled' 'Enabled'
オペレーションズ	変換元と変換先の参照を含む操作の一覧。	DataflowOperation[] (必須)

DataflowSourceOperationSettings

名前	形容	価値
assetRef	エンドポイント内のデータの発信元である Azure Device Registry 内のリソースへの参照。	糸
dataSources	ソースの場所の一覧。 Broker トピックまたは Kafka トピックを指定できます。 ワイルドカード # と +をサポートします。	string[] (必須)
endpointRef	データフロー エンドポイント リソースへの参照。 Broker 型と Kafka 型のみを指定できます。	string (必須)
schemaRef	スキーマ CR リファレンス。 データはスキーマに従って逆シリアル化され、一致しない場合は削除されます。	糸
serializationFormat	コンテンツは JSON スキーマです。 許可: JSON スキーマ/draft-7。	'Json'

ExtendedLocation

名前	形容	価値
名前	拡張された場所の名前。	string (必須)
種類	ExtendedLocation の種類。	'CustomLocation' (必須)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

名前	形容	価値
extendedLocation	リソースのエッジの場所。	ExtendedLocation (必須)
名前	リソース名	糸 制約： 最小長 = 3 最大長 = 63 パターン = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: instances/dataflowProfiles
プロパティ	このリソースのリソース固有のプロパティ。	DataflowProperties

ARM テンプレート リソース定義

instances/dataflowProfiles/dataflows リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows",
  "apiVersion": "2024-08-15-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "properties": {
    "mode": "string",
    "operations": [
      {
        "builtInTransformationSettings": {
          "datasets": [
            {
              "description": "string",
              "expression": "string",
              "inputs": [ "string" ],
              "key": "string",
              "schemaRef": "string"
            }
          ],
          "filter": [
            {
              "description": "string",
              "expression": "string",
              "inputs": [ "string" ],
              "type": "string"
            }
          ],
          "map": [
            {
              "description": "string",
              "expression": "string",
              "inputs": [ "string" ],
              "output": "string",
              "type": "string"
            }
          ],
          "schemaRef": "string",
          "serializationFormat": "string"
        },
        "destinationSettings": {
          "dataDestination": "string",
          "endpointRef": "string"
        },
        "name": "string",
        "operationType": "string",
        "sourceSettings": {
          "assetRef": "string",
          "dataSources": [ "string" ],
          "endpointRef": "string",
          "schemaRef": "string",
          "serializationFormat": "string"
        }
      }
    ]
  }
}

プロパティ値

DataflowBuiltInTransformationDataset

名前	形容	価値
形容	ユーザーがデータセットの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	Broker State Store からデータをエンリッチする条件。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	糸
入力	Broker State Store からエンリッチメントするためのフィールドの一覧。	string[] (必須)
鍵	データセットのキー。	糸 制約： 最大長 = 64 (必須)
schemaRef	データセットを記述するスキーマへの参照。 許可: JSON スキーマ/draft-7。	糸

DataflowBuiltInTransformationFilter

名前	形容	価値
形容	ユーザーがフィルターの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	データをフィルター処理する条件。 {n} で入力フィールドを参照できます。ここで、n は 1 から始まる入力フィールドのインデックスです。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	string (必須)
入力	JSON パス式でフィルター処理するためのフィールドの一覧。	string[] (必須)
種類	データフロー操作の種類。	'Filter'

DataflowBuiltInTransformationMap

名前	形容	価値
形容	ユーザーがマッピング関数の説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	入力フィールドを最終的な出力フィールドに変更します。 例: $1 * 2.2 (入力セクション $1 が指定されていると仮定)	糸
入力	JSON パス式でのマッピングのフィールドの一覧。	string[] (必須)
アウトプット	出力レコードで入力フィールドを編成する場所と方法。	string (必須)
種類	変換の種類。	'BuiltInFunction' 'Compute' 'NewProperties' 'パススルー' 'Rename'

DataflowBuiltInTransformationSettings

名前	形容	価値
データセット	Broker State Store からデータをエンリッチする。 データセットは、Broker State Store のキーを参照します。	DataflowBuiltInTransformationDataset[]
フィルター	条件に基づいて入力レコードまたはデータポイントをフィルター処理します。	DataflowBuiltInTransformationFilter[]
地図	入力を出力メッセージにマップします。	DataflowBuiltInTransformationMap[]
schemaRef	変換の出力を記述するスキーマへの参照。	糸
serializationFormat	シリアル化形式。 随意;は既定で JSON に設定されます。 許可される値 JSON スキーマ/draft-7、Parquet。 既定値: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名前	形容	価値
dataDestination	宛先の場所は、トピックまたはテーブル名にすることができます。 $topic、$systemProperties、$userProperties、$payload、$context、および$subscriptionで動的な値をサポートします。	string (必須)
endpointRef	エンドポイント CR への参照。 Broker、Kafka、Fabric、ADLS、ADX の種類を指定できます。	string (必須)

DataflowOperation

名前	形容	価値
builtInTransformationSettings	組み込みの変換構成。	DataflowBuiltInTransformationSettings
destinationSettings	変換先の構成。	DataflowDestinationOperationSettings
名前	省略可能なユーザー指定の変換の名前。	糸 制約： 最大長 = 64
operationType	操作の種類。	'BuiltInTransformation' 'Destination' 'Source' (必須)
sourceSettings	ソース構成。	DataflowSourceOperationSettings

DataflowProperties

名前	形容	価値
モード	データフローのモード。 随意;は既定で [有効] に設定されます。	'Disabled' 'Enabled'
オペレーションズ	変換元と変換先の参照を含む操作の一覧。	DataflowOperation[] (必須)

DataflowSourceOperationSettings

名前	形容	価値
assetRef	エンドポイント内のデータの発信元である Azure Device Registry 内のリソースへの参照。	糸
dataSources	ソースの場所の一覧。 Broker トピックまたは Kafka トピックを指定できます。 ワイルドカード # と +をサポートします。	string[] (必須)
endpointRef	データフロー エンドポイント リソースへの参照。 Broker 型と Kafka 型のみを指定できます。	string (必須)
schemaRef	スキーマ CR リファレンス。 データはスキーマに従って逆シリアル化され、一致しない場合は削除されます。	糸
serializationFormat	コンテンツは JSON スキーマです。 許可: JSON スキーマ/draft-7。	'Json'

ExtendedLocation

名前	形容	価値
名前	拡張された場所の名前。	string (必須)
種類	ExtendedLocation の種類。	'CustomLocation' (必須)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

名前	形容	価値
apiVersion	API のバージョン	'2024-08-15-preview'
extendedLocation	リソースのエッジの場所。	ExtendedLocation (必須)
名前	リソース名	糸 制約： 最小長 = 3 最大長 = 63 パターン = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必須)
プロパティ	このリソースのリソース固有のプロパティ。	DataflowProperties
種類	リソースの種類	'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

Terraform (AzAPI プロバイダー) リソース定義

instances/dataflowProfiles/dataflows リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-08-15-preview"
  name = "string"
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      mode = "string"
      operations = [
        {
          builtInTransformationSettings = {
            datasets = [
              {
                description = "string"
                expression = "string"
                inputs = [
                  "string"
                ]
                key = "string"
                schemaRef = "string"
              }
            ]
            filter = [
              {
                description = "string"
                expression = "string"
                inputs = [
                  "string"
                ]
                type = "string"
              }
            ]
            map = [
              {
                description = "string"
                expression = "string"
                inputs = [
                  "string"
                ]
                output = "string"
                type = "string"
              }
            ]
            schemaRef = "string"
            serializationFormat = "string"
          }
          destinationSettings = {
            dataDestination = "string"
            endpointRef = "string"
          }
          name = "string"
          operationType = "string"
          sourceSettings = {
            assetRef = "string"
            dataSources = [
              "string"
            ]
            endpointRef = "string"
            schemaRef = "string"
            serializationFormat = "string"
          }
        }
      ]
    }
  })
}

プロパティ値

DataflowBuiltInTransformationDataset

名前	形容	価値
形容	ユーザーがデータセットの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	Broker State Store からデータをエンリッチする条件。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	糸
入力	Broker State Store からエンリッチメントするためのフィールドの一覧。	string[] (必須)
鍵	データセットのキー。	糸 制約： 最大長 = 64 (必須)
schemaRef	データセットを記述するスキーマへの参照。 許可: JSON スキーマ/draft-7。	糸

DataflowBuiltInTransformationFilter

名前	形容	価値
形容	ユーザーがフィルターの説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	データをフィルター処理する条件。 {n} で入力フィールドを参照できます。ここで、n は 1 から始まる入力フィールドのインデックスです。 例: $1 < 0		$1 > $2 (入力セクション $1 と $2 が指定されていると仮定)	string (必須)
入力	JSON パス式でフィルター処理するためのフィールドの一覧。	string[] (必須)
種類	データフロー操作の種類。	'Filter'

DataflowBuiltInTransformationMap

名前	形容	価値
形容	ユーザーがマッピング関数の説明を省略可能に指定しました。	糸 制約： 最大長 = 256
表現	入力フィールドを最終的な出力フィールドに変更します。 例: $1 * 2.2 (入力セクション $1 が指定されていると仮定)	糸
入力	JSON パス式でのマッピングのフィールドの一覧。	string[] (必須)
アウトプット	出力レコードで入力フィールドを編成する場所と方法。	string (必須)
種類	変換の種類。	'BuiltInFunction' 'Compute' 'NewProperties' 'パススルー' 'Rename'

DataflowBuiltInTransformationSettings

名前	形容	価値
データセット	Broker State Store からデータをエンリッチする。 データセットは、Broker State Store のキーを参照します。	DataflowBuiltInTransformationDataset[]
フィルター	条件に基づいて入力レコードまたはデータポイントをフィルター処理します。	DataflowBuiltInTransformationFilter[]
地図	入力を出力メッセージにマップします。	DataflowBuiltInTransformationMap[]
schemaRef	変換の出力を記述するスキーマへの参照。	糸
serializationFormat	シリアル化形式。 随意;は既定で JSON に設定されます。 許可される値 JSON スキーマ/draft-7、Parquet。 既定値: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名前	形容	価値
dataDestination	宛先の場所は、トピックまたはテーブル名にすることができます。 $topic、$systemProperties、$userProperties、$payload、$context、および$subscriptionで動的な値をサポートします。	string (必須)
endpointRef	エンドポイント CR への参照。 Broker、Kafka、Fabric、ADLS、ADX の種類を指定できます。	string (必須)

DataflowOperation

名前	形容	価値
builtInTransformationSettings	組み込みの変換構成。	DataflowBuiltInTransformationSettings
destinationSettings	変換先の構成。	DataflowDestinationOperationSettings
名前	省略可能なユーザー指定の変換の名前。	糸 制約： 最大長 = 64
operationType	操作の種類。	'BuiltInTransformation' 'Destination' 'Source' (必須)
sourceSettings	ソース構成。	DataflowSourceOperationSettings

DataflowProperties

名前	形容	価値
モード	データフローのモード。 随意;は既定で [有効] に設定されます。	'Disabled' 'Enabled'
オペレーションズ	変換元と変換先の参照を含む操作の一覧。	DataflowOperation[] (必須)

DataflowSourceOperationSettings

名前	形容	価値
assetRef	エンドポイント内のデータの発信元である Azure Device Registry 内のリソースへの参照。	糸
dataSources	ソースの場所の一覧。 Broker トピックまたは Kafka トピックを指定できます。 ワイルドカード # と +をサポートします。	string[] (必須)
endpointRef	データフロー エンドポイント リソースへの参照。 Broker 型と Kafka 型のみを指定できます。	string (必須)
schemaRef	スキーマ CR リファレンス。 データはスキーマに従って逆シリアル化され、一致しない場合は削除されます。	糸
serializationFormat	コンテンツは JSON スキーマです。 許可: JSON スキーマ/draft-7。	'Json'

ExtendedLocation

名前	形容	価値
名前	拡張された場所の名前。	string (必須)
種類	ExtendedLocation の種類。	'CustomLocation' (必須)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

名前	形容	価値
extendedLocation	リソースのエッジの場所。	ExtendedLocation (必須)
名前	リソース名	糸 制約： 最小長 = 3 最大長 = 63 パターン = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: instances/dataflowProfiles
プロパティ	このリソースのリソース固有のプロパティ。	DataflowProperties
種類	リソースの種類	"Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-08-15-preview"