Merge pull request #307416 from SoniaLopezBravo/mqtt-broker-data-persistence

Changes to MQTT persistence

Author: prmerger-automator[bot]

articles/iot-operations/manage-mqtt-broker/howto-broker-persistence.md

@@ -6,7 +6,7 @@ ms.author: sonialopez
 ms.topic: how-to
 ms.service: azure-iot-operations
 ms.subservice: azure-mqtt-broker
-ms.date: 07/28/2025
+ms.date: 10/27/2025
 
 ---
 
@@ -63,27 +63,40 @@ To configure volume settings in the Azure portal:
 
 # [Azure CLI](#tab/azurecli)
 
-To configure volume settings using Azure CLI, prepare a Broker configuration file in JSON format:
+1. To deploy MQTT Broker with the minimum required settings to enable disk persistence, use the `az iot ops create` command.
 
-```json
-{
-  "persistence": {
-    "maxSize": "10GiB",
-    "persistentVolumeClaimSpec": {
-      "storageClassName": "example-storage-class",
-      "accessModes": [
-        "ReadWriteOncePod"
-      ]
-    }
-  }
-}
-```
+    ```azurecli
+    az iot ops create --cluster <CLUSTER_NAME> -g <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME> --sr-resource-id <SCHEMA_REGISTRY_RESOURCE_ID> --ns-resource-id <NAMESPACE_RESOURCE_ID> --persist-max-size 10Gi
+    ```
 
-Then run the [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command with the `--broker-config-file` flag to deploy IoT Operations:
+1. To deploy MQTT Broker with disk persistence, custom persistent volume claim, and custom persist mode settings, add the `--persist-pvc-sc` and `--persist-mode` flags to the `az iot ops create` command.
 
-```azurecli
-az iot ops create --broker-config-file <BROKER_CONFIG_FILE>.json --cluster <CLUSTER_NAME> --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP_NAME> --sr-resource-id <SCHEMA_REGISTRY_RESOURCE_ID>
-```
+    ```azurecli
+    az iot ops create --cluster <CLUSTER_NAME> -g <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME> --sr-resource-id <SCHEMA_REGISTRY_RESOURCE_ID> --ns-resource-id <NAMESPACE_RESOURCE_ID> --persist-max-size 10Gi --persist-pvc-sc <MYSTORAGECLASS> --persist-mode retain=All stateStore=None
+    ```
+
+
+1. If you want to use a custom broker configuration file, add the `--broker-config-file` flag and include the persistence settings in the JSON file.
+
+    ```azurecli
+    az iot ops create --broker-config-file <BROKER_CONFIG_FILE>.json --cluster <CLUSTER_NAME> --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP_NAME> --sr-resource-id <SCHEMA_REGISTRY_RESOURCE_ID>
+    ```
+
+    The following is an example JSON snippet to include in your custom broker configuration file to set up persistence with a maximum size of 10 GiB and a custom storage class.
+    
+    ```json
+    {
+      "persistence": {
+        "maxSize": "10GiB",
+        "persistentVolumeClaimSpec": {
+          "storageClassName": "example-storage-class",
+          "accessModes": [
+            "ReadWriteOncePod"
+          ]
+        }
+      }
+    }
+    ```
 
 ---