Microsoft.IoTOperations-exemplaren/dataflowProfiles/gegevensstromen

• meest recente
• 2024-11-01
• 2024-09-15-preview-
• 2024-08-15-preview-
• 2024-07-01-preview-

Bicep-resourcedefinitie

Het resourcetype instances/dataflowProfiles/dataflows kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.IoTOperations/instances/dataflowProfiles/dataflows wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

DataflowBuiltInTransformationDataset

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de gegevensset opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde voor het verrijken van gegevens uit Broker State Store. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	snaar
Ingangen	Lijst met velden voor verrijking van de Broker State Store.	tekenreeks[] (vereist)
sleutel	De sleutel van de gegevensset.	snaar Beperkingen: Maximale lengte = 64 (vereist)
schemaRef	De verwijzing naar het schema waarin de gegevensset wordt beschreven. Toegestaan: JSON-schema/draft-7.	snaar

DataflowBuiltInTransformationFilter

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van het filter opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde om gegevens te filteren. Kan verwijzen naar invoervelden met {n} waarbij n de index is van het invoerveld vanaf 1. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	tekenreeks (vereist)
Ingangen	Lijst met velden voor filteren in JSON-padexpressie.	tekenreeks[] (vereist)
type	Het type gegevensstroombewerking.	'Filter'

DataflowBuiltInTransformationMap

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de toewijzingsfunctie opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Wijzig de invoervelden in het uiteindelijke uitvoerveld. Voorbeeld: $1 * 2,2 (ervan uitgaande dat de invoersectie $1 is opgegeven)	snaar
Ingangen	Lijst met velden voor toewijzing in JSON-padexpressie.	tekenreeks[] (vereist)
uitvoer	Waar en hoe de invoervelden moeten worden geordend in de uitvoerrecord.	tekenreeks (vereist)
type	Type transformatie.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' Naam wijzigen

DataflowBuiltInTransformationSettings

Naam	Beschrijving	Waarde
Datasets	Verrijk gegevens uit Broker State Store. Gegevensset verwijst naar een sleutel in Broker State Store.	DataflowBuiltInTransformationDataset[]
filter	Hiermee filtert u invoerrecords of gegevenspunten op basis van een voorwaarde.	DataflowBuiltInTransformationFilter[]
kaart	Hiermee wordt invoer toegewezen aan uitvoerbericht.	DataflowBuiltInTransformationMap[]
schemaRef	Verwijzing naar het schema waarin de uitvoer van de transformatie wordt beschreven.	snaar
serializationFormat	Serialisatie-indeling. Facultatief; standaard ingesteld op JSON. Toegestane waarde JSON-schema/draft-7, Parquet. Standaard: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Naam	Beschrijving	Waarde
dataDestination	Doellocatie kan een onderwerp of tabelnaam zijn. Ondersteunt dynamische waarden met $topic, $systemProperties, $userProperties, $payload, $context en $subscription.	snaar Beperkingen: Minimale lengte = 1 (vereist)
endpointRef	Verwijzing naar het eindpunt CR. Kan van Broker, Kafka, Fabric, ADLS, ADX-type zijn.	tekenreeks (vereist)

DataflowOperation

Naam	Beschrijving	Waarde
builtInTransformationSettings	Ingebouwde transformatieconfiguratie.	DataflowBuiltInTransformationSettings
destinationSettings	Doelconfiguratie.	DataflowDestinationOperationSettings
naam	Optionele door de gebruiker opgegeven naam van de transformatie.	snaar Beperkingen: Maximale lengte = 64
operationType	Type bewerking.	'BuiltInTransformation' 'Bestemming' Bron (vereist)
sourceSettings	Bronconfiguratie.	DataflowSourceOperationSettings-

DataflowProperties

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensstroom. Facultatief; is standaard ingeschakeld.	'Uitgeschakeld' 'Ingeschakeld'
Operaties	Lijst met bewerkingen, waaronder bron- en doelverwijzingen, evenals transformatie.	DataflowOperation[] (vereist)

DataflowSourceOperationSettings

