Skip to content

Commit 4e3e274

Browse files
authored
Merge pull request #302965 from dominicbetts/release-aio-2507-quickstarts
AIO 2507: Quickstart updates
2 parents 80bd66e + f07f516 commit 4e3e274

File tree

5 files changed

+25
-15
lines changed

5 files changed

+25
-15
lines changed
-3.37 KB
Loading
60.6 KB
Loading

articles/iot-operations/get-started-end-to-end-sample/quickstart-configure.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "Quickstart: Configure your cluster"
3-
description: "Quickstart: Configure asset endpoints, assets, and data flows in your cluster to process and route data from a simulated OPC PLC server to the cloud."
3+
description: "Quickstart: Configure devices, assets, and data flows in your cluster to process and route data from a simulated OPC PLC server to the cloud."
44
author: dominicbetts
55
ms.author: dobett
66
ms.topic: quickstart
77
ms.custom:
88
- ignite-2023
9-
ms.date: 10/17/2024
9+
ms.date: 07/18/2025
1010

1111
#CustomerIntent: As an OT user, I want to configure my Azure IoT Operations cluster so that I can see how to process and route data to a cloud endpoint.
1212
---
@@ -15,13 +15,13 @@ ms.date: 10/17/2024
1515

1616
In this quickstart, you configure the following resources in your Azure IoT Operations cluster:
1717

18-
- An *asset endpoint* that defines a connection to a simulated OPC PLC server that simulates an oven in a bakery.
18+
- A *device* that defines a connection to a simulated OPC PLC server that simulates an oven in a bakery.
1919
- An *asset* that represents the oven and defines the data points that the oven exposes.
2020
- A *data flow* that manipulates the messages from the simulated oven.
2121

22-
An _asset_ is a physical device or logical entity that represents a device, a machine, a system, or a process. For example, a physical asset could be a pump, a motor, a tank, or a production line. A logical asset that you define can have properties, stream messages such as sensor data, or generate events.
22+
In the context of Azure IoT operations, an asset is a logical representation of a physical device or system that you want to monitor or control.
2323

24-
_OPC UA servers_ are software applications that communicate with assets. _OPC UA tags_ are data points that OPC UA servers expose. OPC UA tags can provide real-time or historical data about the status, performance, quality, or condition of assets.
24+
*OPC UA servers* are software applications that communicate with assets. *OPC UA data points* are values that OPC UA servers expose. OPC UA data points can provide real-time or historical data about the status, performance, quality, or condition of assets.
2525

2626
In this quickstart, you use a Bicep file to configure your Azure IoT Operations instance.
2727

