Udostępnij przez

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

Definicja zasobu Bicep

Typ zasobu instances/dataflowProfiles/dataflows można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-09-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'
        }
      }
    ]
  }
}

Wartości właściwości

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
extendedLocation Lokalizacja krawędzi zasobu. ExtendedLocation (wymagane)
name Nazwa zasobu string

Constraints:
Minimalna długość = 3
Maksymalna długość = 63
Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: instances/dataflowProfiles
properties Właściwości specyficzne dla zasobu dla tego zasobu. DataflowProperties

DataflowBuiltInTransformationDataset

Name Description Value
description Użytkownik podał opcjonalny opis zestawu danych. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek wzbogacania danych z magazynu stanów brokera. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg
inputs Lista pól wzbogacających magazyn stanów brokera. string[] (wymagane)
klucz Klucz zestawu danych. string

Constraints:
Maksymalna długość = 64 (wymagana)
schemaRef Odwołanie do schematu opisującego zestaw danych. Dozwolone: schemat JSON/wersja robocza-7. ciąg

DataflowBuiltInTransformationFilter

Name Description Value
description Użytkownik podał opcjonalny opis filtru. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek filtrowania danych. Może odwoływać się do pól wejściowych z {n}, gdzie n jest indeksem pola wejściowego rozpoczynającego się od 1. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg (wymagany)
inputs Lista pól do filtrowania w wyrażeniu ścieżki JSON. string[] (wymagane)
typ Typ operacji przepływu danych. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Użytkownik podał opcjonalny opis funkcji mapowania. string

Constraints:
Maksymalna długość = 256
wyrażenie Zmodyfikuj pola wejściowe do końcowego pola wyjściowego. Przykład: $1 * 2.2 (Przy założeniu, że podano sekcję danych wejściowych $1) ciąg
inputs Lista pól do mapowania w wyrażeniu ścieżki JSON. string[] (wymagane)
We/Wy Gdzie i jak pola wejściowe mają być zorganizowane w rekordzie wyjściowym. ciąg (wymagany)
typ Typ przekształcenia. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Wzbogacanie danych z magazynu stanów brokera. Zestaw danych odwołuje się do klucza w magazynie stanów brokera. DataflowBuiltInTransformationDataset[]
filtr Filtruje rekord wejściowy lub punkty danych na podstawie warunku. DataflowBuiltInTransformationFilter[]
mapa Mapuje dane wejściowe na komunikat wyjściowy. DataflowBuiltInTransformationMap[]
schemaRef Odwołanie do schematu opisującego dane wyjściowe przekształcenia. ciąg
serializationFormat Format serializacji. Fakultatywny; wartość domyślna to JSON. Dozwolona wartość JSON Schema/draft-7, Parquet. Domyślnie: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Lokalizacja docelowa może być nazwą tematu lub tabeli. Obsługuje wartości dynamiczne z $topic, $systemProperties, $userProperties, $payload, $context i $subscription. string

Constraints:
Minimalna długość = 1 (wymagana)
endpointRef Odwołanie do punktu końcowego CR. Może to być typ Broker, Kafka, Fabric, ADLS, ADX. ciąg (wymagany)

DataflowOperation

Name Description Value
builtInTransformationSettings Wbudowana konfiguracja transformacji. DataflowBuiltInTransformationSettings
destinationSettings Konfiguracja miejsca docelowego. DataflowDestinationOperationSettings
name Opcjonalna nazwa użytkownika transformacji. string

Constraints:
Maksymalna długość = 64
operationType Typ operacji. 'BuiltInTransformation'
'Destination'
"Źródło" (wymagane)
sourceSettings Konfiguracja źródłowa. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Tryb przepływu danych. Fakultatywny; wartość domyślna to Włączone. 'Disabled'
'Enabled'
operations Lista operacji, w tym odwołania źródłowe i docelowe, a także transformacja. DataflowOperation[] (wymagane)

DataflowSourceOperationSettings

Name Description Value
assetRef Odwołanie do zasobu w usłudze Azure Device Registry, z którego pochodzą dane w punkcie końcowym. ciąg
dataSources Lista lokalizacji źródłowych. Mogą to być tematy brokera lub platformy Kafka. Obsługuje symbole wieloznaczne # i +. string

Constraints:
Minimalna długość = 1[] (wymagane)
endpointRef Odwołanie do zasobu punktu końcowego przepływu danych. Może to być tylko typ brokera i platformy Kafka. ciąg (wymagany)
schemaRef Odwołanie do schematu CR. Dane zostaną zdeserializowane zgodnie ze schematem i porzucone, jeśli nie są zgodne. ciąg
serializationFormat Zawartość jest schematem JSON. Dozwolone: schemat JSON/wersja robocza-7. 'Json'

ExtendedLocation

Name Description Value
name Nazwa lokalizacji rozszerzonej. ciąg (wymagany)
typ Typ extendedLocation. "CustomLocation" (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu instances/dataflowProfiles/dataflows można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows",
  "apiVersion": "2024-09-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"
        }
      }
    ]
  }
}