Naam	Beschrijving	Waarde
assetRef	Verwijzing naar de resource in Azure Device Registry waaruit de gegevens in het eindpunt afkomstig zijn.	snaar
dataSources	Lijst met bronlocaties. Dit kunnen Broker- of Kafka-onderwerpen zijn. Ondersteunt jokertekens # en +.	snaar Beperkingen: Minimale lengte = 1[] (vereist)
endpointRef	Verwijzing naar de gegevensstroomeindpuntresource. Kan alleen van broker- en Kafka-type zijn.	tekenreeks (vereist)
schemaRef	Schema CR-verwijzing. Gegevens worden gedeserialiseerd volgens het schema en verwijderd als deze niet overeenkomen.	snaar
serializationFormat	Inhoud is een JSON-schema. Toegestaan: JSON-schema/draft-7.	'Json'

ExtendedLocation

Naam	Beschrijving	Waarde
naam	De naam van de uitgebreide locatie.	tekenreeks (vereist)
type	Type of ExtendedLocation.	'CustomLocation' (vereist)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows/dataflows

Naam	Beschrijving	Waarde
extendedLocation	Edge-locatie van de resource.	ExtendedLocation- (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 63 Patroon = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (vereist)
ouder	In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.	Symbolische naam voor resource van het type: exemplaren/dataflowProfiles
Eigenschappen	De resourcespecifieke eigenschappen voor deze resource.	DataflowProperties-

Resourcedefinitie van ARM-sjabloon

Het resourcetype instances/dataflowProfiles/dataflows kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.IoTOperations/instances/dataflowProfiles/dataflows wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

DataflowBuiltInTransformationDataset

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de gegevensset opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde voor het verrijken van gegevens uit Broker State Store. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	snaar
Ingangen	Lijst met velden voor verrijking van de Broker State Store.	tekenreeks[] (vereist)
sleutel	De sleutel van de gegevensset.	snaar Beperkingen: Maximale lengte = 64 (vereist)
schemaRef	De verwijzing naar het schema waarin de gegevensset wordt beschreven. Toegestaan: JSON-schema/draft-7.	snaar

DataflowBuiltInTransformationFilter

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van het filter opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde om gegevens te filteren. Kan verwijzen naar invoervelden met {n} waarbij n de index is van het invoerveld vanaf 1. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	tekenreeks (vereist)
Ingangen	Lijst met velden voor filteren in JSON-padexpressie.	tekenreeks[] (vereist)
type	Het type gegevensstroombewerking.	'Filter'

DataflowBuiltInTransformationMap

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de toewijzingsfunctie opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Wijzig de invoervelden in het uiteindelijke uitvoerveld. Voorbeeld: $1 * 2,2 (ervan uitgaande dat de invoersectie $1 is opgegeven)	snaar
Ingangen	Lijst met velden voor toewijzing in JSON-padexpressie.	tekenreeks[] (vereist)
uitvoer	Waar en hoe de invoervelden moeten worden geordend in de uitvoerrecord.	tekenreeks (vereist)
type	Type transformatie.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' Naam wijzigen

DataflowBuiltInTransformationSettings

Naam	Beschrijving	Waarde
Datasets	Verrijk gegevens uit Broker State Store. Gegevensset verwijst naar een sleutel in Broker State Store.	DataflowBuiltInTransformationDataset[]
filter	Hiermee filtert u invoerrecords of gegevenspunten op basis van een voorwaarde.	DataflowBuiltInTransformationFilter[]
kaart	Hiermee wordt invoer toegewezen aan uitvoerbericht.	DataflowBuiltInTransformationMap[]
schemaRef	Verwijzing naar het schema waarin de uitvoer van de transformatie wordt beschreven.	snaar
serializationFormat	Serialisatie-indeling. Facultatief; standaard ingesteld op JSON. Toegestane waarde JSON-schema/draft-7, Parquet. Standaard: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Naam	Beschrijving	Waarde
dataDestination	Doellocatie kan een onderwerp of tabelnaam zijn. Ondersteunt dynamische waarden met $topic, $systemProperties, $userProperties, $payload, $context en $subscription.	snaar Beperkingen: Minimale lengte = 1 (vereist)
endpointRef	Verwijzing naar het eindpunt CR. Kan van Broker, Kafka, Fabric, ADLS, ADX-type zijn.	tekenreeks (vereist)

DataflowOperation

Naam	Beschrijving	Waarde
builtInTransformationSettings	Ingebouwde transformatieconfiguratie.	DataflowBuiltInTransformationSettings
destinationSettings	Doelconfiguratie.	DataflowDestinationOperationSettings
naam	Optionele door de gebruiker opgegeven naam van de transformatie.	snaar Beperkingen: Maximale lengte = 64
operationType	Type bewerking.	'BuiltInTransformation' 'Bestemming' Bron (vereist)
sourceSettings	Bronconfiguratie.	DataflowSourceOperationSettings-

DataflowProperties

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensstroom. Facultatief; is standaard ingeschakeld.	'Uitgeschakeld' 'Ingeschakeld'
Operaties	Lijst met bewerkingen, waaronder bron- en doelverwijzingen, evenals transformatie.	DataflowOperation[] (vereist)

DataflowSourceOperationSettings

Naam	Beschrijving	Waarde
assetRef	Verwijzing naar de resource in Azure Device Registry waaruit de gegevens in het eindpunt afkomstig zijn.	snaar
dataSources	Lijst met bronlocaties. Dit kunnen Broker- of Kafka-onderwerpen zijn. Ondersteunt jokertekens # en +.	snaar Beperkingen: Minimale lengte = 1[] (vereist)
endpointRef	Verwijzing naar de gegevensstroomeindpuntresource. Kan alleen van broker- en Kafka-type zijn.	tekenreeks (vereist)
schemaRef	Schema CR-verwijzing. Gegevens worden gedeserialiseerd volgens het schema en verwijderd als deze niet overeenkomen.	snaar
serializationFormat	Inhoud is een JSON-schema. Toegestaan: JSON-schema/draft-7.	'Json'

ExtendedLocation

Naam	Beschrijving	Waarde
naam	De naam van de uitgebreide locatie.	tekenreeks (vereist)
type	Type of ExtendedLocation.	'CustomLocation' (vereist)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows/dataflows

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2024-11-01'
extendedLocation	Edge-locatie van de resource.	ExtendedLocation- (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 63 Patroon = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (vereist)
Eigenschappen	De resourcespecifieke eigenschappen voor deze resource.	DataflowProperties-
type	Het resourcetype	'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype instances/dataflowProfiles/dataflows kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.IoTOperations/instances/dataflowProfiles/dataflows wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-11-01"
  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"
          }
        }
      ]
    }
  })
}

