Skip to content

Commit ccf1864

Browse files
committed
Add connector template instance details
1 parent 0751abf commit ccf1864

File tree

8 files changed

+62
-11
lines changed

8 files changed

+62
-11
lines changed

articles/iot-operations/deploy-iot-ops/howto-manage-update-uninstall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The previous screenshot also shows the other resources in Azure Device Registry
141141

142142
In the Azure portal, you can configure *connector templates* for your Azure IoT Operations instance. Connector templates define the configuration of connectors, such as the connector for OPC UA, that are deployed to your cluster. When you create a connector template, it enables an OT user to create a device that uses the connector type in the operations experience web UI.
143143

144-
<!-- TODO - 2507 Expand this section with more details about the connector template configuration. -->
144+
To learn more about connector templates, see [Deploy the connector for ONVIF](../discover-manage-assets/howto-use-onvif-connector.md#deploy-the-connector-for-onvif).
145145

146146
### Clone instance (preview)
147147

articles/iot-operations/includes/deploy-mqttui.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Verify data is flowing to the MQTT broker by using the **mosquitto_sub** tool. I
1111

1212
1. Run the following command to deploy a pod that includes the **mosquitto_pub** and **mosquitto_sub** tools that are useful for interacting with the MQTT broker in the cluster:
1313

14-
<!-- TODO: Change branch to main before merging the release branch -->
15-
1614
```console
1715
kubectl apply -f https://raw.githubusercontent.com/Azure-Samples/explore-iot-operations/main/samples/quickstarts/mqtt-client.yaml
1816
```
Lines changed: 61 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,79 @@
11
---
2-
title: include file
3-
description: include file
2+
title: Include file
3+
description: Include file
44
author: dominicbetts
55
ms.topic: include
6-
ms.date: 04/03/2025
6+
ms.date: 07/25/2025
77
ms.author: dobett
88
---
99

10-
To deploy the preview version of the connectors, you can either enable them when you deploy your Azure IoT Operations instance or enable them after you deploy your instance.
10+
Before you can use the preview connectors (ONVIF, media, and REST/HTTP) in the operations experience web UI, an administrator must:
11+
12+
1. Enable them in your Azure IoT Operations instance.
13+
1. Add connector template instances to your Azure IoT Operations instance.
14+
15+
To enable the preview connectors, you can either enable them when you deploy your Azure IoT Operations instance or enable them after you deploy your instance.
16+
17+
To enable the preview connectors when you deploy your Azure IoT Operations instance:
18+
19+
# [Azure portal](#tab/portal)
20+
21+
Select **ONVIF Connector and Media Connector (Preview)** in the **Connectors** section of the **Install Azure IoT Operations > Basics** page:
22+
23+
:::image type="content" source="media/deploy-preview-media-connectors/portal-deploy-preview-connectors.png" alt-text="Screenshot of Azure portal that shows how to select the preview connectors.":::
24+
25+
# [Azure CLI](#tab/cli)
26+
27+
Include the `--feature connectors.settings.preview=Enabled` parameter when you run the `az iot ops create` command.
28+
29+
---
1130

1231
To enable the preview connectors after you deploy your Azure IoT Operations instance:
1332

14-
# [Azure portal](#tab/deploy-portal)
33+
# [Azure portal](#tab/portal)
1534

1635
1. Go to your Azure IoT Operations instance in the Azure portal.
1736

18-
1. Enable the preview connectors, go to the **Connectors** page for your instance and add the connector template instance you need:
37+
1. Enable the preview connectors:
1938

2039
:::image type="content" source="media/deploy-preview-media-connectors/portal-enable-preview-connectors.png" alt-text="Screenshot of Azure portal that shows how to enable the preview connectors.":::
2140

22-
# [Azure CLI](#tab/deploy-cli)
41+
# [Azure CLI](#tab/cli)
42+
43+
Run the following command to enable the preview connectors:
44+
45+
```azcli
46+
az iot ops update -n <your-instance> -g <your-resource-group> --feature connectors.settings.preview=Enabled
47+
```
48+
49+
---
50+
51+
All three preview connectors can publish captured data to the MQTT broker and save captured data to storage.
52+
53+
Azure IoT Operations uses [Azure Container Storage enabled by Azure Arc](/azure/azure-arc/container-storage/overview) to transfer the captured data to cloud storage destinations such as Azure Blob Storage. When you configure a connector template instance, you specify a _persistent volume claim_ and path for the connector to use to save captured data. To learn how to create a suitable persistent volume claim, see [Cloud Ingest Edge Volumes configuration](/azure/azure-arc/container-storage/cloud-ingest-edge-volume-configuration).
54+
55+
To add a connector template instance to your Azure IoT Operations instance:
56+
57+
1. In the Azure portal, go to your Azure IoT Operations instance, select **Connector templates**, and then select **Add connector template instances**:
58+
59+
:::image type="content" source="media/deploy-preview-media-connectors/portal-add-connector-template.png" alt-text="Screenshot of Azure portal that shows how to add a connector template instance.":::
60+
61+
1. On the first page of the **Add an Akri connector template** wizard, select the type of connector template you want to add, such as **ONVIF**, **Media**, or **HTTP REST**. Then select **Metadata**.
62+
63+
:::image type="content" source="media/deploy-preview-media-connectors/select-connector-template-type.png" alt-text="Screenshot of Azure portal that shows how to select the connector template instance type.":::
64+
65+
1. On the **Metadata** page, accept the defaults, and then select **Device inbound endpoint type**.
66+
67+
1. On the **Device inbound endpoint type** page, accept the defaults, and then select **Diagnostics configurations**.
68+
69+
1. On the **Diagnostics configurations** page, accept the defaults, and then select **Runtime configuration**.
70+
71+
1. On the **Runtime configuration** page, select **Add a volume claim** and enter the details of the persistent volume claim you created previously. Then select **Review**:
72+
73+
:::image type="content" source="media/deploy-preview-media-connectors/add-volume-claim.png" alt-text="Screenshot of Azure portal that shows how to configure the runtime settings for the connector template instance.":::
74+
75+
1. On the **Review** page, review the details of the connector template instance, and then select **Create** to create the connector template instance.
2376

24-
Use the `az iot ops connector` command to manage the preview connectors.
77+
An OT user can now use the operations experience web UI to create a device with a preview connector endpoint.
2578

2679
---
55.8 KB
Loading
54.4 KB
Loading
47.5 KB
Loading
-7.08 KB
Loading
52.3 KB
Loading

0 commit comments

Comments
 (0)