Freigeben über

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

Bicep-Ressourcendefinition

Der Ressourcentyp "instances/dataflowProfiles/dataflows" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.IoTOperations/instances/dataflowProfiles/dataflows-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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'
        }
      }
    ]
  }
}

Eigenschaftswerte

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
extendedLocation Edgespeicherort der Ressource. ExtendedLocation (erforderlich)
name Der Ressourcenname string

Constraints:
Min. Länge = 3
Max. Länge = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource des Typs: Instanzen/dataflowProfiles
properties Die ressourcenspezifischen Eigenschaften für diese Ressource. DataflowProperties

DataflowBuiltInTransformationDataset

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Datasets bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Anreichern von Daten aus dem Broker State Store. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) string
inputs Liste der Felder zum Anreichern aus dem Broker State Store. string[] (erforderlich)
key Der Schlüssel des Datasets. string

Constraints:
Max. Länge = 64 (erforderlich)
schemaRef Der Verweis auf das Schema, das das Dataset beschreibt. Zulässig: JSON-Schema/Draft-7. string

DataflowBuiltInTransformationFilter

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Filters bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Filtern von Daten. Kann auf Eingabefelder mit {n} verweisen, wobei n der Index des Eingabefelds ab 1 ist. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) Zeichenfolge (erforderlich)
inputs Liste der Felder zum Filtern im JSON-Pfadausdruck. string[] (erforderlich)
type Der Typ des Datenflussvorgangs. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung der Zuordnungsfunktion bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Ändern Sie die Eingabefelder in das endgültige Ausgabefeld. Beispiel: $1 * 2,2 (Vorausgesetzt, der Eingabeabschnitt $1 wird bereitgestellt) string
inputs Liste der Felder für die Zuordnung im JSON-Pfadausdruck. string[] (erforderlich)
output Wo und wie die Eingabefelder im Ausgabedatensatz angeordnet werden sollen. Zeichenfolge (erforderlich)
type Typ der Transformation. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Anreichern von Daten aus dem Broker State Store. Dataset verweist auf einen Schlüssel im Broker State Store. DataflowBuiltInTransformationDataset[]
filter Filtert Eingabedatensätze oder Datenpunkte basierend auf der Bedingung. DataflowBuiltInTransformationFilter[]
map Ordnet Eingaben der Ausgabenachricht zu. DataflowBuiltInTransformationMap[]
schemaRef Verweisen Sie auf das Schema, das die Ausgabe der Transformation beschreibt. string
serializationFormat Serialisierungsformat. Wahlfrei; Standardmäßig wird JSON verwendet. Zulässiger Wert JSON-Schema/Draft-7, Parkett. Standardwert: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Zielspeicherort kann ein Thema oder ein Tabellenname sein. Unterstützt dynamische Werte mit $topic, $systemProperties, $userProperties, $payload, $context und $subscription. string

Constraints:
Min. Länge = 1 (erforderlich)
endpointRef Verweis auf Endpunkt CR. Dies kann der Typ Broker, Kafka, Fabric, ADLS, ADX sein. Zeichenfolge (erforderlich)

DataflowOperation

Name Description Value
builtInTransformationSettings Integrierte Transformationskonfiguration. DataflowBuiltInTransformationSettings
destinationSettings Konfiguration des Ziels. DataflowDestinationOperationSettings
name Optionaler Benutzername der Transformation. string

Constraints:
Max. Länge = 64
operationType Typ des Vorgangs. 'BuiltInTransformation'
'Destination'
'Quelle' (erforderlich)
sourceSettings Konfiguration der Quelle. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Modus für Dataflow. Wahlfrei; standardmäßig auf "Aktiviert" festgelegt. 'Disabled'
'Enabled'
operations Liste der Vorgänge, einschließlich Quell- und Zielverweise sowie Transformation. DataflowOperation[] (erforderlich)

DataflowSourceOperationSettings

Name Description Value
assetRef Verweisen Sie auf die Ressource in der Azure-Geräteregistrierung, von der die Daten im Endpunkt stammen. string
dataSources Liste der Quellspeicherorte. Kann Broker- oder Kafka-Themen sein. Unterstützt Platzhalter # und +. string

Constraints:
Min. Länge = 1[] (erforderlich)
endpointRef Verweisen auf die Dataflow-Endpunktressource. Kann nur vom Typ Broker und Kafka sein. Zeichenfolge (erforderlich)
schemaRef Schema CR-Referenz. Die Daten werden gemäß dem Schema deserialisiert und gelöscht, wenn sie nicht übereinstimmen. string
serializationFormat Inhalt ist ein JSON-Schema. Zulässig: JSON-Schema/Draft-7. 'Json'

ExtendedLocation

Name Description Value
name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
type Typ von ExtendedLocation. 'CustomLocation' (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "instances/dataflowProfiles/dataflows" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.IoTOperations/instances/dataflowProfiles/dataflows-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "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"
        }
      }
    ]
  }
}

