Instâncias de Microsoft.IoTOperations/dataflowProfiles/fluxos de dados

• última
• 2024-11-01
• 2024-09-15-preview
• 2024-08-15-preview
• 2024-07-01-preview

Definição de recurso do Bicep

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

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

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

Formato de recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o Bicep a seguir ao 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 da propriedade

DataflowBuiltInTransformationDataset

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	corda Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Repositório de Estado do Agente. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	corda
Entradas	Lista de campos para enriquecer do Repositório de Estado do Agente.	string[] (obrigatório)
chave	A chave do conjunto de dados.	corda Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: Esquema JSON/rascunho-7.	corda

DataflowBuiltInTransformationFilter

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do filtro.	corda Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode referenciar campos de entrada com {n} em que n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	cadeia de caracteres (obrigatório)
Entradas	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filter'

DataflowBuiltInTransformationMap

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	corda Restrições: Comprimento máximo = 256
expressão	Modifique os campos de entrada para o campo de saída final. Exemplo: $1 * 2.2 (supondo que a seção de entradas $1 seja fornecida)	corda
Entradas	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.	cadeia de caracteres (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Nome	Descrição	Valor
Datasets	Enriquecer dados do Repositório de Estado do Agente. O conjunto de dados faz referência a uma chave no Repositório de Estado do Agente.	DataflowBuiltInTransformationDataset[]
filtro	Filtra o registro de entrada ou os pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a entrada para a mensagem de saída.	DataflowBuiltInTransformationMap []
schemaRef	Referência ao esquema que descreve a saída da transformação.	corda
serializationFormat	Formato de serialização. Opcional; o padrão é JSON. Esquema JSON de valor permitido/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Nome	Descrição	Valor
dataDestination	Local de destino, pode ser um tópico ou um nome de tabela. Dá suporte a valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	corda Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência ao CR do ponto de extremidade. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	cadeia de caracteres (obrigatório)

DataflowOperation

Nome	Descrição	Valor
builtInTransformationSettings	Configuração de Transformação Interna.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
nome	Nome fornecido pelo usuário opcional da transformação.	corda Restrições: Comprimento máximo = 64
operationType	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Origem' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

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

DataflowSourceOperationSettings

Nome	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivos do Azure de onde os dados no ponto de extremidade se originam.	corda
dataSources	Lista de locais de origem. Podem ser tópicos do Broker ou kafka. Dá suporte a caracteres curinga # e +.	corda Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso ponto de extremidade de fluxo de dados. Só pode ser do tipo Broker e Kafka.	cadeia de caracteres (obrigatório)
schemaRef	Referência de CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	corda
serializationFormat	O conteúdo é um esquema JSON. Permitido: Esquema JSON/rascunho-7.	'Json'

ExtendedLocation

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

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome	Descrição	Valor
extendedLocation	Local de borda do recurso.	ExtendedLocation (obrigatório)
nome	O nome do recurso	corda 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 o recurso do tipo: instâncias/dataflowProfiles
Propriedades	As propriedades específicas do recurso para esse recurso.	dataflowProperties

Definição de recurso de modelo do ARM

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

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

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

Formato de recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o JSON a seguir ao 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 da propriedade

DataflowBuiltInTransformationDataset

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	corda Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Repositório de Estado do Agente. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	corda
Entradas	Lista de campos para enriquecer do Repositório de Estado do Agente.	string[] (obrigatório)
chave	A chave do conjunto de dados.	corda Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: Esquema JSON/rascunho-7.	corda

DataflowBuiltInTransformationFilter

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do filtro.	corda Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode referenciar campos de entrada com {n} em que n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	cadeia de caracteres (obrigatório)
Entradas	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filter'

DataflowBuiltInTransformationMap

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	corda Restrições: Comprimento máximo = 256
expressão	Modifique os campos de entrada para o campo de saída final. Exemplo: $1 * 2.2 (supondo que a seção de entradas $1 seja fornecida)	corda
Entradas	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.	cadeia de caracteres (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Nome	Descrição	Valor
Datasets	Enriquecer dados do Repositório de Estado do Agente. O conjunto de dados faz referência a uma chave no Repositório de Estado do Agente.	DataflowBuiltInTransformationDataset[]
filtro	Filtra o registro de entrada ou os pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a entrada para a mensagem de saída.	DataflowBuiltInTransformationMap []
schemaRef	Referência ao esquema que descreve a saída da transformação.	corda
serializationFormat	Formato de serialização. Opcional; o padrão é JSON. Esquema JSON de valor permitido/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Nome	Descrição	Valor
dataDestination	Local de destino, pode ser um tópico ou um nome de tabela. Dá suporte a valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	corda Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência ao CR do ponto de extremidade. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	cadeia de caracteres (obrigatório)

DataflowOperation

Nome	Descrição	Valor
builtInTransformationSettings	Configuração de Transformação Interna.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
nome	Nome fornecido pelo usuário opcional da transformação.	corda Restrições: Comprimento máximo = 64
operationType	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Origem' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

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

DataflowSourceOperationSettings

Nome	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivos do Azure de onde os dados no ponto de extremidade se originam.	corda
dataSources	Lista de locais de origem. Podem ser tópicos do Broker ou kafka. Dá suporte a caracteres curinga # e +.	corda Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso ponto de extremidade de fluxo de dados. Só pode ser do tipo Broker e Kafka.	cadeia de caracteres (obrigatório)
schemaRef	Referência de CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	corda
serializationFormat	O conteúdo é um esquema JSON. Permitido: Esquema JSON/rascunho-7.	'Json'

ExtendedLocation

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

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome	Descrição	Valor
apiVersion	A versão da API	'2024-11-01'
extendedLocation	Local de borda do recurso.	ExtendedLocation (obrigatório)
nome	O nome do recurso	corda 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 esse recurso.	dataflowProperties
tipo	O tipo de recurso	'Microsoft.IoTOperations/instances/dataflowProfiles/dataflows'

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

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

• grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.IoTOperations/instances/dataflowProfiles/dataflows, adicione o Terraform a seguir ao 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 da propriedade

DataflowBuiltInTransformationDataset

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do conjunto de dados.	corda Restrições: Comprimento máximo = 256
expressão	Condição para enriquecer dados do Repositório de Estado do Agente. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	corda
Entradas	Lista de campos para enriquecer do Repositório de Estado do Agente.	string[] (obrigatório)
chave	A chave do conjunto de dados.	corda Restrições: Comprimento máximo = 64 (obrigatório)
schemaRef	A referência ao esquema que descreve o conjunto de dados. Permitido: Esquema JSON/rascunho-7.	corda

DataflowBuiltInTransformationFilter

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional do filtro.	corda Restrições: Comprimento máximo = 256
expressão	Condição para filtrar dados. Pode referenciar campos de entrada com {n} em que n é o índice do campo de entrada a partir de 1. Exemplo: $1 < 0		$1 > $2 (supondo que as entradas seção $1 e $2 sejam fornecidas)	cadeia de caracteres (obrigatório)
Entradas	Lista de campos para filtragem na expressão de caminho JSON.	string[] (obrigatório)
tipo	O tipo de operação de fluxo de dados.	'Filter'

DataflowBuiltInTransformationMap

Nome	Descrição	Valor
descrição	Um usuário forneceu uma descrição opcional da função de mapeamento.	corda Restrições: Comprimento máximo = 256
expressão	Modifique os campos de entrada para o campo de saída final. Exemplo: $1 * 2.2 (supondo que a seção de entradas $1 seja fornecida)	corda
Entradas	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.	cadeia de caracteres (obrigatório)
tipo	Tipo de transformação.	'BuiltInFunction' 'Compute' 'NewProperties' 'PassThrough' 'Renomear'

DataflowBuiltInTransformationSettings

Nome	Descrição	Valor
Datasets	Enriquecer dados do Repositório de Estado do Agente. O conjunto de dados faz referência a uma chave no Repositório de Estado do Agente.	DataflowBuiltInTransformationDataset[]
filtro	Filtra o registro de entrada ou os pontos de dados com base na condição.	DataflowBuiltInTransformationFilter[]
mapa	Mapeia a entrada para a mensagem de saída.	DataflowBuiltInTransformationMap []
schemaRef	Referência ao esquema que descreve a saída da transformação.	corda
serializationFormat	Formato de serialização. Opcional; o padrão é JSON. Esquema JSON de valor permitido/draft-7, Parquet. Padrão: Json	'Delta' 'Json' 'Parquet'

DataflowDestinationOperationSettings

Nome	Descrição	Valor
dataDestination	Local de destino, pode ser um tópico ou um nome de tabela. Dá suporte a valores dinâmicos com $topic, $systemProperties, $userProperties, $payload, $context e $subscription.	corda Restrições: Comprimento mínimo = 1 (obrigatório)
endpointRef	Referência ao CR do ponto de extremidade. Pode ser do tipo Broker, Kafka, Fabric, ADLS, ADX.	cadeia de caracteres (obrigatório)

DataflowOperation

Nome	Descrição	Valor
builtInTransformationSettings	Configuração de Transformação Interna.	DataflowBuiltInTransformationSettings
destinationSettings	Configuração de destino.	DataflowDestinationOperationSettings
nome	Nome fornecido pelo usuário opcional da transformação.	corda Restrições: Comprimento máximo = 64
operationType	Tipo de operação.	'BuiltInTransformation' 'Destino' 'Origem' (obrigatório)
sourceSettings	Configuração de origem.	DataflowSourceOperationSettings

DataflowProperties

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

DataflowSourceOperationSettings

Nome	Descrição	Valor
assetRef	Referência ao recurso no Registro de Dispositivos do Azure de onde os dados no ponto de extremidade se originam.	corda
dataSources	Lista de locais de origem. Podem ser tópicos do Broker ou kafka. Dá suporte a caracteres curinga # e +.	corda Restrições: Comprimento mínimo = 1[] (obrigatório)
endpointRef	Referência ao recurso ponto de extremidade de fluxo de dados. Só pode ser do tipo Broker e Kafka.	cadeia de caracteres (obrigatório)
schemaRef	Referência de CR do esquema. Os dados serão desserializados de acordo com o esquema e descartados se não corresponderem.	corda
serializationFormat	O conteúdo é um esquema JSON. Permitido: Esquema JSON/rascunho-7.	'Json'

ExtendedLocation

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

Microsoft.IoTOperations/instances/dataflowProfiles/dataflows

Nome	Descrição	Valor
extendedLocation	Local de borda do recurso.	ExtendedLocation (obrigatório)
nome	O nome do recurso	corda 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 desse recurso.	ID do recurso do tipo: instâncias/dataflowProfiles
Propriedades	As propriedades específicas do recurso para esse recurso.	dataflowProperties
tipo	O tipo de recurso	"Microsoft.IoTOperations/instances/dataflowProfiles/dataflows@2024-11-01"