| title | description | author | ms.author | ms.subservice | ms.topic | ms.custom | ms.date | |
|---|---|---|---|---|---|---|---|---|
Edit and manage pipelines |
Use the advanced features in the Azure IoT Operations portal to edit Azure IoT Data Processor pipelines and import and export pipelines. |
dominicbetts |
dobett |
data-processor |
how-to |
|
10/17/2023 |
[!INCLUDE public-preview-note]
The Azure IoT Operations (preview) portal provides a graphical user interface (GUI) for editing pipelines. To edit the JSON definition of a stage directly, you can use the Advanced tab. This feature gives you more flexibility and control over the pipeline configuration, especially if you need to manage complex configurations that might not be fully supported by the GUI such as for the filter stage.
The portal also lets you import and export complete pipelines as JSON files.
To configure and use a data processor pipeline, you need a deployed instance of Azure IoT Data Processor Preview that includes the optional Data Processor component.
If Data Processor isn't installed, you see the following message when you try to access the Pipelines tab in the Azure IoT Operations (preview) portal:
Data Processor not found in the current deployment. Please re-deploy with the additional argument to include the Data Processor.
To edit the JSON definition of a pipeline stage, open the pipeline stage that you want to modify and select the Advanced tab:
:::image type="content" source="media/pipeline-advanced-editor.png" alt-text="A screenshot that shows the advanced pipeline editor.":::
Make the necessary changes directly to the JSON. Ensure that the modified JSON is valid and adheres to the correct schema for the pipeline stage.
When you're done with your modifications, select Save to apply the changes. The user interface updates to reflect your changes.
When you use the Advanced tab, it’s important to understand the underlying JSON structure and schema of the pipeline stage you’re configuring. An incorrect configuration can lead to errors or unexpected behavior. Be sure to refer to the appropriate documentation or schema definitions
You can import and export pipelines as JSON files. This feature lets you share pipelines between different instances of Data Processor:
:::image type="content" source="media/pipeline-import-export.png" alt-text="A screenshot that shows the location of the import and export options in the pipeline editor.":::
To pause or restart a pipeline, open the pipeline, select Edit and use Pipeline enabled to toggle whether the pipeline is running:
:::image type="content" source="media/pipeline-enabled.png" alt-text="A screenshot that shows the location of the pipeline enabled option in the UI.":::
To create, delete or copy pipelines, use the Pipelines tab in the Azure IoT Operations (preview) portal:
:::image type="content" source="media/pipelines-manage.png" alt-text="A screenshot that shows the options in the pipelines list.":::
This list also lets you view the provisioning state and status of your pipelines