Eigenschaftswerte

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
apiVersion Die API-Version '2024-09-15-preview'
extendedLocation Edgespeicherort der Ressource. ExtendedLocation (erforderlich)
name Der Ressourcenname string

Constraints:
Min. Länge = 3
Max. Länge = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (erforderlich)
properties Die ressourcenspezifischen Eigenschaften für diese Ressource. DataflowProperties
type Der Ressourcentyp 'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

DataflowBuiltInTransformationDataset

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Datasets bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Anreichern von Daten aus dem Broker State Store. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) string
inputs Liste der Felder zum Anreichern aus dem Broker State Store. string[] (erforderlich)
key Der Schlüssel des Datasets. string

Constraints:
Max. Länge = 64 (erforderlich)
schemaRef Der Verweis auf das Schema, das das Dataset beschreibt. Zulässig: JSON-Schema/Draft-7. string

DataflowBuiltInTransformationFilter

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Filters bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Filtern von Daten. Kann auf Eingabefelder mit {n} verweisen, wobei n der Index des Eingabefelds ab 1 ist. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) Zeichenfolge (erforderlich)
inputs Liste der Felder zum Filtern im JSON-Pfadausdruck. string[] (erforderlich)
type Der Typ des Datenflussvorgangs. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung der Zuordnungsfunktion bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Ändern Sie die Eingabefelder in das endgültige Ausgabefeld. Beispiel: $1 * 2,2 (Vorausgesetzt, der Eingabeabschnitt $1 wird bereitgestellt) string
inputs Liste der Felder für die Zuordnung im JSON-Pfadausdruck. string[] (erforderlich)
output Wo und wie die Eingabefelder im Ausgabedatensatz angeordnet werden sollen. Zeichenfolge (erforderlich)
type Typ der Transformation. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Anreichern von Daten aus dem Broker State Store. Dataset verweist auf einen Schlüssel im Broker State Store. DataflowBuiltInTransformationDataset[]
filter Filtert Eingabedatensätze oder Datenpunkte basierend auf der Bedingung. DataflowBuiltInTransformationFilter[]
map Ordnet Eingaben der Ausgabenachricht zu. DataflowBuiltInTransformationMap[]
schemaRef Verweisen Sie auf das Schema, das die Ausgabe der Transformation beschreibt. string
serializationFormat Serialisierungsformat. Wahlfrei; Standardmäßig wird JSON verwendet. Zulässiger Wert JSON-Schema/Draft-7, Parkett. Standardwert: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Zielspeicherort kann ein Thema oder ein Tabellenname sein. Unterstützt dynamische Werte mit $topic, $systemProperties, $userProperties, $payload, $context und $subscription. string

Constraints:
Min. Länge = 1 (erforderlich)
endpointRef Verweis auf Endpunkt CR. Dies kann der Typ Broker, Kafka, Fabric, ADLS, ADX sein. Zeichenfolge (erforderlich)

DataflowOperation

Name Description Value
builtInTransformationSettings Integrierte Transformationskonfiguration. DataflowBuiltInTransformationSettings
destinationSettings Konfiguration des Ziels. DataflowDestinationOperationSettings
name Optionaler Benutzername der Transformation. string

Constraints:
Max. Länge = 64
operationType Typ des Vorgangs. 'BuiltInTransformation'
'Destination'
'Quelle' (erforderlich)
sourceSettings Konfiguration der Quelle. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Modus für Dataflow. Wahlfrei; standardmäßig auf "Aktiviert" festgelegt. 'Disabled'
'Enabled'
operations Liste der Vorgänge, einschließlich Quell- und Zielverweise sowie Transformation. DataflowOperation[] (erforderlich)

DataflowSourceOperationSettings

Name Description Value
assetRef Verweisen Sie auf die Ressource in der Azure-Geräteregistrierung, von der die Daten im Endpunkt stammen. string
dataSources Liste der Quellspeicherorte. Kann Broker- oder Kafka-Themen sein. Unterstützt Platzhalter # und +. string

Constraints:
Min. Länge = 1[] (erforderlich)
endpointRef Verweisen auf die Dataflow-Endpunktressource. Kann nur vom Typ Broker und Kafka sein. Zeichenfolge (erforderlich)
schemaRef Schema CR-Referenz. Die Daten werden gemäß dem Schema deserialisiert und gelöscht, wenn sie nicht übereinstimmen. string
serializationFormat Inhalt ist ein JSON-Schema. Zulässig: JSON-Schema/Draft-7. 'Json'

ExtendedLocation

Name Description Value
name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
type Typ von ExtendedLocation. 'CustomLocation' (erforderlich)

Verwendungsbeispiele

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "instances/dataflowProfiles/dataflows" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.IoTOperations/instances/dataflowProfiles/dataflows-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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"
          }
        }
      ]
    }
  }
}

Eigenschaftswerte

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Name Description Value
extendedLocation Edgespeicherort der Ressource. ExtendedLocation (erforderlich)
name Der Ressourcenname string

