Skip to content

Commit beb775c

Browse files
committed
Update rest/http how-to
1 parent 298baf2 commit beb775c

File tree

7 files changed

+45
-52
lines changed

7 files changed

+45
-52
lines changed

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,15 @@ An Azure IoT Operations deployment can include an optional built-in OPC PLC simu
6666

6767
# [Azure CLI](#tab/cli)
6868

69-
Run the following command:
69+
Run the following commands:
7070

7171
```azurecli
7272
az iot ops ns device create -n opc-ua-connector-cli -g {your resource group name} --instance {your instance name}
7373
7474
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"
7575
```
7676

77-
> [!TIP]
78-
> Use `az connectedk8s list` to list the clusters you have access to.
79-
80-
To learn more, see [az iot ops device](/cli/azure/iot/ops/asset/endpoint).
77+
To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
8178

8279
---
8380

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

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ In Azure IoT Operations, the connector for REST/HTTP (preview) enables access to
2121
This article explains how to use the connector for REST/HTTP to perform tasks such as:
2222

2323
- Define the devices that connect HTTP sources to your Azure IoT Operations instance.
24-
- Add assets, and define the data points to enable the data flow from the HTTP source to the MQTT broker.
24+
- 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).
2525

2626
## Prerequisites
2727

@@ -37,12 +37,11 @@ You need any credentials required to access the HTTP source. If the HTTP source
3737

3838
[!INCLUDE [deploy-preview-http-connectors](../includes/deploy-preview-media-connectors.md)]
3939

40-
> [!IMPORTANT]
41-
> 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>`.
42-
4340
## Create a device
4441

45-
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.
42+
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:
43+
44+
# [Operations experience](#tab/portal)
4645

4746
1. In the operations experience web UI, select **Devices** in the left navigation pane. Then select **Create new**.
4847

@@ -64,10 +63,26 @@ To configure the connector for REST/HTTP, first create a device that defines the
6463

6564
:::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":::
6665

66+
# [Azure CLI](#tab/cli)
67+
68+
Run the following commands:
69+
70+
```azurecli
71+
az iot ops ns device create -n rest-http-connector-cli -g {your resource group name} --instance {your instance name}
72+
73+
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"
74+
```
75+
76+
To learn more, see [az iot ops ns device](/cli/azure/iot/ops/ns/device).
77+
78+
---
79+
6780
## Create a namespace asset
6881

6982
To define a namespace asset that publishes data points from the HTTP endpoint, follow these steps:
7083

84+
# [Operations experience](#tab/portal)
85+
7186
1. In the operations experience web UI, select **Assets** in the left navigation pane. Then select **Create namespace asset**.
7287

7388
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
8095

8196
:::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":::
8297

83-
Add details for each data point to publish to the MQTT broker. Then select **Next** to continue.
98+
Add details for each data point to publish to the MQTT broker.
99+
100+
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.
101+
102+
:::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":::
103+
104+
Select **Next** to continue.
84105

85106
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:
86107

87108
:::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":::
109+
110+
# [Azure CLI](#tab/cli)
111+
112+
Run the following command:
113+
114+
```azurecli
115+
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
116+
```
117+
118+
To learn more, see [az iot ops ns asset rest](/cli/azure/iot/ops/ns/asset/rest).
119+
120+
---
68.5 KB
Loading

articles/iot-operations/includes/deploy-preview-media-connectors.md

Lines changed: 4 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,13 @@ ms.date: 07/25/2025
77
ms.author: dobett
88
---
99

10-
Before you can use the preview connectors (ONVIF, media, and REST/HTTP) in the operations experience web UI, an administrator must:
10+
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:
1111

12-
1. Enable them in your Azure IoT Operations instance.
13-
1. Add connector template instances to your Azure IoT Operations instance.
12+
:::image type="content" source="media/deploy-preview-media-connectors/portal-enable-preview-connectors.png" alt-text="Screenshot of Azure portal that shows that preview features are enabled." lightbox="media/deploy-preview-media-connectors/portal-enable-preview-connectors.png":::
1413

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.
14+
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.
1615

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." lightbox="media/deploy-preview-media-connectors/portal-deploy-preview-connectors.png":::
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-
---
30-
31-
To enable the preview connectors after you deploy your Azure IoT Operations instance:
32-
33-
# [Azure portal](#tab/portal)
34-
35-
1. Go to your Azure IoT Operations instance in the Azure portal.
36-
37-
1. Enable the preview connectors:
38-
39-
:::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." lightbox="media/deploy-preview-media-connectors/portal-enable-preview-connectors.png":::
40-
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).
16+
All three preview connectors can publish captured data to the MQTT broker and save captured data to storage. 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 _mount 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).
5417

5518
To add a connector template instance to your Azure IoT Operations instance:
5619

44.5 KB
Loading
2.94 KB
Loading

0 commit comments

Comments
 (0)