Compartir a través de

Dataflow - Create Or Update

  • Referencia
Servicio:
IoT Operations
Versión de la API:
2025-04-01

Creación de un dataflowResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}?api-version=2025-04-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
dataflowName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Nombre del recurso de flujo de datos De instanciaProfile
dataflowProfileName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Nombre del recurso DataflowProfile de instancia
instanceName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Nombre de la instancia.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
extendedLocation True

ExtendedLocation

Ubicación perimetral del recurso.
properties

DataflowProperties

Propiedades específicas del recurso para este recurso.

Respuestas

Nombre Tipo Description
200 OK

DataflowResource

Operación de actualización de recurso "DataflowResource" correcta
201 Created

DataflowResource

Operación de creación de recurso "DataflowResource" correcta

Encabezados

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Dataflow_CreateOrUpdate
Dataflow_CreateOrUpdate_ComplexContextualization
Dataflow_CreateOrUpdate_ComplexEventHub
Dataflow_CreateOrUpdate_FilterToTopic
Dataflow_CreateOrUpdate_SimpleEventGrid
Dataflow_CreateOrUpdate_SimpleFabric

Dataflow_CreateOrUpdate

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "knnafvkwoeakm",
        "sourceSettings": {
          "endpointRef": "iixotodhvhkkfcfyrkoveslqig",
          "assetRef": "zayyykwmckaocywdkohmu",
          "serializationFormat": "Json",
          "schemaRef": "pknmdzqll",
          "dataSources": [
            "chkkpymxhp"
          ]
        },
        "builtInTransformationSettings": {
          "serializationFormat": "Delta",
          "schemaRef": "mcdc",
          "datasets": [
            {
              "key": "qsfqcgxaxnhfumrsdsokwyv",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "schemaRef": "n",
              "inputs": [
                "mosffpsslifkq"
              ],
              "expression": "aatbwomvflemsxialv"
            }
          ],
          "filter": [
            {
              "type": "Filter",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "sxmjkbntgb"
              ],
              "expression": "n"
            }
          ],
          "map": [
            {
              "type": "NewProperties",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "xsbxuk"
              ],
              "expression": "txoiltogsarwkzalsphvlmt",
              "output": "nvgtmkfl"
            }
          ]
        },
        "destinationSettings": {
          "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt",
          "dataDestination": "cbrh"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "knnafvkwoeakm",
        "sourceSettings": {
          "endpointRef": "iixotodhvhkkfcfyrkoveslqig",
          "assetRef": "zayyykwmckaocywdkohmu",
          "serializationFormat": "Json",
          "schemaRef": "pknmdzqll",
          "dataSources": [
            "chkkpymxhp"
          ]
        },
        "builtInTransformationSettings": {
          "serializationFormat": "Delta",
          "schemaRef": "mcdc",
          "datasets": [
            {
              "key": "qsfqcgxaxnhfumrsdsokwyv",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "schemaRef": "n",
              "inputs": [
                "mosffpsslifkq"
              ],
              "expression": "aatbwomvflemsxialv"
            }
          ],
          "filter": [
            {
              "type": "Filter",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "sxmjkbntgb"
              ],
              "expression": "n"
            }
          ],
          "map": [
            {
              "type": "NewProperties",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "xsbxuk"
              ],
              "expression": "txoiltogsarwkzalsphvlmt",
              "output": "nvgtmkfl"
            }
          ]
        },
        "destinationSettings": {
          "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt",
          "dataDestination": "cbrh"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "knnafvkwoeakm",
        "sourceSettings": {
          "endpointRef": "iixotodhvhkkfcfyrkoveslqig",
          "assetRef": "zayyykwmckaocywdkohmu",
          "serializationFormat": "Json",
          "schemaRef": "pknmdzqll",
          "dataSources": [
            "chkkpymxhp"
          ]
        },
        "builtInTransformationSettings": {
          "serializationFormat": "Delta",
          "schemaRef": "mcdc",
          "datasets": [
            {
              "key": "qsfqcgxaxnhfumrsdsokwyv",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "schemaRef": "n",
              "inputs": [
                "mosffpsslifkq"
              ],
              "expression": "aatbwomvflemsxialv"
            }
          ],
          "filter": [
            {
              "type": "Filter",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "sxmjkbntgb"
              ],
              "expression": "n"
            }
          ],
          "map": [
            {
              "type": "NewProperties",
              "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.",
              "inputs": [
                "xsbxuk"
              ],
              "expression": "txoiltogsarwkzalsphvlmt",
              "output": "nvgtmkfl"
            }
          ]
        },
        "destinationSettings": {
          "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt",
          "dataDestination": "cbrh"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Dataflow_CreateOrUpdate_ComplexContextualization

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/aio-to-adx-contexualized?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "$context(quality).*"
              ],
              "output": "enriched.*"
            }
          ],
          "datasets": [
            {
              "key": "quality",
              "inputs": [
                "$source.country",
                "$context.country"
              ],
              "expression": "$1 == $2"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "adx-endpoint",
          "dataDestination": "mytable"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "$context(quality).*"
              ],
              "output": "enriched.*"
            }
          ],
          "datasets": [
            {
              "key": "quality",
              "inputs": [
                "$source.country",
                "$context.country"
              ],
              "expression": "$1 == $2"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "adx-endpoint",
          "dataDestination": "mytable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "$context(quality).*"
              ],
              "output": "enriched.*"
            }
          ],
          "datasets": [
            {
              "key": "quality",
              "inputs": [
                "$source.country",
                "$context.country"
              ],
              "expression": "$1 == $2"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "adx-endpoint",
          "dataDestination": "mytable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Dataflow_CreateOrUpdate_ComplexEventHub

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/aio-to-event-hub-transformed?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "builtInTransformationSettings": {
          "filter": [
            {
              "inputs": [
                "temperature.Value",
                "\"Tag 10\".Value"
              ],
              "expression": "$1 > 9000 && $2 >= 8000"
            }
          ],
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "temperature.Value",
                "\"Tag 10\".Value"
              ],
              "expression": "($1+$2)/2",
              "output": "AvgTemp.Value"
            },
            {
              "inputs": [],
              "expression": "true",
              "output": "dataflow-processed"
            },
            {
              "inputs": [
                "temperature.SourceTimestamp"
              ],
              "expression": "",
              "output": ""
            },
            {
              "inputs": [
                "\"Tag 10\""
              ],
              "expression": "",
              "output": "pressure"
            },
            {
              "inputs": [
                "temperature.Value"
              ],
              "expression": "cToF($1)",
              "output": "temperatureF.Value"
            },
            {
              "inputs": [
                "\"Tag 10\".Value"
              ],
              "expression": "scale ($1,0,10,0,100)",
              "output": "\"Scale Tag 10\".Value"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "event-hub-endpoint",
          "dataDestination": "myuniqueeventhub"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "$context(quality).*"
              ],
              "output": "enriched.*"
            }
          ],
          "datasets": [
            {
              "key": "quality",
              "inputs": [
                "$source.country",
                "$context.country"
              ],
              "expression": "$1 == $2"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "adx-endpoint",
          "dataDestination": "mytable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "map": [
            {
              "inputs": [
                "*"
              ],
              "output": "*"
            },
            {
              "inputs": [
                "$context(quality).*"
              ],
              "output": "enriched.*"
            }
          ],
          "datasets": [
            {
              "key": "quality",
              "inputs": [
                "$source.country",
                "$context.country"
              ],
              "expression": "$1 == $2"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "adx-endpoint",
          "dataDestination": "mytable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Dataflow_CreateOrUpdate_FilterToTopic

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/mqtt-filter-to-topic?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "filter": [
            {
              "type": "Filter",
              "description": "filter-datapoint",
              "inputs": [
                "temperature.Value",
                "\"Tag 10\".Value"
              ],
              "expression": "$1 > 9000 && $2 >= 8000"
            }
          ],
          "map": [
            {
              "type": "PassThrough",
              "inputs": [
                "*"
              ],
              "output": "*"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataDestination": "data/filtered/thermostat"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "filter": [
            {
              "type": "Filter",
              "description": "filter-datapoint",
              "inputs": [
                "temperature.Value",
                "\"Tag 10\".Value"
              ],
              "expression": "$1 > 9000 && $2 >= 8000"
            }
          ],
          "map": [
            {
              "type": "PassThrough",
              "inputs": [
                "*"
              ],
              "output": "*"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataDestination": "data/filtered/thermostat"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "name": "transformation1",
        "builtInTransformationSettings": {
          "filter": [
            {
              "type": "Filter",
              "description": "filter-datapoint",
              "inputs": [
                "temperature.Value",
                "\"Tag 10\".Value"
              ],
              "expression": "$1 > 9000 && $2 >= 8000"
            }
          ],
          "map": [
            {
              "type": "PassThrough",
              "inputs": [
                "*"
              ],
              "output": "*"
            }
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataDestination": "data/filtered/thermostat"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Dataflow_CreateOrUpdate_SimpleEventGrid

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/aio-to-event-grid?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "thermostats/+/telemetry/temperature/#"
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "event-grid-endpoint",
          "dataDestination": "factory/telemetry"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "thermostats/+/telemetry/temperature/#"
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "event-grid-endpoint",
          "dataDestination": "factory/telemetry"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "thermostats/+/telemetry/temperature/#"
          ]
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "event-grid-endpoint",
          "dataDestination": "factory/telemetry"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Dataflow_CreateOrUpdate_SimpleFabric

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/aio-to-fabric?api-version=2025-04-01

{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "builtInTransformationSettings": {
          "serializationFormat": "Parquet",
          "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0"
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "fabric-endpoint",
          "dataDestination": "telemetryTable"
        }
      }
    ]
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Respuesta de muestra

status code:
200 
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "builtInTransformationSettings": {
          "serializationFormat": "Parquet",
          "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0"
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "fabric-endpoint",
          "dataDestination": "telemetryTable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
status code:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "mode": "Enabled",
    "operations": [
      {
        "operationType": "Source",
        "name": "source1",
        "sourceSettings": {
          "endpointRef": "aio-builtin-broker-endpoint",
          "dataSources": [
            "azure-iot-operations/data/thermostat"
          ]
        }
      },
      {
        "operationType": "BuiltInTransformation",
        "builtInTransformationSettings": {
          "serializationFormat": "Parquet",
          "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0"
        }
      },
      {
        "operationType": "Destination",
        "name": "destination1",
        "destinationSettings": {
          "endpointRef": "fabric-endpoint",
          "dataDestination": "telemetryTable"
        }
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123",
  "name": "jxhcpwgfkxqasbexkookvxk",
  "type": "zkuozvgjseokfchkscoswthzjdry",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.
DataflowBuiltInTransformationDataset

Propiedades del conjunto de datos de transformación BuiltIn de flujo de datos
DataflowBuiltInTransformationFilter

Propiedades del filtro de transformación BuiltIn de flujo de datos
DataflowBuiltInTransformationMap

Propiedades del mapa de transformación BuiltIn de flujo de datos
DataflowBuiltInTransformationSettings

Propiedades de transformación BuiltIn de flujo de datos
DataflowDestinationOperationSettings

Propiedades de la operación de destino del flujo de datos
DataflowMappingType

Propiedades de asignación de tipos de flujo de datos
DataflowOperation

Propiedades de operación de flujo de datos. NOTA: se permite usar un solo método para una entrada.
DataflowProperties

Propiedades del recurso de flujo de datos
DataflowResource

Recurso de flujo de datos de instanciaProfile
DataflowSourceOperationSettings

Propiedades de la operación de origen del flujo de datos
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
ExtendedLocation

La ubicación extendida es una extensión de las ubicaciones de Azure. Proporcionan una manera de usar sus clústeres de Kubernetes habilitados para Azure ARC como ubicaciones de destino para implementar instancias de servicios de Azure.
ExtendedLocationType

Enumeración que define el tipo de ExtendedLocation aceptado.
FilterType

Propiedades de tipo de filtro
OperationalMode

Propiedades del modo
OperationType

Propiedades del tipo de operación de flujo de datos
ProvisioningState

Enumeración que define el estado del recurso.
SourceSerializationFormat

Propiedades de formato de serialización
systemData

Metadatos relativos a la creación y última modificación del recurso.
TransformationSerializationFormat

Propiedades de formato de transformación

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

DataflowBuiltInTransformationDataset

Object

Propiedades del conjunto de datos de transformación BuiltIn de flujo de datos

Nombre Tipo Description
description

string

maxLength: 256

Un usuario proporcionó una descripción opcional del conjunto de datos.
expression

string

Condición para enriquecer los datos del Almacén de estado de Broker. Ejemplo: $1 < 0 || $1 > $2 (suponiendo que se proporcione la sección de entradas $1 y $2)
inputs

string[]

Lista de campos para enriquecer desde el Almacén de estado de Broker.
key

string

maxLength: 64

Clave del conjunto de datos.
schemaRef

string

Referencia al esquema que describe el conjunto de datos. Permitido: esquema JSON/borrador-7.

DataflowBuiltInTransformationFilter

Object

Propiedades del filtro de transformación BuiltIn de flujo de datos

Nombre Tipo Valor predeterminado Description
description

string

maxLength: 256

Un usuario proporcionó una descripción opcional del filtro.
expression

string

Condición para filtrar los datos. Puede hacer referencia a campos de entrada con {n} donde n es el índice del campo de entrada a partir de 1. Ejemplo: $1 < 0 || $1 > $2 (suponiendo que se proporcione la sección de entradas $1 y $2)
inputs

string[]

Lista de campos para filtrar en la expresión de ruta de acceso JSON.
type

FilterType

Filter

Tipo de operación de flujo de datos.

DataflowBuiltInTransformationMap

Object

Propiedades del mapa de transformación BuiltIn de flujo de datos

Nombre Tipo Description
description

string

maxLength: 256

Un usuario proporcionó una descripción opcional de la función de asignación.
expression

string

Modifique los campos de entrada al campo de salida final. Ejemplo: $1 * 2.2 (Suponiendo que se proporcione la sección $1)
inputs

string[]

Lista de campos para la asignación en la expresión de ruta de acceso JSON.
output

string

Dónde y cómo se organizarán los campos de entrada en el registro de salida.
type

DataflowMappingType

Tipo de transformación.

DataflowBuiltInTransformationSettings

Object

Propiedades de transformación BuiltIn de flujo de datos

Nombre Tipo Valor predeterminado Description
datasets

DataflowBuiltInTransformationDataset[]

Enriquecer datos del Almacén de estado de Broker. El conjunto de datos hace referencia a una clave en el Almacén de estado de Broker.
filter

DataflowBuiltInTransformationFilter[]

Filtra el registro de entrada o los puntos de datos en función de la condición.
map

DataflowBuiltInTransformationMap[]

Asigna la entrada al mensaje de salida.
schemaRef

string

Referencia al esquema que describe la salida de la transformación.
serializationFormat

TransformationSerializationFormat

Json

Formato de serialización. Opcional; el valor predeterminado es JSON. Valor permitido Esquema JSON/borrador-7, Parquet. Valor predeterminado: Json

DataflowDestinationOperationSettings

Object

Propiedades de la operación de destino del flujo de datos

Nombre Tipo Description
dataDestination

string

minLength: 1

Ubicación de destino, puede ser un nombre de tema o tabla. Admite valores dinámicos con $topic, $systemProperties, $userProperties, $payload, $context y $subscription.
endpointRef

string

Referencia a la CR del punto de conexión. Puede ser del tipo Broker, Kafka, Fabric, ADLS, ADX.

DataflowMappingType

Enumeración

Propiedades de asignación de tipos de flujo de datos

Valor Description
BuiltInFunction

Tipo de función integrado
Compute

Tipo de proceso
NewProperties

Nuevo tipo de propiedades
PassThrough

Tipo de paso a través
Rename

Cambiar nombre de tipo

DataflowOperation

Object

Propiedades de operación de flujo de datos. NOTA: se permite usar un solo método para una entrada.

Nombre Tipo Description
builtInTransformationSettings

DataflowBuiltInTransformationSettings

Configuración de transformación integrada.
destinationSettings

DataflowDestinationOperationSettings

Configuración de destino.
name

string

maxLength: 64

Nombre opcional proporcionado por el usuario de la transformación.
operationType

OperationType

Tipo de operación.
sourceSettings

DataflowSourceOperationSettings

Configuración de origen.

DataflowProperties

Object

Propiedades del recurso de flujo de datos

Nombre Tipo Valor predeterminado Description
mode

OperationalMode

Enabled

Modo para flujo de datos. Opcional; el valor predeterminado es Habilitado.
operations

DataflowOperation[]

Lista de operaciones, incluidas las referencias de origen y destino, así como la transformación.
provisioningState

ProvisioningState

Estado de la última operación.

DataflowResource

Object

Recurso de flujo de datos de instanciaProfile

Nombre Tipo Description
extendedLocation

ExtendedLocation

Ubicación perimetral del recurso.
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nombre del recurso
properties

DataflowProperties

Propiedades específicas del recurso para este recurso.
systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DataflowSourceOperationSettings

Object

Propiedades de la operación de origen del flujo de datos

Nombre Tipo Valor predeterminado Description
assetRef

string

Referencia al recurso de Azure Device Registry desde el que se originan los datos del punto de conexión.
dataSources

string[]

minLength: 1

Lista de ubicaciones de origen. Puede ser temas de Broker o Kafka. Admite caracteres comodín # y +.
endpointRef

string

Referencia al recurso Punto de conexión de flujo de datos. Solo puede ser del tipo Broker y Kafka.
schemaRef

string

Referencia de CR de esquema. Los datos se deserializarán según el esquema y se quitarán si no coincide.
serializationFormat

SourceSerializationFormat

Json

El contenido es un esquema JSON. Permitido: esquema JSON/borrador-7.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ExtendedLocation

Object

La ubicación extendida es una extensión de las ubicaciones de Azure. Proporcionan una manera de usar sus clústeres de Kubernetes habilitados para Azure ARC como ubicaciones de destino para implementar instancias de servicios de Azure.

Nombre Tipo Description
name

string

Nombre de la ubicación extendida.
type

ExtendedLocationType

Tipo de ExtendedLocation.

ExtendedLocationType

Enumeración

Enumeración que define el tipo de ExtendedLocation aceptado.

Valor Description
CustomLocation

Tipo CustomLocation

FilterType

Enumeración

Propiedades de tipo de filtro

Valor Description
Filter

Tipo de filtro

OperationalMode

Enumeración

Propiedades del modo

Valor Description
Disabled

Disabled es equivalente a False.
Enabled

Enabled es equivalente a True

OperationType

Enumeración

Propiedades del tipo de operación de flujo de datos

Valor Description
BuiltInTransformation

Operación de transformación BuiltIn de flujo de datos
Destination

Operación de destino del flujo de datos
Source

Operación de origen de flujo de datos

ProvisioningState

Enumeración

Enumeración que define el estado del recurso.

Valor Description
Accepted

Se ha aceptado el recurso.
Canceled

Se canceló la creación de recursos.
Deleting

El recurso se está eliminando.
Failed

Error en la creación de recursos.
Provisioning

Se aprovisiona el recurso.
Succeeded

Se ha creado el recurso.
Updating

El recurso es Actualizar.

SourceSerializationFormat

Enumeración

Propiedades de formato de serialización

Valor Description
Json

Formato JSON

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

TransformationSerializationFormat

Enumeración

Propiedades de formato de transformación

Valor Description
Delta

Formato delta
Json

Formato JSON
Parquet

Formato Parquet