Eigenschapswaarden

DataflowBuiltInTransformationDataset

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de gegevensset opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde voor het verrijken van gegevens uit Broker State Store. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	snaar
Ingangen	Lijst met velden voor verrijking van de Broker State Store.	tekenreeks[] (vereist)
sleutel	De sleutel van de gegevensset.	snaar Beperkingen: Maximale lengte = 64 (vereist)
schemaRef	De verwijzing naar het schema waarin de gegevensset wordt beschreven. Toegestaan: JSON-schema/draft-7.	snaar

DataflowBuiltInTransformationFilter

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van het filter opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Voorwaarde om gegevens te filteren. Kan verwijzen naar invoervelden met {n} waarbij n de index is van het invoerveld vanaf 1. Voorbeeld: $ 1 < 0		$ 1 > $ 2 (ervan uitgaande dat de invoersectie $1 en $ 2 zijn opgegeven)	tekenreeks (vereist)
Ingangen	Lijst met velden voor filteren in JSON-padexpressie.	tekenreeks[] (vereist)
type	Het type gegevensstroombewerking.	'Filter'

DataflowBuiltInTransformationMap

Naam	Beschrijving	Waarde
beschrijving	Een gebruiker heeft een optionele beschrijving van de toewijzingsfunctie opgegeven.	snaar Beperkingen: Maximale lengte = 256
uitdrukking	Wijzig de invoervelden in het uiteindelijke uitvoerveld. Voorbeeld: $1 * 2,2 (ervan uitgaande dat de invoersectie $1 is opgegeven)	snaar
Ingangen	Lijst met velden voor toewijzing in JSON-padexpressie.	tekenreeks[] (vereist)
uitvoer	Waar en hoe de invoervelden moeten worden geordend in de uitvoerrecord.	tekenreeks (vereist)
type	Type transformatie.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' Naam wijzigen

