Condividi tramite


Istanze di Microsoft.IoTOperations/dataflowProfiles/flussi di dati 2024-08-15-preview

Definizione di risorsa Bicep

Il tipo di risorsa instances/dataflowProfiles/dataflows può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

DataflowBuiltInTransformationDataset

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del set di dati. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per arricchire i dati dall'archivio stati broker. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) corda
Ingressi Elenco di campi per l'arricchimento da Archivio stati broker. string[] (obbligatorio)
chiave Chiave del set di dati. corda

Vincoli:
Lunghezza massima = 64 (obbligatorio)
schemaRef Riferimento allo schema che descrive il set di dati. Consentito: schema JSON/bozza-7. corda

DataflowBuiltInTransformationFilter

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del filtro. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per filtrare i dati. Può fare riferimento ai campi di input con {n} dove n è l'indice del campo di input a partire da 1. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) stringa (obbligatorio)
Ingressi Elenco di campi per il filtro nell'espressione di percorso JSON. string[] (obbligatorio)
digitare Tipo di operazione del flusso di dati. 'Filter'

DataflowBuiltInTransformationMap

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa della funzione di mapping. corda

Vincoli:
Lunghezza massima = 256
espressione Modificare i campi di input nel campo di output finale. Esempio: $1 * 2,2 (presupponendo che venga fornita la sezione $1) corda
Ingressi Elenco di campi per il mapping nell'espressione di percorso JSON. string[] (obbligatorio)
prodotto Dove e come organizzare i campi di input nel record di output. stringa (obbligatorio)
digitare Tipo di trasformazione. 'BuiltInFunction'
'Calcolo'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Nome Descrizione Valore
Dataset Arricchire i dati dall'archivio stati broker. Il set di dati fa riferimento a una chiave nell'archivio stati di Broker. DataflowBuiltInTransformationDataset[]
filtro Filtra i record di input o i punti dati in base alla condizione. DataflowBuiltInTransformationFilter[]
mappa Esegue il mapping dell'input al messaggio di output. DataflowBuiltInTransformationMap[]
schemaRef Riferimento allo schema che descrive l'output della trasformazione. corda
serializationFormat Formato di serializzazione. Opzionale; il valore predefinito è JSON. Valore consentito JSON Schema/draft-7, Parquet. Impostazione predefinita: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Nome Descrizione Valore
dataDestination Il percorso di destinazione può essere un argomento o un nome di tabella. Supporta valori dinamici con $topic, $systemProperties, $userProperties, $payload, $context e $subscription. stringa (obbligatorio)
endpointRef Riferimento all'endpoint CR. Può essere di tipo Broker, Kafka, Fabric, ADLS, ADX. stringa (obbligatorio)

DataflowOperation

Nome Descrizione Valore
builtInTransformationSettings Configurazione della trasformazione predefinita. DataflowBuiltInTransformationSettings
destinationSettings Configurazione di destinazione. DataflowDestinationOperationSettings
nome Nome facoltativo fornito dall'utente della trasformazione. corda

Vincoli:
Lunghezza massima = 64
operationType Tipo di operazione. 'BuiltInTransformation'
'Destination'
'Source' (obbligatorio)
sourceSettings Configurazione dell'origine. dataflowSourceOperationSettings

Proprietà flusso di dati

Nome Descrizione Valore
modo Modalità per flusso di dati. Opzionale; il valore predefinito è Abilitato. 'Disabilitato'
'Enabled'
Operazioni Elenco di operazioni, inclusi i riferimenti all'origine e alla destinazione, nonché la trasformazione. dataflowOperation[] (obbligatorio)

DataflowSourceOperationSettings

Nome Descrizione Valore
assetRef Riferimento alla risorsa in Registro dispositivi di Azure da cui provengono i dati nell'endpoint. corda
dataSources Elenco delle posizioni di origine. Può essere broker o argomenti Kafka. Supporta i caratteri jolly # e +. string[] (obbligatorio)
endpointRef Riferimento alla risorsa endpoint flusso di dati. Può essere solo di tipo Broker e Kafka. stringa (obbligatorio)
schemaRef Riferimento cr dello schema. I dati verranno deserializzati in base allo schema e eliminati se non corrispondono. corda
serializationFormat Il contenuto è uno schema JSON. Consentito: schema JSON/bozza-7. 'Json'

ExtendedLocation