@@ -101,7 +101,7 @@ AIO_EXTENSION_NAME=$(az k8s-extension list -g $RESOURCE_GROUP --cluster-name $CL
101101
AIO_INSTANCE_NAME=$(az iot ops list -g $RESOURCE_GROUP --query "[0].name" -o tsv)
102102
CUSTOM_LOCATION_NAME=$(az iot ops list -g $RESOURCE_GROUP --query "[0].extendedLocation.name" -o tsv | awk -F'/' '{print $NF}')
103103

104-
az deployment group create --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --template-file quickstart.bicep --parameters clusterName=$CLUSTER_NAME customLocationName=$CUSTOM_LOCATION_NAME aioExtensionName=$AIO_EXTENSION_NAME aioInstanceName=$AIO_INSTANCE_NAME
104+
az deployment group create --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --template-file quickstart.bicep --parameters clusterName=$CLUSTER_NAME customLocationName=$CUSTOM_LOCATION_NAME aioExtensionName=$AIO_EXTENSION_NAME aioInstanceName=$AIO_INSTANCE_NAME aioNamespaceName=myqsnamespace
105105
```
106106

107107
# [PowerShell](#tab/powershell)
@@ -113,7 +113,7 @@ $AIO_EXTENSION_NAME = (az k8s-extension list -g $RESOURCE_GROUP --cluster-name $
113113
$AIO_INSTANCE_NAME = $(az iot ops list -g $RESOURCE_GROUP --query "[0].name" -o tsv)
114114
$CUSTOM_LOCATION_NAME = (az iot ops list -g $RESOURCE_GROUP --query "[0].extendedLocation.name" -o tsv) -split '/' | Select-Object -Last 1
115115
116-
az deployment group create --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --template-file quickstart.bicep --parameters clusterName=$CLUSTER_NAME customLocationName=$CUSTOM_LOCATION_NAME aioExtensionName=$AIO_EXTENSION_NAME aioInstanceName=$AIO_INSTANCE_NAME
116+
az deployment group create --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --template-file quickstart.bicep --parameters clusterName=$CLUSTER_NAME customLocationName=$CUSTOM_LOCATION_NAME aioExtensionName=$AIO_EXTENSION_NAME aioInstanceName=$AIO_INSTANCE_NAME aioNamespaceName=myqsnamespace
117117
```
118118

119119
---
@@ -122,18 +122,18 @@ az deployment group create --subscription $SUBSCRIPTION_ID --resource-group $RES
122122

123123
The Bicep file configured the following resources:
124124

125-
- An asset endpoint that connects to the OPC PLC simulator.
125+
- A device that connects to the OPC PLC simulator.
126126
- An asset that represents the oven and defines the data points that the oven exposes.
127127
- Two data flows that process the messages from the simulated oven.
128128
- An Azure Event Hubs namespace that contains a destination hub for the data flows.
129129

130-
To view the asset endpoint, asset, and data flows, navigate to the [operations experience](https://iotoperations.azure.com) UI in your browser and sign in with your Microsoft Entra ID credentials. Because you're working with a new deployment, there are no sites yet. You can find the cluster you created in the previous quickstart by selecting **View unassigned instances**. In the operations experience, an instance represents a cluster where you deployed Azure IoT Operations.
130+
To view the device, asset, and data flows, navigate to the [operations experience](https://iotoperations.azure.com) UI in your browser and sign in with your Microsoft Entra ID credentials. Because you're working with a new deployment, there are no sites yet. You can find the cluster you created in the previous quickstart by selecting **View unassigned instances**. In the operations experience, an instance represents a cluster where you deployed Azure IoT Operations.
131131

132132
:::image type="content" source="media/quickstart-configure/instance-list.png" alt-text="Screenshot in the operations experience showing unassigned instances.":::
133133

134-
The asset endpoint defines the connection to the OPC PLC simulator:
134+
The opc-ua-connector device defines the connection to the OPC PLC simulator:
135135

136-
:::image type="content" source="media/quickstart-configure/asset-endpoint-list.png" alt-text="Screenshot in the operations experience that shows a list of asset endpoints.":::
136+
:::image type="content" source="media/quickstart-configure/device-list.png" alt-text="Screenshot in the operations experience that shows a list of devices.":::
137137

138138
The oven asset defines the data points that the oven exposes:
139139

@@ -166,7 +166,7 @@ If messages are flowing, you can use the **Data Explorer** to view the messages:
166166
167167
## How did we solve the problem?
168168

169-
In this quickstart, you used a bicep file to configure your Azure IoT Operations instance with an asset endpoint, asset, and data flow. The configuration processes and routes data from a simulated oven. The data flow in the configuration routes the messages to an Azure Event Hubs instance.
169+
In this quickstart, you used a bicep file to configure your Azure IoT Operations instance with a device, asset, and data flow. The configuration processes and routes data from a simulated oven. The data flow in the configuration routes the messages to an Azure Event Hubs instance.
170170

171171
## Clean up resources
172172

articles/iot-operations/get-started-end-to-end-sample/quickstart-deploy.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ To create your codespace and cluster, use the following steps:
7878
| LOCATION | An Azure region close to you. For the list of currently supported regions, see [Supported regions](../overview-iot-operations.md#supported-regions). |
7979

8080
>[!TIP]
81-
>The values you provide as secrets in this step get saved on your GitHub account to be used in this and future codespaces. They're added as environment variables in the codespace terminal, and you can use those environment variables in the CLI commands in the next section.
81+
>The values you provide as secrets in this step get saved on your GitHub account to be used in this and future Codespaces. They're added as environment variables in the codespace terminal, and you can use those environment variables in the CLI commands in the next section.
8282
>
8383
>Additionally, this codespace creates a `CLUSTER_NAME` environment variable which is set with the codespace name.
8484
@@ -108,7 +108,7 @@ To connect your cluster to Azure Arc:
108108
> If you're using the GitHub codespace environment in a browser rather than VS Code desktop, running `az login` returns a localhost error. To fix the error, either:
109109
>
110110
> * Open the codespace in VS Code desktop, and then return to the browser terminal and rerun `az login`.
111-
> * Or, after you get the localhost error on the browser, copy the URL from the browser and run `curl "<URL>"` in a new terminal tab. You should see a JSON response with the message "You have logged into Microsoft Azure!."
111+
> * Or, after you get the localhost error on the browser, copy the URL from the browser and run `curl "<URL>"` in a new terminal tab. You should see a JSON response with the message "You have logged into Microsoft Azure!"
112112
113113
1. After you sign in, Azure CLI displays all of your subscriptions and indicates your default subscription with an asterisk `*`. To continue with your default subscription, select `Enter`. Otherwise, type the number of the Azure subscription that you want to use.
114114

@@ -187,6 +187,16 @@ Run the following CLI commands in your Codespaces terminal.
187187
az iot ops schema registry create --name $SCHEMA_REGISTRY --resource-group $RESOURCE_GROUP --registry-namespace $SCHEMA_REGISTRY_NAMESPACE --sa-resource-id $(az storage account show --name $STORAGE_ACCOUNT -o tsv --query id)
188188
```
189189

190+
## Create an Azure Device Registry namespace
191+
192+
Azure IoT Operations and Azure Device Registry use _namespaces_ to organize assets and devices. Each Azure IoT Operations instance uses a single namespace for its assets and devices.
193+
194+
Run the following CLI command to create an Azure Device Registry namespace.
195+
196+
```azurecli
197+
az iot ops ns create -n myqsnamespace -g $RESOURCE_GROUP
198+
```
199+
190200
## Deploy Azure IoT Operations
191201

192202
In this section, you configure your cluster with the dependencies for your Azure IoT Operations components, then deploy Azure IoT Operations.
@@ -207,7 +217,7 @@ Run the following CLI commands in your Codespaces terminal.
207217
1. Deploy Azure IoT Operations.
208218

209219
```azurecli
210-
az iot ops create --cluster $CLUSTER_NAME --resource-group $RESOURCE_GROUP --name ${CLUSTER_NAME}-instance --sr-resource-id $(az iot ops schema registry show --name $SCHEMA_REGISTRY --resource-group $RESOURCE_GROUP -o tsv --query id) --broker-frontend-replicas 1 --broker-frontend-workers 1 --broker-backend-part 1 --broker-backend-workers 1 --broker-backend-rf 2 --broker-mem-profile Low
220+
az iot ops create --cluster $CLUSTER_NAME --resource-group $RESOURCE_GROUP --name ${CLUSTER_NAME}-instance --sr-resource-id $(az iot ops schema registry show --name $SCHEMA_REGISTRY --resource-group $RESOURCE_GROUP -o tsv --query id) --ns-resource-id $(az iot ops ns show --name myqsnamespace --resource-group $RESOURCE_GROUP -o tsv --query id) --broker-frontend-replicas 1 --broker-frontend-workers 1 --broker-backend-part 1 --broker-backend-workers 1 --broker-backend-rf 2 --broker-mem-profile Low
211221
```
212222

213223
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.

0 commit comments

Comments
 (0)