az iot ops rsync
Note
This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az iot ops rsync command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Resource sync rules management.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot ops rsync disable |
Disable edge to cloud hydration by deleting instance associated resource sync rules. |
Extension | Preview |
| az iot ops rsync enable |
Enable edge to cloud hydration by creating resource sync rules for the instance. |
Extension | Preview |
| az iot ops rsync list |
List resource sync rules associated with the instance. |
Extension | Preview |
az iot ops rsync disable
Command group 'iot ops rsync' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Disable edge to cloud hydration by deleting instance associated resource sync rules.
az iot ops rsync disable --instance
--resource-group
[--yes {false, true}]Examples
Disable resource sync for the target instance.
az iot ops rsync disable -n myinstance -g myresourcegroupRequired Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Confirm [y]es without a prompt. Useful for CI and automation scenarios.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops rsync enable
Command group 'iot ops rsync' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Enable edge to cloud hydration by creating resource sync rules for the instance.
This operation will create two resource sync rules. One for IoT Operations and one for Device Registry. It will then apply a role assignment between the K8 Bridge service principal and the IoT Operations instance custom location.
az iot ops rsync enable --instance
--resource-group
[--custom-role-id]
[--k8-bridge-sp-oid]
[--rule-adr-name]
[--rule-adr-pri]
[--rule-ops-name]
[--rule-ops-pri]
[--skip-ra {false, true}]
[--tags]Examples
Enable resource sync for the instance.
az iot ops rsync enable -n myinstance -g myresourcegroupEnable resource sync for the instance but skip the role assignment step.
az iot ops rsync enable -n myinstance -g myresourcegroup --skip-raEnable resource sync for the instance and explictly provide the K8 Bridge principal OID.
az iot ops rsync enable -n myinstance -g myresourcegroup --k8-bridge-sp-oid $TENANT_K8_BRIDGE_SP_OIDEnable resource sync for the instance with some customization.
az iot ops rsync enable -n myinstance -g myresourcegroup --rule-adr-name myadrsync --rule-ops-name myopsync --rule-adr-pri 100 --rule-ops-pri 200Required Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Fully qualified role definition Id in the following format: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.
Provide an explicit K8 Bridge service principal OID for the custom location role assignment. This is useful if the logged-in principal does not have permission to query apps from MS Graph.
The desired name of the resource sync rule to create for Device Registry.
The desired priority of the resource sync rule to create for Device Registry.
The desired name of the resource sync rule to create for IoT Operations.
The desired priority of the resource sync rule to create for IoT Operations.
When used the role assignment step of the operation will be skipped.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot ops rsync list
Command group 'iot ops rsync' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List resource sync rules associated with the instance.
az iot ops rsync list --instance
--resource-groupExamples
List resource sync rules associated with the instance.
az iot ops rsync list -n myinstance -g myresourcegroupRequired Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
