Microsoft.IoTOperations instances/dataflowProfiles/dataflows 2024-11-01

• Últimas
• 2024-11-01
• 2024-09-15-preview
• 2024-08-15-preview
• 2024-07-01-preview

Definição de recursos do bíceps

O tipo de recurso instances/dataflowProfiles/dataflows pode ser implantado com operações que visam:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

DataflowBuiltInTransformationDataset

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	string Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Broker State Store. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string
Insumos	Lista de campos para enriquecimento a partir do Broker State Store.	string[] (obrigatório)
chave	A chave do conjunto de dados.	string Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: JSON Schema/draft-7.	string

DataflowBuiltInTransformationFilter

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do filtro.	string Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode fazer referência a campos de entrada com {n} onde n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string (obrigatório)
Insumos	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filtrar'

DataflowBuiltInTransformationMap

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	string Restrições: Comprimento máximo = 256
expressão	Modifique o(s) campo(s) de entrada para o campo de saída final. Exemplo: $1 * 2.2 (Supondo que a seção de entradas $1 é fornecida)	string
Insumos	Lista de campos para mapeamento na expressão de caminho JSON.	string[] (obrigatório)
Saída	Onde e como os campos de entrada a serem organizados no registro de saída.	string (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Computação' 'NovasPropriedades' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Designação	Descrição	Valor
conjuntos de dados	Enriqueça dados do Broker State Store. O conjunto de dados faz referência a uma chave no Broker State Store.	DataflowBuiltInTransformationDataset[]
filtrar	Filtra o registro de entrada ou pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a mensagem de entrada para a saída.	DataflowBuiltInTransformationMap[]
schemaRef	Referência ao esquema que descreve a saída da transformação.	string
serializationFormat	Formato de serialização. Opcional; padrão para JSON. Valor permitido JSON Schema/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Designação	Descrição	Valor
dataDestino	Local de destino, pode ser um tópico ou nome de tabela. Suporta valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	string Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência à CR do ponto final. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	string (obrigatório)

DataflowOperation

Designação	Descrição	Valor
builtInTransformationSettings	Configuração de transformação incorporada.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
Designação	Nome opcional fornecido pelo usuário da transformação.	string Restrições: Comprimento máximo = 64
tipo de operação	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Fonte' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

Designação	Descrição	Valor
modo	Modo para fluxo de dados. Opcional; o padrão é Habilitado.	'Desativado' 'Habilitado'
Operações	Lista de operações, incluindo referências de origem e destino, bem como transformação.	DataflowOperation[] (obrigatório)

DataflowSourceOperationSettings

Designação	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivo do Azure de onde os dados no ponto de extremidade se originam.	string
Fontes de dados	Lista de locais de origem. Pode ser Broker ou tópicos Kafka. Suporta curingas # e +.	string Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso Dataflow Endpoint. Só pode ser do tipo Broker e Kafka.	string (obrigatório)
schemaRef	Referência CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	string
serializationFormat	O conteúdo é um esquema JSON. Permitido: JSON Schema/draft-7.	'Json'

Localização Estendida

Designação	Descrição	Valor
Designação	O nome do local estendido.	string (obrigatório)
tipo	Tipo de ExtendedLocation.	'CustomLocation' (obrigatório)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Designação	Descrição	Valor
extendedLocalização	Localização de borda do recurso.	ExtendedLocation (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico para recurso do tipo: instances/dataflowProfiles
propriedades	As propriedades específicas do recurso para este recurso.	DataflowProperties

Definição de recurso de modelo ARM

O tipo de recurso instances/dataflowProfiles/dataflows pode ser implantado com operações que visam:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

DataflowBuiltInTransformationDataset

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	string Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Broker State Store. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string
Insumos	Lista de campos para enriquecimento a partir do Broker State Store.	string[] (obrigatório)
chave	A chave do conjunto de dados.	string Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: JSON Schema/draft-7.	string

DataflowBuiltInTransformationFilter

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do filtro.	string Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode fazer referência a campos de entrada com {n} onde n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string (obrigatório)
Insumos	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filtrar'

DataflowBuiltInTransformationMap

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	string Restrições: Comprimento máximo = 256
expressão	Modifique o(s) campo(s) de entrada para o campo de saída final. Exemplo: $1 * 2.2 (Supondo que a seção de entradas $1 é fornecida)	string
Insumos	Lista de campos para mapeamento na expressão de caminho JSON.	string[] (obrigatório)
Saída	Onde e como os campos de entrada a serem organizados no registro de saída.	string (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Computação' 'NovasPropriedades' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Designação	Descrição	Valor
conjuntos de dados	Enriqueça dados do Broker State Store. O conjunto de dados faz referência a uma chave no Broker State Store.	DataflowBuiltInTransformationDataset[]
filtrar	Filtra o registro de entrada ou pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a mensagem de entrada para a saída.	DataflowBuiltInTransformationMap[]
schemaRef	Referência ao esquema que descreve a saída da transformação.	string
serializationFormat	Formato de serialização. Opcional; padrão para JSON. Valor permitido JSON Schema/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Designação	Descrição	Valor
dataDestino	Local de destino, pode ser um tópico ou nome de tabela. Suporta valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	string Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência à CR do ponto final. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	string (obrigatório)

DataflowOperation

Designação	Descrição	Valor
builtInTransformationSettings	Configuração de transformação incorporada.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
Designação	Nome opcional fornecido pelo usuário da transformação.	string Restrições: Comprimento máximo = 64
tipo de operação	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Fonte' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

Designação	Descrição	Valor
modo	Modo para fluxo de dados. Opcional; o padrão é Habilitado.	'Desativado' 'Habilitado'
Operações	Lista de operações, incluindo referências de origem e destino, bem como transformação.	DataflowOperation[] (obrigatório)

DataflowSourceOperationSettings

Designação	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivo do Azure de onde os dados no ponto de extremidade se originam.	string
Fontes de dados	Lista de locais de origem. Pode ser Broker ou tópicos Kafka. Suporta curingas # e +.	string Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso Dataflow Endpoint. Só pode ser do tipo Broker e Kafka.	string (obrigatório)
schemaRef	Referência CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	string
serializationFormat	O conteúdo é um esquema JSON. Permitido: JSON Schema/draft-7.	'Json'

Localização Estendida

Designação	Descrição	Valor
Designação	O nome do local estendido.	string (obrigatório)
tipo	Tipo de ExtendedLocation.	'CustomLocation' (obrigatório)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Designação	Descrição	Valor
apiVersion	A versão api	'2024-11-01'
extendedLocalização	Localização de borda do recurso.	ExtendedLocation (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
propriedades	As propriedades específicas do recurso para este recurso.	DataflowProperties
tipo	O tipo de recurso	'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso instances/dataflowProfiles/dataflows pode ser implantado com operações que visam:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

DataflowBuiltInTransformationDataset

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	string Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Broker State Store. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string
Insumos	Lista de campos para enriquecimento a partir do Broker State Store.	string[] (obrigatório)
chave	A chave do conjunto de dados.	string Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: JSON Schema/draft-7.	string

DataflowBuiltInTransformationFilter

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional do filtro.	string Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode fazer referência a campos de entrada com {n} onde n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (Supondo que a seção de entradas $1 e $2 são fornecidas)	string (obrigatório)
Insumos	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filtrar'

DataflowBuiltInTransformationMap

Designação	Descrição	Valor
Descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	string Restrições: Comprimento máximo = 256
expressão	Modifique o(s) campo(s) de entrada para o campo de saída final. Exemplo: $1 * 2.2 (Supondo que a seção de entradas $1 é fornecida)	string
Insumos	Lista de campos para mapeamento na expressão de caminho JSON.	string[] (obrigatório)
Saída	Onde e como os campos de entrada a serem organizados no registro de saída.	string (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Computação' 'NovasPropriedades' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Designação	Descrição	Valor
conjuntos de dados	Enriqueça dados do Broker State Store. O conjunto de dados faz referência a uma chave no Broker State Store.	DataflowBuiltInTransformationDataset[]
filtrar	Filtra o registro de entrada ou pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a mensagem de entrada para a saída.	DataflowBuiltInTransformationMap[]
schemaRef	Referência ao esquema que descreve a saída da transformação.	string
serializationFormat	Formato de serialização. Opcional; padrão para JSON. Valor permitido JSON Schema/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Designação	Descrição	Valor
dataDestino	Local de destino, pode ser um tópico ou nome de tabela. Suporta valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	string Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência à CR do ponto final. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	string (obrigatório)

DataflowOperation

Designação	Descrição	Valor
builtInTransformationSettings	Configuração de transformação incorporada.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
Designação	Nome opcional fornecido pelo usuário da transformação.	string Restrições: Comprimento máximo = 64
tipo de operação	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Fonte' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

Designação	Descrição	Valor
modo	Modo para fluxo de dados. Opcional; o padrão é Habilitado.	'Desativado' 'Habilitado'
Operações	Lista de operações, incluindo referências de origem e destino, bem como transformação.	DataflowOperation[] (obrigatório)

DataflowSourceOperationSettings

Designação	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivo do Azure de onde os dados no ponto de extremidade se originam.	string
Fontes de dados	Lista de locais de origem. Pode ser Broker ou tópicos Kafka. Suporta curingas # e +.	string Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso Dataflow Endpoint. Só pode ser do tipo Broker e Kafka.	string (obrigatório)
schemaRef	Referência CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	string
serializationFormat	O conteúdo é um esquema JSON. Permitido: JSON Schema/draft-7.	'Json'

Localização Estendida

Designação	Descrição	Valor
Designação	O nome do local estendido.	string (obrigatório)
tipo	Tipo de ExtendedLocation.	'CustomLocation' (obrigatório)

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Designação	Descrição	Valor
extendedLocalização	Localização de borda do recurso.	ExtendedLocation (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
parent_id	A ID do recurso que é o pai para este recurso.	ID para recurso do tipo: instances/dataflowProfiles
propriedades	As propriedades específicas do recurso para este recurso.	DataflowProperties
tipo	O tipo de recurso	"Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-11-01"