Merge pull request #303904 from dominicbetts/aio-connecotors-cli

AIO: Connector CLI updates

Author: denrea

articles/iot-operations/discover-manage-assets/howto-configure-opc-ua.md

@@ -66,18 +66,15 @@ An Azure IoT Operations deployment can include an optional built-in OPC PLC simu
 
 # [Azure CLI](#tab/cli)
 
-Run the following command:
+Run the following commands:
 
 ```azurecli
 az iot ops ns device create -n opc-ua-connector-cli -g {your resource group name} --instance {your instance name} 
 
 az iot ops ns device endpoint inbound add opcua --device opc-ua-connector-cli -g {your resource group name} -i {your instance name} --name opc-ua-connector-0 --endpoint-address "opc.tcp://opcplc-000000:50000"
 ```
 
-> [!TIP]
-> Use `az connectedk8s list` to list the clusters you have access to.
-
-To learn more, see [az iot ops device](/cli/azure/iot/ops/asset/endpoint).
+To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
 
 ---
 

articles/iot-operations/discover-manage-assets/howto-use-http-connector.md

@@ -21,7 +21,7 @@ In Azure IoT Operations, the connector for REST/HTTP (preview) enables access to
 This article explains how to use the connector for REST/HTTP to perform tasks such as:
 
 - Define the devices that connect HTTP sources to your Azure IoT Operations instance.
-- Add assets, and define the data points to enable the data flow from the HTTP source to the MQTT broker.
+- Add assets, and define the data points to enable the data flow from the HTTP source to the MQTT broker or [broker state store](../develop-edge-apps/overview-state-store.md).
 
 ## Prerequisites
 
@@ -35,14 +35,13 @@ You need any credentials required to access the HTTP source. If the HTTP source
 
 ## Deploy the connector for REST/HTTP
 
-[!INCLUDE [deploy-preview-http-connectors](../includes/deploy-preview-media-connectors.md)]
-
-> [!IMPORTANT]
-> If you don't enable preview features, you see the following error message in the `aio-supervisor-...` pod logs when you try to use the HTTP, media, or ONVIF connectors: `No connector configuration present for AssetEndpointProfile: <AssetEndpointProfileName>`.
+[!INCLUDE [deploy-preview-media-connectors-simple](../includes/deploy-preview-media-connectors-simple.md)]
 
 ## Create a device
 
-To configure the connector for REST/HTTP, first create a device that defines the connection to the HTTP source. The device includes the URL of the HTTP source and any credentials you need to access the HTTP source.
+To configure the connector for REST/HTTP, first create a device that defines the connection to the HTTP source. The device includes the URL of the HTTP source and any credentials you need to access the HTTP source:
+
+# [Operations experience](#tab/portal)
 
 1. In the operations experience web UI, select **Devices** in the left navigation pane. Then select **Create new**.
 
@@ -64,10 +63,26 @@ To configure the connector for REST/HTTP, first create a device that defines the
 
     :::image type="content" source="media/howto-use-http-connector/http-connector-device-created.png" alt-text="Screenshot that shows the list of devices." lightbox="media/howto-use-http-connector/http-connector-device-created.png":::
 
+# [Azure CLI](#tab/cli)
+
+Run the following commands:
+
+```azurecli
+az iot ops ns device create -n rest-http-connector-cli -g {your resource group name} --instance {your instance name} 
+
+az iot ops ns device endpoint inbound add rest --device rest-http-connector-cli -g {your resource group name} -i {your instance name}  --name rest-http-connector-0 --endpoint-address "https://rest-http-connector-0"
+```
+
+To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
+
+---
+
 ## Create a namespace asset
 
 To define a namespace asset that publishes data points from the HTTP endpoint, follow these steps:
 
+# [Operations experience](#tab/portal)
+
 1. In the operations experience web UI, select **Assets** in the left navigation pane. Then select **Create namespace asset**.
 
 1. Select the inbound endpoint for the connector for REST/HTTP that you created in the previous section.
@@ -80,8 +95,26 @@ To define a namespace asset that publishes data points from the HTTP endpoint, f
 
     :::image type="content" source="media/howto-use-http-connector/add-data-point.png" alt-text="Screenshot that shows how to add a data point for HTTP source." lightbox="media/howto-use-http-connector/add-data-point.png":::
 