DataflowBuiltInTransformationSettings

Naam	Beschrijving	Waarde
Datasets	Verrijk gegevens uit Broker State Store. Gegevensset verwijst naar een sleutel in Broker State Store.	DataflowBuiltInTransformationDataset[]
filter	Hiermee filtert u invoerrecords of gegevenspunten op basis van een voorwaarde.	DataflowBuiltInTransformationFilter[]
kaart	Hiermee wordt invoer toegewezen aan uitvoerbericht.	DataflowBuiltInTransformationMap[]
schemaRef	Verwijzing naar het schema waarin de uitvoer van de transformatie wordt beschreven.	snaar
serializationFormat	Serialisatie-indeling. Facultatief; standaard ingesteld op JSON. Toegestane waarde JSON-schema/draft-7, Parquet. Standaard: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Naam	Beschrijving	Waarde
dataDestination	Doellocatie kan een onderwerp of tabelnaam zijn. Ondersteunt dynamische waarden met $topic, $systemProperties, $userProperties, $payload, $context en $subscription.	snaar Beperkingen: Minimale lengte = 1 (vereist)
endpointRef	Verwijzing naar het eindpunt CR. Kan van Broker, Kafka, Fabric, ADLS, ADX-type zijn.	tekenreeks (vereist)

DataflowOperation

Naam	Beschrijving	Waarde
builtInTransformationSettings	Ingebouwde transformatieconfiguratie.	DataflowBuiltInTransformationSettings
destinationSettings	Doelconfiguratie.	DataflowDestinationOperationSettings
naam	Optionele door de gebruiker opgegeven naam van de transformatie.	snaar Beperkingen: Maximale lengte = 64
operationType	Type bewerking.	'BuiltInTransformation' 'Bestemming' Bron (vereist)
sourceSettings	Bronconfiguratie.	DataflowSourceOperationSettings-

DataflowProperties

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensstroom. Facultatief; is standaard ingeschakeld.	'Uitgeschakeld' 'Ingeschakeld'
Operaties	Lijst met bewerkingen, waaronder bron- en doelverwijzingen, evenals transformatie.	DataflowOperation[] (vereist)

DataflowSourceOperationSettings

Naam	Beschrijving	Waarde
assetRef	Verwijzing naar de resource in Azure Device Registry waaruit de gegevens in het eindpunt afkomstig zijn.	snaar
dataSources	Lijst met bronlocaties. Dit kunnen Broker- of Kafka-onderwerpen zijn. Ondersteunt jokertekens # en +.	snaar Beperkingen: Minimale lengte = 1[] (vereist)
endpointRef	Verwijzing naar de gegevensstroomeindpuntresource. Kan alleen van broker- en Kafka-type zijn.	tekenreeks (vereist)
schemaRef	Schema CR-verwijzing. Gegevens worden gedeserialiseerd volgens het schema en verwijderd als deze niet overeenkomen.	snaar
serializationFormat	Inhoud is een JSON-schema. Toegestaan: JSON-schema/draft-7.	'Json'

ExtendedLocation

Naam	Beschrijving	Waarde
naam	De naam van de uitgebreide locatie.	tekenreeks (vereist)
type	Type of ExtendedLocation.	'CustomLocation' (vereist)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows/dataflows

Naam	Beschrijving	Waarde
extendedLocation	Edge-locatie van de resource.	ExtendedLocation- (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 63 Patroon = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: exemplaren/dataflowProfiles
Eigenschappen	De resourcespecifieke eigenschappen voor deze resource.	DataflowProperties-
type	Het resourcetype	"Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-11-01"