Nome Descrizione Valore
nome Nome della posizione estesa. stringa (obbligatorio)
digitare Tipo di ExtendedLocation. 'CustomLocation' (obbligatorio)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome Descrizione Valore
extendedLocation Posizione perimetrale della risorsa. ExtendedLocation (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: istanze di /dataflowProfiles
proprietà Proprietà specifiche della risorsa. DataflowProperties

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa instances/dataflowProfiles/dataflows può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

DataflowBuiltInTransformationDataset

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del set di dati. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per arricchire i dati dall'archivio stati broker. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) corda
Ingressi Elenco di campi per l'arricchimento da Archivio stati broker. string[] (obbligatorio)
chiave Chiave del set di dati. corda

Vincoli:
Lunghezza massima = 64 (obbligatorio)
schemaRef Riferimento allo schema che descrive il set di dati. Consentito: schema JSON/bozza-7. corda

DataflowBuiltInTransformationFilter

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del filtro. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per filtrare i dati. Può fare riferimento ai campi di input con {n} dove n è l'indice del campo di input a partire da 1. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) stringa (obbligatorio)
Ingressi Elenco di campi per il filtro nell'espressione di percorso JSON. string[] (obbligatorio)
digitare Tipo di operazione del flusso di dati. 'Filter'

DataflowBuiltInTransformationMap

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa della funzione di mapping. corda

Vincoli:
Lunghezza massima = 256
espressione Modificare i campi di input nel campo di output finale. Esempio: $1 * 2,2 (presupponendo che venga fornita la sezione $1) corda
Ingressi Elenco di campi per il mapping nell'espressione di percorso JSON. string[] (obbligatorio)
prodotto Dove e come organizzare i campi di input nel record di output. stringa (obbligatorio)
digitare Tipo di trasformazione. 'BuiltInFunction'
'Calcolo'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Nome Descrizione Valore
Dataset Arricchire i dati dall'archivio stati broker. Il set di dati fa riferimento a una chiave nell'archivio stati di Broker. DataflowBuiltInTransformationDataset[]
filtro Filtra i record di input o i punti dati in base alla condizione. DataflowBuiltInTransformationFilter[]
mappa Esegue il mapping dell'input al messaggio di output. DataflowBuiltInTransformationMap[]
schemaRef Riferimento allo schema che descrive l'output della trasformazione. corda
serializationFormat Formato di serializzazione. Opzionale; il valore predefinito è JSON. Valore consentito JSON Schema/draft-7, Parquet. Impostazione predefinita: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Nome Descrizione Valore
dataDestination Il percorso di destinazione può essere un argomento o un nome di tabella. Supporta valori dinamici con $topic, $systemProperties, $userProperties, $payload, $context e $subscription. stringa (obbligatorio)
endpointRef Riferimento all'endpoint CR. Può essere di tipo Broker, Kafka, Fabric, ADLS, ADX. stringa (obbligatorio)

DataflowOperation

Nome Descrizione Valore
builtInTransformationSettings Configurazione della trasformazione predefinita. DataflowBuiltInTransformationSettings
destinationSettings Configurazione di destinazione. DataflowDestinationOperationSettings
nome Nome facoltativo fornito dall'utente della trasformazione. corda

Vincoli:
Lunghezza massima = 64
operationType Tipo di operazione. 'BuiltInTransformation'
'Destination'
'Source' (obbligatorio)
sourceSettings Configurazione dell'origine. dataflowSourceOperationSettings

Proprietà flusso di dati

Nome Descrizione Valore
modo Modalità per flusso di dati. Opzionale; il valore predefinito è Abilitato. 'Disabilitato'
'Enabled'
Operazioni Elenco di operazioni, inclusi i riferimenti all'origine e alla destinazione, nonché la trasformazione. dataflowOperation[] (obbligatorio)

DataflowSourceOperationSettings

Nome Descrizione Valore
assetRef Riferimento alla risorsa in Registro dispositivi di Azure da cui provengono i dati nell'endpoint. corda
dataSources Elenco delle posizioni di origine. Può essere broker o argomenti Kafka. Supporta i caratteri jolly # e +. string[] (obbligatorio)
endpointRef Riferimento alla risorsa endpoint flusso di dati. Può essere solo di tipo Broker e Kafka. stringa (obbligatorio)
schemaRef Riferimento cr dello schema. I dati verranno deserializzati in base allo schema e eliminati se non corrispondono. corda
serializationFormat Il contenuto è uno schema JSON. Consentito: schema JSON/bozza-7. 'Json'

ExtendedLocation

Nome Descrizione Valore
nome Nome della posizione estesa. stringa (obbligatorio)
digitare Tipo di ExtendedLocation. 'CustomLocation' (obbligatorio)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome Descrizione Valore
apiVersion Versione dell'API '2024-08-15-preview'
extendedLocation Posizione perimetrale della risorsa. ExtendedLocation (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
proprietà Proprietà specifiche della risorsa. DataflowProperties
digitare Tipo di risorsa 'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa instances/dataflowProfiles/dataflows può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

DataflowBuiltInTransformationDataset

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del set di dati. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per arricchire i dati dall'archivio stati broker. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) corda
Ingressi Elenco di campi per l'arricchimento da Archivio stati broker. string[] (obbligatorio)
chiave Chiave del set di dati. corda

Vincoli:
Lunghezza massima = 64 (obbligatorio)
schemaRef Riferimento allo schema che descrive il set di dati. Consentito: schema JSON/bozza-7. corda

DataflowBuiltInTransformationFilter

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa del filtro. corda

Vincoli:
Lunghezza massima = 256
espressione Condizione per filtrare i dati. Può fare riferimento ai campi di input con {n} dove n è l'indice del campo di input a partire da 1. Esempio: $1 < 0 $1 > $2 (supponendo che vengano forniti input sezione $1 e $2) stringa (obbligatorio)
Ingressi Elenco di campi per il filtro nell'espressione di percorso JSON. string[] (obbligatorio)
digitare Tipo di operazione del flusso di dati. 'Filter'

DataflowBuiltInTransformationMap

Nome Descrizione Valore
descrizione Un utente ha fornito una descrizione facoltativa della funzione di mapping. corda

Vincoli:
Lunghezza massima = 256
espressione Modificare i campi di input nel campo di output finale. Esempio: $1 * 2,2 (presupponendo che venga fornita la sezione $1) corda
Ingressi Elenco di campi per il mapping nell'espressione di percorso JSON. string[] (obbligatorio)
prodotto Dove e come organizzare i campi di input nel record di output. stringa (obbligatorio)
digitare Tipo di trasformazione. 'BuiltInFunction'
'Calcolo'
'NewProperties'
'PassThrough'
'Rename'

DataflowBuiltInTransformationSettings

Nome Descrizione Valore
Dataset Arricchire i dati dall'archivio stati broker. Il set di dati fa riferimento a una chiave nell'archivio stati di Broker. DataflowBuiltInTransformationDataset[]
filtro Filtra i record di input o i punti dati in base alla condizione. DataflowBuiltInTransformationFilter[]
mappa Esegue il mapping dell'input al messaggio di output. DataflowBuiltInTransformationMap[]
schemaRef Riferimento allo schema che descrive l'output della trasformazione. corda
serializationFormat Formato di serializzazione. Opzionale; il valore predefinito è JSON. Valore consentito JSON Schema/draft-7, Parquet. Impostazione predefinita: Json 'Delta'
'Json'
'Parquet'

DataflowDestinationOperationSettings

Nome Descrizione Valore
dataDestination Il percorso di destinazione può essere un argomento o un nome di tabella. Supporta valori dinamici con $topic, $systemProperties, $userProperties, $payload, $context e $subscription. stringa (obbligatorio)
endpointRef Riferimento all'endpoint CR. Può essere di tipo Broker, Kafka, Fabric, ADLS, ADX. stringa (obbligatorio)

DataflowOperation

Nome Descrizione Valore
builtInTransformationSettings Configurazione della trasformazione predefinita. DataflowBuiltInTransformationSettings
destinationSettings Configurazione di destinazione. DataflowDestinationOperationSettings
nome Nome facoltativo fornito dall'utente della trasformazione. corda

Vincoli:
Lunghezza massima = 64
operationType Tipo di operazione. 'BuiltInTransformation'
'Destination'
'Source' (obbligatorio)
sourceSettings Configurazione dell'origine. dataflowSourceOperationSettings

Proprietà flusso di dati

Nome Descrizione Valore
modo Modalità per flusso di dati. Opzionale; il valore predefinito è Abilitato. 'Disabilitato'
'Enabled'
Operazioni Elenco di operazioni, inclusi i riferimenti all'origine e alla destinazione, nonché la trasformazione. dataflowOperation[] (obbligatorio)

DataflowSourceOperationSettings

Nome Descrizione Valore
assetRef Riferimento alla risorsa in Registro dispositivi di Azure da cui provengono i dati nell'endpoint. corda
dataSources Elenco delle posizioni di origine. Può essere broker o argomenti Kafka. Supporta i caratteri jolly # e +. string[] (obbligatorio)
endpointRef Riferimento alla risorsa endpoint flusso di dati. Può essere solo di tipo Broker e Kafka. stringa (obbligatorio)
schemaRef Riferimento cr dello schema. I dati verranno deserializzati in base allo schema e eliminati se non corrispondono. corda
serializationFormat Il contenuto è uno schema JSON. Consentito: schema JSON/bozza-7. 'Json'

ExtendedLocation

Nome Descrizione Valore
nome Nome della posizione estesa. stringa (obbligatorio)
digitare Tipo di ExtendedLocation. 'CustomLocation' (obbligatorio)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome Descrizione Valore
extendedLocation Posizione perimetrale della risorsa. ExtendedLocation (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: istanze di /dataflowProfiles
proprietà Proprietà specifiche della risorsa. DataflowProperties
digitare Tipo di risorsa "Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-08-15-preview"