Skip to content

Commit 7f2cbd7

Browse files
Merge pull request #300098 from SoniaLopezBravo/adding-cloning-feature-azoit
Adding cloning feature to az iot ops
2 parents 040baec + dc0d38c commit 7f2cbd7

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

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

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: SoniaLopezBravo
55
ms.author: sonialopez
66
ms.topic: how-to
77
ms.custom: devx-track-azurecli
8-
ms.date: 04/08/2025
8+
ms.date: 05/20/2025
99

1010
#CustomerIntent: As an OT professional, I want to manage Azure IoT Operations instances.
1111
---
@@ -107,6 +107,50 @@ You can run `az iot ops check` on your cluster to assess health and configuratio
107107

108108
---
109109

110+
### (Preview) Clone instance
111+
112+
> [!NOTE]
113+
> The clone feature is in preview and under development.
114+
115+
#### [Azure portal](#tab/portal)
116+
117+
Currently, the Azure portal doesn't support cloning an Azure IoT Operations instance. You can use the Azure CLI to clone an instance.
118+
119+
#### [Azure CLI](#tab/cli)
120+
121+
Use the [`az iot ops clone`](/cli/azure/iot/ops#az-iot-ops-clone) command to create a new Azure IoT Operations instance based on an existing one. You can apply the output of clone to another connected cluster, which is referred to as replication. You can also save the clone to a local directory for later use and perform some configuration changes before applying it to a cluster.
122+
123+
For more information, see the [clone command wiki page](https://github.com/Azure/azure-iot-ops-cli-extension/wiki/Clone).
124+
125+
To clone an instance to another cluster, run:
126+
127+
```azurecli
128+
az iot ops clone --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --to-cluster-id <CLUSTER_ID>
129+
```
130+
131+
To customize the replication to another cluster, use `--param` and specify the parameters you want to change in the format `key=value`. For example, to change the location of the cloned instance, run:
132+
133+
```azurecli
134+
az iot ops clone --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --to-cluster-id <CLUSTER_ID> --param location=eastus
135+
```
136+
137+
To clone an instance to a local directory, run:
138+
139+
```azurecli
140+
az iot ops clone --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --to-dir <DIRECTORY>
141+
```
142+
143+
> [!TIP]
144+
> To clone an instance to the current directory, run `--to-dir .`
145+
146+
To clone an instance to a cluster, but splitting and serially applying asset related sub-deployments, run:
147+
148+
```azurecli
149+
az iot ops clone --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --to-cluster-id <CLUSTER_ID> --mode linked
150+
```
151+
152+
---
153+
110154
### Update instances and configuration
111155

112156
#### [Azure portal](#tab/portal2)
@@ -119,7 +163,7 @@ You can run `az iot ops check` on your cluster to assess health and configuratio
119163

120164
#### [Azure CLI](#tab/cli2)
121165

122-
Use the `az iot ops update` command to edit the features of your Azure IoT Operations instance.
166+
Use the [az iot ops update](/cli/azure/iot/ops#az-iot-ops-update) command to edit the features of your Azure IoT Operations instance.
123167

124168
To update tags and description parameters of an instance, run:
125169

0 commit comments

Comments
 (0)