-    Add details for each data point to publish to the MQTT broker. Then select **Next** to continue.
+    Add details for each data point to publish to the MQTT broker.
+
+1. To configure the destination for the data, select **Manage default dataset**. Choose either **MQTT broker** or **Broker state store** as the destination. If you choose **MQTT broker**, you can enter the name of the topic to publish to. If you choose **Broker state store**, you can enter the key of the entry in the state store to use.
+
+    :::image type="content" source="media/howto-use-http-connector/configure-dataset.png" alt-text="Screenshot that shows how to configure the dataset for HTTP source." lightbox="media/howto-use-http-connector/configure-dataset.png":::
+
+    Select **Next** to continue.
 
 1. On the **Review** page, review the details of the asset and select **Create** to create the asset. After a few minutes, the asset is listed on the **Assets** page:
 
     :::image type="content" source="media/howto-use-http-connector/http-asset-created.png" alt-text="Screenshot that shows the list of assets." lightbox="media/howto-use-http-connector/http-asset-created.png":::
+
+# [Azure CLI](#tab/cli)
+
+Run the following command:
+
+```azurecli
+az iot ops ns asset rest create --name myrestasset --instance {your instance name} -g {your resource group name} --device rest-http-connector-cli --endpoint rest-http-connector-0 --dataset-dest topic="azure-iot-operations/data/erp" retain=Never qos=Qos1 ttl=3600
+```
+
+To learn more, see [az iot ops ns asset rest](/cli/azure/iot/ops/ns/asset/rest).
+
+---

articles/iot-operations/discover-manage-assets/howto-use-media-connector.md

@@ -23,11 +23,11 @@ This article explains how to use the media connector to perform tasks such as:
 - Define the devices that connect media sources to your Azure IoT Operations instance.
 - Add assets, and define their streams for capturing media from the media source.
 - Send an image snapshot to the MQTT broker.
-- Save a video stream to a local file system.
+- Save a video clip to Azure storage.
 
 ## Prerequisites
 
-To configure devices and assets, you need a running instance of Azure IoT Operations.
+To configure devices and assets, you need a running preview instance of Azure IoT Operations.
 
 [!INCLUDE [iot-operations-entra-id-setup](../includes/iot-operations-entra-id-setup.md)]
 
@@ -37,13 +37,12 @@ A camera connected to your network and accessible from your Azure IoT Operations
 
 [!INCLUDE [deploy-preview-media-connectors](../includes/deploy-preview-media-connectors.md)]
 
-> [!IMPORTANT]
-> If you don't enable preview features, you see the following error message in the `aio-supervisor-...` pod logs when you try to use the media or ONVIF connectors: `No connector configuration present for AssetEndpointProfile: <AssetEndpointProfileName>`.
-
-## Create a device
+## Create a device with a media endpoint
 
 To configure the media connector, first create a device that defines the connection to the media source. The device includes the URL of the media source and any credentials you need to access the media source:
 
+# [Operations experience](#tab/portal)
+
 1. In the operations experience web UI, select **Devices** in the left navigation pane. Then select **Create new**.
 
 1. Enter a name for your device, such as `media-connector`. To add the endpoint for the media connector, select **New** on the **Microsoft.Media** tile.
@@ -64,9 +63,25 @@ To configure the media connector, first create a device that defines the connect
 
     :::image type="content" source="media/howto-use-media-connector/media-connector-device-created.png" alt-text="Screenshot that shows the list of devices." lightbox="media/howto-use-media-connector/media-connector-device-created.png":::
 
+# [Azure CLI](#tab/cli)
+
+Run the following commands:
+
+```azurecli
+az iot ops ns device create -n media-connector-cli -g {your resource group name} --instance {your instance name} 
+
+az iot ops ns device endpoint inbound add media --device media-connector-cli -g {your resource group name} -i {your instance name}  --name media-connector-cli-0 --endpoint-address rtsp://samplecamera:554/stream1
+```
+
+To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
+
+---
+
 ## Create an asset to publish an image snapshot
 
-To define a namespace asset that publishes an image snapshot from the media source, follow these steps:
+To define a namespace asset that publishes an image snapshot from the media source to the MQTT broker:
+
+# [Operations experience](#tab/portal)
 
 1. In the operations experience web UI, select **Assets** in the left navigation pane. Then select **Create namespace asset**.
 
