Microsoft.IoTOperations 實例/dataflowProfiles/dataflows 2024-08-15-preview

• 最新
• 2024-11-01
• 2024-09-15-preview
• 2024-08-15-preview
• 2024-07-01-preview

Bicep 資源定義

實體/資料流Profiles/資料流資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 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 狀態存放區擴充數據的條件。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串
輸入	要從 Broker 狀態存放區擴充的欄位清單。	string[] （必要）
鑰匙	數據集的索引鍵。	字串 約束： 最大長度 = 64 （必要）
schemaRef	描述數據集之架構的參考。 允許：JSON 架構/draft-7。	字串

DataflowBuiltInTransformationFilter

名字	描述	價值
描述	使用者提供了篩選條件的選擇性描述。	字串 約束： 最大長度 = 256
表達	篩選數據的條件。 可以使用 {n} 參考輸入字段，其中 n 是從 1 開始輸入字段的索引。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串 （必要）
輸入	JSON 路徑表示式中篩選的欄位清單。	string[] （必要）
類型	數據流作業的類型。	'Filter'

DataflowBuiltInTransformationMap

名字	描述	價值
描述	使用者提供了對應函式的選擇性描述。	字串 約束： 最大長度 = 256
表達	將輸入欄位修改為最終輸出欄位。 範例：$1 * 2.2 （假設提供輸入區段 $1）	字串
輸入	JSON 路徑表示式中對應的欄位清單。	string[] （必要）
輸出	輸出記錄中要組織輸入欄位的位置和方式。	字串 （必要）
類型	轉換的類型。	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Rename'

DataflowBuiltInTransformationSettings

名字	描述	價值
數據	從 Broker 狀態存放區擴充數據。 數據集會參考 Broker 狀態存放區中的金鑰。	DataflowBuiltInTransformationDataset[]
濾波器	根據條件篩選輸入記錄或數據點。	DataflowBuiltInTransformationFilter[]
地圖	將輸入對應至輸出訊息。	DataflowBuiltInTransformationMap[]
schemaRef	描述轉換輸出之架構的參考。	字串
serializationFormat	串行化格式。 自選;預設為 JSON。 允許的 JSON 架構/draft-7、Parquet 值。 默認值：Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名字	描述	價值
dataDestination	目的地位置，可以是主題或數據表名稱。 支援具有$topic、$systemProperties、$userProperties、$payload、$context和$subscription的動態值。	字串 （必要）
endpointRef	端點 CR 的參考。 可以是 Broker、Kafka、Fabric、ADLS、ADX 類型。	字串 （必要）

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 類型。	字串 （必要）
schemaRef	架構CR參考。 數據會根據架構還原串行化，如果數據不相符，則會卸除。	字串
serializationFormat	內容是 JSON 架構。 允許：JSON 架構/draft-7。	'Json'

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串 （必要）
類型	ExtendedLocation 的類型。	'CustomLocation' （必要）

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

名字	描述	價值
extendedLocation	資源的邊緣位置。	ExtendedLocation （必要）
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 63 模式 = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ （必要）
父母	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型的資源符號名稱：實例/數據流屬性
性能	此資源的資源特定屬性。	DataflowProperties

ARM 樣本資源定義

實體/資料流Profiles/資料流資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 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 狀態存放區擴充數據的條件。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串
輸入	要從 Broker 狀態存放區擴充的欄位清單。	string[] （必要）
鑰匙	數據集的索引鍵。	字串 約束： 最大長度 = 64 （必要）
schemaRef	描述數據集之架構的參考。 允許：JSON 架構/draft-7。	字串

DataflowBuiltInTransformationFilter

名字	描述	價值
描述	使用者提供了篩選條件的選擇性描述。	字串 約束： 最大長度 = 256
表達	篩選數據的條件。 可以使用 {n} 參考輸入字段，其中 n 是從 1 開始輸入字段的索引。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串 （必要）
輸入	JSON 路徑表示式中篩選的欄位清單。	string[] （必要）
類型	數據流作業的類型。	'Filter'

DataflowBuiltInTransformationMap

名字	描述	價值
描述	使用者提供了對應函式的選擇性描述。	字串 約束： 最大長度 = 256
表達	將輸入欄位修改為最終輸出欄位。 範例：$1 * 2.2 （假設提供輸入區段 $1）	字串
輸入	JSON 路徑表示式中對應的欄位清單。	string[] （必要）
輸出	輸出記錄中要組織輸入欄位的位置和方式。	字串 （必要）
類型	轉換的類型。	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Rename'