Constraints:
Min. Länge = 3
Max. Länge = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Instanzen/dataflowProfiles
properties Die ressourcenspezifischen Eigenschaften für diese Ressource. DataflowProperties
type Der Ressourcentyp "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-09-15-preview"

DataflowBuiltInTransformationDataset

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Datasets bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Anreichern von Daten aus dem Broker State Store. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) string
inputs Liste der Felder zum Anreichern aus dem Broker State Store. string[] (erforderlich)
key Der Schlüssel des Datasets. string

Constraints:
Max. Länge = 64 (erforderlich)
schemaRef Der Verweis auf das Schema, das das Dataset beschreibt. Zulässig: JSON-Schema/Draft-7. string

DataflowBuiltInTransformationFilter

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung des Filters bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Bedingung zum Filtern von Daten. Kann auf Eingabefelder mit {n} verweisen, wobei n der Index des Eingabefelds ab 1 ist. Beispiel: $1 < 0 || $1 > $2 (Vorausgesetzt, der Eingabeabschnitt $1 und $2 wird bereitgestellt) Zeichenfolge (erforderlich)
inputs Liste der Felder zum Filtern im JSON-Pfadausdruck. string[] (erforderlich)
type Der Typ des Datenflussvorgangs. 'Filter'

DataflowBuiltInTransformationMap

Name Description Value
description Ein Benutzer hat eine optionale Beschreibung der Zuordnungsfunktion bereitgestellt. string

Constraints:
Maximale Länge = 256
expression Ändern Sie die Eingabefelder in das endgültige Ausgabefeld. Beispiel: $1 * 2,2 (Vorausgesetzt, der Eingabeabschnitt $1 wird bereitgestellt) string
inputs Liste der Felder für die Zuordnung im JSON-Pfadausdruck. string[] (erforderlich)
output Wo und wie die Eingabefelder im Ausgabedatensatz angeordnet werden sollen. Zeichenfolge (erforderlich)
type Typ der Transformation. 'BuiltInFunction'
'Compute'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Name Description Value
datasets Anreichern von Daten aus dem Broker State Store. Dataset verweist auf einen Schlüssel im Broker State Store. DataflowBuiltInTransformationDataset[]
filter Filtert Eingabedatensätze oder Datenpunkte basierend auf der Bedingung. DataflowBuiltInTransformationFilter[]
map Ordnet Eingaben der Ausgabenachricht zu. DataflowBuiltInTransformationMap[]
schemaRef Verweisen Sie auf das Schema, das die Ausgabe der Transformation beschreibt. string
serializationFormat Serialisierungsformat. Wahlfrei; Standardmäßig wird JSON verwendet. Zulässiger Wert JSON-Schema/Draft-7, Parkett. Standardwert: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Name Description Value
dataDestination Zielspeicherort kann ein Thema oder ein Tabellenname sein. Unterstützt dynamische Werte mit $topic, $systemProperties, $userProperties, $payload, $context und $subscription. string

Constraints:
Min. Länge = 1 (erforderlich)
endpointRef Verweis auf Endpunkt CR. Dies kann der Typ Broker, Kafka, Fabric, ADLS, ADX sein. Zeichenfolge (erforderlich)

DataflowOperation

Name Description Value
builtInTransformationSettings Integrierte Transformationskonfiguration. DataflowBuiltInTransformationSettings
destinationSettings Konfiguration des Ziels. DataflowDestinationOperationSettings
name Optionaler Benutzername der Transformation. string

Constraints:
Max. Länge = 64
operationType Typ des Vorgangs. 'BuiltInTransformation'
'Destination'
'Quelle' (erforderlich)
sourceSettings Konfiguration der Quelle. DataflowSourceOperationSettings

DataflowProperties

Name Description Value
mode Modus für Dataflow. Wahlfrei; standardmäßig auf "Aktiviert" festgelegt. 'Disabled'
'Enabled'
operations Liste der Vorgänge, einschließlich Quell- und Zielverweise sowie Transformation. DataflowOperation[] (erforderlich)

DataflowSourceOperationSettings

Name Description Value
assetRef Verweisen Sie auf die Ressource in der Azure-Geräteregistrierung, von der die Daten im Endpunkt stammen. string
dataSources Liste der Quellspeicherorte. Kann Broker- oder Kafka-Themen sein. Unterstützt Platzhalter # und +. string

Constraints:
Min. Länge = 1[] (erforderlich)
endpointRef Verweisen auf die Dataflow-Endpunktressource. Kann nur vom Typ Broker und Kafka sein. Zeichenfolge (erforderlich)
schemaRef Schema CR-Referenz. Die Daten werden gemäß dem Schema deserialisiert und gelöscht, wenn sie nicht übereinstimmen. string
serializationFormat Inhalt ist ein JSON-Schema. Zulässig: JSON-Schema/Draft-7. 'Json'

ExtendedLocation

Name Description Value
name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
type Typ von ExtendedLocation. 'CustomLocation' (erforderlich)
  • Last updated on