@@ -78,7 +93,7 @@ To define a namespace asset that publishes an image snapshot from the media sour
 
 1. On the **Streams** page, select **Add stream** to add a stream for the asset.
 
-1. Add a name for the stream, such as `mysnapshots`. Set MQTT as the destination and add a name for the MQTT topic to publish to such as `mysnapshots`. Select `mqtt-to-snapshot` as the task type.
+1. Add a name for the stream, such as `mysnapshots`. Set MQTT as the destination and add a name for the MQTT topic to publish to such as `mysnapshots`. Select `snapshot-to-mqtt` as the task type.
 
     :::image type="content" source="media/howto-use-media-connector/add-snapshot-stream.png" alt-text="Screenshot that shows how to add a snapshot stream." lightbox="media/howto-use-media-connector/add-snapshot-stream.png":::
 
@@ -88,10 +103,24 @@ To define a namespace asset that publishes an image snapshot from the media sour
 
 1. On the **Review** page, review the details of the asset and select **Create** to create the asset.
 
+# [Azure CLI](#tab/cli)
+
+Run the following command:
+
+```azurecli
+az iot ops ns asset media create --name mymediaasset --instance {your instance name}  -g {your resource group name} --device media-connector-cli --endpoint media-connector-cli-0 --task-type snapshot-to-mqtt --task-format jpeg --snapshots-per-sec 0.25 --stream-dest topic="azure-iot-operations/data/snapshots" qos=Qos1 retain=Never ttl=60
+```
+
+To learn more, see [az iot ops ns asset rest](/cli/azure/iot/ops/ns/asset/rest).
+
+---
+
 ## Add a stream to save a video clip
 
 In this section, you add a stream to the asset that saves video clips from the media source to the file system.
 
+# [Operations experience](#tab/portal)
+
 1. In the operations experience web UI, select **Assets** in the left navigation pane. Then select the `my-media-source` asset you created in the previous section.
 
 1. Select **Streams** and then select **Add stream** to add a stream to the asset.
@@ -105,3 +134,13 @@ In this section, you add a stream to the asset that saves video clips from the m
 1. The new stream is listed in the asset's **Streams** page:
 
     :::image type="content" source="media/howto-use-media-connector/media-connector-streams.png" alt-text="Screenshot that shows the list of streams for the media connector asset." lightbox="media/howto-use-media-connector/media-connector-streams.png":::
+
+# [Azure CLI](#tab/cli)
+
+Run the following command:
+
+```azurecli
+az iot ops ns asset media stream add --asset mymediaasset --instance {your instance name}  -g {your resource group name} --name clipStream --task-type clip-to-fs --format mp4 --duration 30 --path /data/clips
+```
+
+---

articles/iot-operations/discover-manage-assets/howto-use-onvif-connector.md

@@ -35,14 +35,13 @@ An ONVIF compliant camera that you can reach from your Azure IoT Operations clus
 
 ## Deploy the connector for ONVIF
 
-[!INCLUDE [deploy-preview-media-connectors](../includes/deploy-preview-media-connectors.md)]
-
-> [!IMPORTANT]
-> If you don't enable preview features, you see the following error message in the `aio-supervisor-...` pod logs when you try to use the media or ONVIF connectors: `No connector configuration present for AssetEndpointProfile: <AssetEndpointProfileName>`.
+[!INCLUDE [deploy-preview-media-connectors-simple](../includes/deploy-preview-media-connectors-simple.md)]
 
 ## Create a device with an ONVIF endpoint
 
-To add a device that defines an ONVIF endpoint for a compliant camera, follow these steps:
+To add a device that includes an ONVIF endpoint for a compliant camera:
+
+# [Operations experience](#tab/portal)
 
 1. In the operations experience web UI, select **Devices** from the left navigation pane:
 
@@ -62,6 +61,20 @@ To add a device that defines an ONVIF endpoint for a compliant camera, follow th
 
     :::image type="content" source="media/howto-use-onvif-connector/device-created.png" alt-text="Screenshot that shows the device created in the operations experience." lightbox="media/howto-use-onvif-connector/device-created.png":::
 