Wartości właściwości

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
apiVersion Wersja interfejsu API '2024-09-15-preview'
extendedLocation Lokalizacja krawędzi zasobu. ExtendedLocation (wymagane)
name Nazwa zasobu string

Constraints:
Minimalna długość = 3
Maksymalna długość = 63
Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane)
properties Właściwości specyficzne dla zasobu dla tego zasobu. DataflowProperties
typ Typ zasobu 'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

DataflowBuiltInTransformationDataset

Name Description Value
description Użytkownik podał opcjonalny opis zestawu danych. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek wzbogacania danych z magazynu stanów brokera. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg
inputs Lista pól wzbogacających magazyn stanów brokera. string[] (wymagane)
klucz Klucz zestawu danych. string

Constraints:
Maksymalna długość = 64 (wymagana)
schemaRef Odwołanie do schematu opisującego zestaw danych. Dozwolone: schemat JSON/wersja robocza-7. ciąg

DataflowBuiltInTransformationFilter

Name Description Value
description Użytkownik podał opcjonalny opis filtru. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek filtrowania danych. Może odwoływać się do pól wejściowych z {n}, gdzie n jest indeksem pola wejściowego rozpoczynającego się od 1. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg (wymagany)
inputs Lista pól do filtrowania w wyrażeniu ścieżki JSON. string[] (wymagane)
typ Typ operacji przepływu danych. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Użytkownik podał opcjonalny opis funkcji mapowania. string

Constraints:
Maksymalna długość = 256
wyrażenie Zmodyfikuj pola wejściowe do końcowego pola wyjściowego. Przykład: $1 * 2.2 (Przy założeniu, że podano sekcję danych wejściowych $1) ciąg
inputs Lista pól do mapowania w wyrażeniu ścieżki JSON. string[] (wymagane)
We/Wy Gdzie i jak pola wejściowe mają być zorganizowane w rekordzie wyjściowym. ciąg (wymagany)
typ Typ przekształcenia. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Wzbogacanie danych z magazynu stanów brokera. Zestaw danych odwołuje się do klucza w magazynie stanów brokera. DataflowBuiltInTransformationDataset[]
filtr Filtruje rekord wejściowy lub punkty danych na podstawie warunku. DataflowBuiltInTransformationFilter[]
mapa Mapuje dane wejściowe na komunikat wyjściowy. DataflowBuiltInTransformationMap[]
schemaRef Odwołanie do schematu opisującego dane wyjściowe przekształcenia. ciąg
serializationFormat Format serializacji. Fakultatywny; wartość domyślna to JSON. Dozwolona wartość JSON Schema/draft-7, Parquet. Domyślnie: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Lokalizacja docelowa może być nazwą tematu lub tabeli. Obsługuje wartości dynamiczne z $topic, $systemProperties, $userProperties, $payload, $context i $subscription. string

Constraints:
Minimalna długość = 1 (wymagana)
endpointRef Odwołanie do punktu końcowego CR. Może to być typ Broker, Kafka, Fabric, ADLS, ADX. ciąg (wymagany)

DataflowOperation

Name Description Value
builtInTransformationSettings Wbudowana konfiguracja transformacji. DataflowBuiltInTransformationSettings
destinationSettings Konfiguracja miejsca docelowego. DataflowDestinationOperationSettings
name Opcjonalna nazwa użytkownika transformacji. string

Constraints:
Maksymalna długość = 64
operationType Typ operacji. 'BuiltInTransformation'
'Destination'
"Źródło" (wymagane)
sourceSettings Konfiguracja źródłowa. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Tryb przepływu danych. Fakultatywny; wartość domyślna to Włączone. 'Disabled'
'Enabled'
operations Lista operacji, w tym odwołania źródłowe i docelowe, a także transformacja. DataflowOperation[] (wymagane)

DataflowSourceOperationSettings

Name Description Value
assetRef Odwołanie do zasobu w usłudze Azure Device Registry, z którego pochodzą dane w punkcie końcowym. ciąg
dataSources Lista lokalizacji źródłowych. Mogą to być tematy brokera lub platformy Kafka. Obsługuje symbole wieloznaczne # i +. string

Constraints:
Minimalna długość = 1[] (wymagane)
endpointRef Odwołanie do zasobu punktu końcowego przepływu danych. Może to być tylko typ brokera i platformy Kafka. ciąg (wymagany)
schemaRef Odwołanie do schematu CR. Dane zostaną zdeserializowane zgodnie ze schematem i porzucone, jeśli nie są zgodne. ciąg
serializationFormat Zawartość jest schematem JSON. Dozwolone: schemat JSON/wersja robocza-7. 'Json'

ExtendedLocation

Name Description Value
name Nazwa lokalizacji rozszerzonej. ciąg (wymagany)
typ Typ extendedLocation. "CustomLocation" (wymagane)

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu instances/dataflowProfiles/dataflows można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-09-15-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
          }
        }
      ]
    }
  }
}