DataflowBuiltInTransformationSettings

名字	描述	價值
數據	從 Broker 狀態存放區擴充數據。 數據集會參考 Broker 狀態存放區中的金鑰。	DataflowBuiltInTransformationDataset[]
濾波器	根據條件篩選輸入記錄或數據點。	DataflowBuiltInTransformationFilter[]
地圖	將輸入對應至輸出訊息。	DataflowBuiltInTransformationMap[]
schemaRef	描述轉換輸出之架構的參考。	字串
serializationFormat	串行化格式。 自選;預設為 JSON。 允許的 JSON 架構/draft-7、Parquet 值。 默認值：Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名字	描述	價值
dataDestination	目的地位置，可以是主題或數據表名稱。 支援具有$topic、$systemProperties、$userProperties、$payload、$context和$subscription的動態值。	字串 （必要）
endpointRef	端點 CR 的參考。 可以是 Broker、Kafka、Fabric、ADLS、ADX 類型。	字串 （必要）

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 類型。	字串 （必要）
schemaRef	架構CR參考。 數據會根據架構還原串行化，如果數據不相符，則會卸除。	字串
serializationFormat	內容是 JSON 架構。 允許：JSON 架構/draft-7。	'Json'

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串 （必要）
類型	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 提供者） 資源定義

實體/資料流Profiles/資料流資源類型可以使用目標作業來部署：

• 資源群組

如需每個 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 狀態存放區擴充數據的條件。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串
輸入	要從 Broker 狀態存放區擴充的欄位清單。	string[] （必要）
鑰匙	數據集的索引鍵。	字串 約束： 最大長度 = 64 （必要）
schemaRef	描述數據集之架構的參考。 允許：JSON 架構/draft-7。	字串

DataflowBuiltInTransformationFilter

名字	描述	價值
描述	使用者提供了篩選條件的選擇性描述。	字串 約束： 最大長度 = 256
表達	篩選數據的條件。 可以使用 {n} 參考輸入字段，其中 n 是從 1 開始輸入字段的索引。 範例：$1 < 0		$1 > $2 （假設輸入區段 $1 和 $2 提供）	字串 （必要）
輸入	JSON 路徑表示式中篩選的欄位清單。	string[] （必要）
類型	數據流作業的類型。	'Filter'

DataflowBuiltInTransformationMap

名字	描述	價值
描述	使用者提供了對應函式的選擇性描述。	字串 約束： 最大長度 = 256
表達	將輸入欄位修改為最終輸出欄位。 範例：$1 * 2.2 （假設提供輸入區段 $1）	字串
輸入	JSON 路徑表示式中對應的欄位清單。	string[] （必要）
輸出	輸出記錄中要組織輸入欄位的位置和方式。	字串 （必要）
類型	轉換的類型。	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Rename'

DataflowBuiltInTransformationSettings

名字	描述	價值
數據	從 Broker 狀態存放區擴充數據。 數據集會參考 Broker 狀態存放區中的金鑰。	DataflowBuiltInTransformationDataset[]
濾波器	根據條件篩選輸入記錄或數據點。	DataflowBuiltInTransformationFilter[]
地圖	將輸入對應至輸出訊息。	DataflowBuiltInTransformationMap[]
schemaRef	描述轉換輸出之架構的參考。	字串
serializationFormat	串行化格式。 自選;預設為 JSON。 允許的 JSON 架構/draft-7、Parquet 值。 默認值：Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

名字	描述	價值
dataDestination	目的地位置，可以是主題或數據表名稱。 支援具有$topic、$systemProperties、$userProperties、$payload、$context和$subscription的動態值。	字串 （必要）
endpointRef	端點 CR 的參考。 可以是 Broker、Kafka、Fabric、ADLS、ADX 類型。	字串 （必要）

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 類型。	字串 （必要）
schemaRef	架構CR參考。 數據會根據架構還原串行化，如果數據不相符，則會卸除。	字串
serializationFormat	內容是 JSON 架構。 允許：JSON 架構/draft-7。	'Json'

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串 （必要）
類型	ExtendedLocation 的類型。	'CustomLocation' （必要）

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

名字	描述	價值
extendedLocation	資源的邊緣位置。	ExtendedLocation （必要）
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 63 模式 = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ （必要）
parent_id	此資源為父系之資源的標識碼。	類型的資源標識碼：實例/數據流配置檔
性能	此資源的資源特定屬性。	DataflowProperties
類型	資源類型	“Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-08-15-preview”