+# [Azure CLI](#tab/cli)
+
+Run the following commands:
+
+```azurecli
+az iot ops ns device create -n onvif-connector-cli -g {your resource group name} --instance {your instance name}
+
+az iot ops ns device endpoint inbound add onvif --device onvif-connector-cli -g {your resource group name} -i {your instance name}  --name onvif-connector-cli-0 --endpoint-address http://myonvifcam:2020/onvif/device_service
+```
+
+To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
+
+---
+
 ## View the discovered assets and devices
 
 After you create a device with an ONVIF endpoint, the connector for ONVIF automatically discovers the assets and devices that are available at the endpoint. To view the discovered assets and devices in the operations experience web UI, select **Discovery** from the left navigation pane:

articles/iot-operations/discover-manage-assets/media/howto-use-http-connector/configure-dataset.png

@@ -26,6 +26,18 @@ The media connector can connect to various sources, including:
 | Media file | `http://camera1/snapshot/profile1`<br/>`nfs://server/path/file.extension`<br/>` file://localhost/media/path/file.mkv`  | Any media file with a URL accessible from the cluster. |
 | Media folder | `file://host/path/to/folder/`<br/>`ftp://server/path/to/folder/` | A folder, accessible from the cluster, that contains media files such as snapshots or clips. |
 
+## Task types
+
+The media connector supports the following task types:
+
+| Task type | Description |
+|-----------|-------------|
+| snapshot-to-mqtt | Captures a snapshot from a media source and publishes it to an MQTT topic. |
+| clip-to-fs | Saves a video clip from a media source to the file system. |
+| snapshot-to-fs | Saves a snapshot from a media source to the file system. |
+| stream-to-rtsp | Proxies a live video stream from a media source to an RTSP endpoint. |
+| stream-to-rtsps | Proxies a live video stream from a media source to an RTSPs endpoint. |
+
 ## Example uses
 
 Example uses of the media connector include:

articles/iot-operations/discover-manage-assets/overview-media-connector.md

@@ -0,0 +1,40 @@
+---
+title: Include file
+description: Include file
+author: dominicbetts
+ms.topic: include
+ms.date: 07/25/2025
+ms.author: dobett
+---
+
+When you deploy the preview version of Azure IoT Operations, the deployment includes the three preview connectors. You can verify that you have a preview instance of Azure IoT Operations by checking in the Azure portal that preview features are enabled for your instance:
+
+:::image type="content" source="media/deploy-preview-media-connectors-simple/portal-enable-preview-connectors.png" alt-text="Screenshot of Azure portal that shows that preview features are enabled." lightbox="media/deploy-preview-media-connectors-simple/portal-enable-preview-connectors.png":::
+
+Before you can use the preview connectors (ONVIF, media, and REST/HTTP) in the operations experience web UI, an administrator must add connector template instances to your Azure IoT Operations instance.
+
+All three preview connectors can publish captured data to the MQTT broker.
+
+To add a connector template instance to your Azure IoT Operations instance:
+
+1. In the Azure portal, go to your Azure IoT Operations instance, select **Connector templates**, and then select **Add connector template instances**:
+
+    :::image type="content" source="media/deploy-preview-media-connectors-simple/portal-add-connector-template.png" alt-text="Screenshot of Azure portal that shows how to add a connector template instance." lightbox="media/deploy-preview-media-connectors-simple/portal-add-connector-template.png":::
+
+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**.
+
+    :::image type="content" source="media/deploy-preview-media-connectors-simple/select-connector-template-type.png" alt-text="Screenshot of Azure portal that shows how to select the connector template instance type." lightbox="media/deploy-preview-media-connectors-simple/select-connector-template-type.png":::
+
+1. On the **Metadata** page, accept the defaults, and then select **Device inbound endpoint type**.
+
+1. On the **Device inbound endpoint type** page, accept the defaults, and then select **Diagnostics configurations**.
+
+1. On the **Diagnostics configurations** page, accept the defaults, and then select **Runtime configuration**.
+
+1. On the **Runtime configuration** page,  accept the defaults, and then select **Review**:
+
+1. On the **Review** page, review the details of the connector template instance, and then select **Create** to create the connector template instance.
+
+An OT user can now use the operations experience web UI to create a device with a preview connector endpoint.
+
+---