Wartości właściwości

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
extendedLocation Lokalizacja krawędzi zasobu. ExtendedLocation (wymagane)
name Nazwa zasobu string

Constraints:
Minimalna długość = 3
Maksymalna długość = 63
Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: instances/dataflowProfiles
properties Właściwości specyficzne dla zasobu dla tego zasobu. DataflowProperties
typ Typ zasobu "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-09-15-preview"

DataflowBuiltInTransformationDataset

Name Description Value
description Użytkownik podał opcjonalny opis zestawu danych. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek wzbogacania danych z magazynu stanów brokera. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg
inputs Lista pól wzbogacających magazyn stanów brokera. string[] (wymagane)
klucz Klucz zestawu danych. string

Constraints:
Maksymalna długość = 64 (wymagana)
schemaRef Odwołanie do schematu opisującego zestaw danych. Dozwolone: schemat JSON/wersja robocza-7. ciąg

DataflowBuiltInTransformationFilter

Name Description Value
description Użytkownik podał opcjonalny opis filtru. string

Constraints:
Maksymalna długość = 256
wyrażenie Warunek filtrowania danych. Może odwoływać się do pól wejściowych z {n}, gdzie n jest indeksem pola wejściowego rozpoczynającego się od 1. Przykład: $1 < 0 || $1 > $2 (Zakładając, że podano sekcję wprowadzania $1 i $2) ciąg (wymagany)
inputs Lista pól do filtrowania w wyrażeniu ścieżki JSON. string[] (wymagane)
typ Typ operacji przepływu danych. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Użytkownik podał opcjonalny opis funkcji mapowania. string

Constraints:
Maksymalna długość = 256
wyrażenie Zmodyfikuj pola wejściowe do końcowego pola wyjściowego. Przykład: $1 * 2.2 (Przy założeniu, że podano sekcję danych wejściowych $1) ciąg
inputs Lista pól do mapowania w wyrażeniu ścieżki JSON. string[] (wymagane)
We/Wy Gdzie i jak pola wejściowe mają być zorganizowane w rekordzie wyjściowym. ciąg (wymagany)
typ Typ przekształcenia. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Wzbogacanie danych z magazynu stanów brokera. Zestaw danych odwołuje się do klucza w magazynie stanów brokera. DataflowBuiltInTransformationDataset[]
filtr Filtruje rekord wejściowy lub punkty danych na podstawie warunku. DataflowBuiltInTransformationFilter[]
mapa Mapuje dane wejściowe na komunikat wyjściowy. DataflowBuiltInTransformationMap[]
schemaRef Odwołanie do schematu opisującego dane wyjściowe przekształcenia. ciąg
serializationFormat Format serializacji. Fakultatywny; wartość domyślna to JSON. Dozwolona wartość JSON Schema/draft-7, Parquet. Domyślnie: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Lokalizacja docelowa może być nazwą tematu lub tabeli. Obsługuje wartości dynamiczne z $topic, $systemProperties, $userProperties, $payload, $context i $subscription. string

Constraints:
Minimalna długość = 1 (wymagana)
endpointRef Odwołanie do punktu końcowego CR. Może to być typ Broker, Kafka, Fabric, ADLS, ADX. ciąg (wymagany)

DataflowOperation

Name Description Value
builtInTransformationSettings Wbudowana konfiguracja transformacji. DataflowBuiltInTransformationSettings
destinationSettings Konfiguracja miejsca docelowego. DataflowDestinationOperationSettings
name Opcjonalna nazwa użytkownika transformacji. string

Constraints:
Maksymalna długość = 64
operationType Typ operacji. 'BuiltInTransformation'
'Destination'
"Źródło" (wymagane)
sourceSettings Konfiguracja źródłowa. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Tryb przepływu danych. Fakultatywny; wartość domyślna to Włączone. 'Disabled'
'Enabled'
operations Lista operacji, w tym odwołania źródłowe i docelowe, a także transformacja. DataflowOperation[] (wymagane)

DataflowSourceOperationSettings

Name Description Value
assetRef Odwołanie do zasobu w usłudze Azure Device Registry, z którego pochodzą dane w punkcie końcowym. ciąg
dataSources Lista lokalizacji źródłowych. Mogą to być tematy brokera lub platformy Kafka. Obsługuje symbole wieloznaczne # i +. string

Constraints:
Minimalna długość = 1[] (wymagane)
endpointRef Odwołanie do zasobu punktu końcowego przepływu danych. Może to być tylko typ brokera i platformy Kafka. ciąg (wymagany)
schemaRef Odwołanie do schematu CR. Dane zostaną zdeserializowane zgodnie ze schematem i porzucone, jeśli nie są zgodne. ciąg
serializationFormat Zawartość jest schematem JSON. Dozwolone: schemat JSON/wersja robocza-7. 'Json'

ExtendedLocation

Name Description Value
name Nazwa lokalizacji rozszerzonej. ciąg (wymagany)
typ Typ extendedLocation. "CustomLocation" (wymagane)
  • Last updated on