Skip to content

Commit e30264a

Browse files
Merge pull request #297819 from SoniaLopezBravo/enable-instance-feature
Adding how to enable preview connector
2 parents 49dff23 + 51173cc commit e30264a

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ ms.topic: how-to
77
ms.custom: ignite-2023, devx-track-azurecli
88
ms.date: 04/08/2025
99

10-
1110
#CustomerIntent: As an OT professional, I want to deploy Azure IoT Operations to a Kubernetes cluster.
1211
---
1312

@@ -128,10 +127,9 @@ Use these steps if you chose the **Test settings** option on the **Dependency ma
128127
az login
129128
```
130129
131-
1. Install the latest Azure IoT Operations CLI extension.
130+
1. Install the latest Azure IoT Operations CLI extension if you haven't already.
132131
133132
```azurecli
134-
az upgrade
135133
az extension add --upgrade --name azure-iot-ops
136134
```
137135
@@ -142,13 +140,19 @@ Use these steps if you chose the **Test settings** option on the **Dependency ma
142140
1. Prepare the cluster for Azure IoT Operations deployment. Copy and run the provided [az iot ops init](/cli/azure/iot/ops#az-iot-ops-init) command.
143141
144142
>[!TIP]
145-
>The `init` command only needs to be run once per cluster. If you're reusing a cluster that already had Azure IoT Operations version 0.8.0 deployed on it, you can skip this step.
143+
>The `init` command only needs to be run once per cluster. If you're reusing a cluster that already has the latest version of Azure IoT Operations deployed on it, you can skip this step.
146144
147145
If you followed the optional prerequisite to set up your own certificate authority issuer, add the `--user-trust` flag to the `init` command.
148146
149147
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
150148
151149
1. Deploy Azure IoT Operations. Copy and run the provided [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command.
150+
151+
* If you want to use the preview connector configuration, add the following parameter to the `create` command:
152+
153+
```bash
154+
--feature connectors.settings.preview=Enabled
155+
```
152156
153157
* If you followed the optional prerequisites to prepare your cluster for observability, add the following parameters to the `create` command:
154158
@@ -220,8 +224,14 @@ Use these steps if you chose the **Secure settings** option on the **Dependency
220224
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
221225
222226
1. Deploy Azure IoT Operations. Copy and run the provided [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command.
227+
228+
* If you want to use the preview connector configuration, add the following parameter to the `create` command:
229+
230+
```bash
231+
--feature connectors.settings.preview=Enabled
232+
```
223233
224-
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
234+
* If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
225235
226236
| Optional parameter | Value | Description |
227237
| --------- | ----- | ----------- |

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,19 +107,21 @@ You can run `az iot ops check` on your cluster to assess health and configuratio
107107

108108
---
109109

110-
### Update instance tags and description
110+
### Update instances and configuration
111111

112-
#### [Azure portal](#tab/portal)
112+
#### [Azure portal](#tab/portal2)
113113

114114
1. In the [Azure portal](https://portal.azure.com), go to the resource group that contains your Azure IoT Operations instance, or search for and select **Azure IoT Operations**.
115115

116116
1. Select the name of your Azure IoT Operations instance.
117117

118118
1. On the **Overview** page of your instance, select **Add tags** or **edit** to modify tags on your instance.
119119

120-
#### [Azure CLI](#tab/cli)
120+
#### [Azure CLI](#tab/cli2)
121+
122+
Use the `az iot ops update` command to edit the features of your Azure IoT Operations instance.
121123

122-
Use the `az iot ops update` command to edit the tags and description parameters of your Azure IoT Operations instance. The values provided in the `update` command replace any existing tags or description
124+
To update tags and description parameters of an instance, run:
123125

124126
```azurecli
125127
az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --desc "<INSTANCE_DESCRIPTION>" --tags <TAG_NAME>=<TAG-VALUE> <TAG_NAME>=<TAG-VALUE>
@@ -131,6 +133,18 @@ To delete all tags on an instance, set the tags parameter to a null value. For e
131133
az iot ops update --name <INSTANCE_NAME> --resource-group --tags ""
132134
```
133135

136+
To enable the preview connector configuration, run:
137+
138+
```azurecli
139+
az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --feature connectors.settings.preview=Enabled
140+
```
141+
142+
To disable the preview connector configuration, run:
143+
144+
```azurecli
145+
az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --feature connectors.settings.preview=Disabled
146+
```
147+
134148
---
135149

136150
### Manage components

0 commit comments

Comments
 (0)