Skip to content

Commit 6b5ae7f

Browse files
committed
Added some clarity to the uami CM documentation
1 parent 36d0900 commit 6b5ae7f

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

articles/operator-nexus/howto-cluster-managed-identity-user-provided-resources.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: DanCrank
55
ms.author: danielcrank
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 4/28/2025
8+
ms.date: 5/23/2025
99
ms.custom: template-how-to
1010
---
1111

@@ -17,7 +17,7 @@ Managed identities are used with the following user resources provided on Operat
1717

1818
- Storage Accounts used for the output of Bare Metal run-\* commands.
1919
- Key Vaults used for credential rotation.
20-
- Log Analytics Workspaces used to capture some metrics.
20+
- Log Analytics Workspaces (LAW) used to capture some metrics.
2121

2222
To learn more about managed identities in Azure, see [Managed identities for Azure resources](/entra/identity/managed-identities-azure-resources/overview). Operator Nexus Clusters support multiple User Assigned Managed Identities (UAMI) or one system assigned managed identity (SAMI).
2323

@@ -31,7 +31,7 @@ Once added, the Identity can only be removed via the API call at this time. For
3131
- Install the latest version of the [appropriate Azure CLI extensions](./howto-install-cli-extensions.md).
3232

3333
> [!NOTE]
34-
> The managed identity functionality for Log Analytics Workspace and Key Vault exists with the 2024-10-01-preview API and will be available with the 2025-02-01 GA API.
34+
> The managed identity functionality for Log Analytics Workspace (LAW) and Key Vault exists with the 2024-10-01-preview API and will be available with the 2025-02-01 GA API.
3535
3636
## Operator Nexus Clusters with User Assigned Managed Identities (UAMI)
3737

@@ -40,7 +40,7 @@ It's a best practice to first define all of the user provided resources (Storage
4040
The impacts of not configuring these resources by deployment time for a new Cluster are as follows:
4141

4242
- _Storage Account:_ run-\* command outputs fail to be written to the Storage Account.
43-
- _LAW:_ Cluster deployment fails as the LAW is required to install software extensions during deployment.
43+
- _LAW:_ Cluster deployment fails as the LAW (Log Analytics Workplace) is required to install software extensions during deployment.
4444
- _Key Vault:_ Credential rotations fail as there's a check to ensure write access to the user provided Key Vault before performing credential rotation.
4545

4646
Updating the Cluster can be done at any time. Changing the LAW settings might cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW might need to be reinstalled.
@@ -207,7 +207,7 @@ az networkcloud cluster update --name "clusterName" --resource-group "resourceGr
207207
_Example 3:_ Update a Cluster that already has a SAMI and add a UAMI. The SAMI is retained. Then assign the UAMI to the log analytics output settings (LAW).
208208

209209
> [!CAUTION]
210-
> Changing the LAW settings might cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW might need to be reinstalled.
210+
> Changing the LAW settings will cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW might need to be reinstalled.
211211
212212
Cluster update to add the UAMI `mUAMI`.
213213

@@ -397,7 +397,7 @@ az networkcloud cluster update --name "clusterName" --resource-group "resourceGr
397397
_Example 2:_ Add or update the log analytics output settings (LAW) for a Cluster.
398398

399399
> [!CAUTION]
400-
> Changing the LAW settings might cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW might need to be reinstalled.
400+
> Changing the LAW settings will cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW need to be reinstalled.
401401
402402
```azurecli-interactive
403403
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" \
@@ -446,9 +446,9 @@ Note, `<APIVersion>` is the API version 2024-07-01 or newer.
446446

447447
```azurecli
448448
{
449-
"identity": {
449+
"identity": {
450450
"type": "SystemAssigned"
451-
}
451+
}
452452
}
453453
```
454454

@@ -462,12 +462,12 @@ Note, `<APIVersion>` is the API version 2024-07-01 or newer.
462462

463463
```azurecli
464464
{
465-
"identity": {
465+
"identity": {
466466
"type": "UserAssigned",
467-
"userAssignedIdentities": {
468-
"/subscriptions/$SUB_ID/resourceGroups/$UAI_RESOURCE_GROUP/providers/Microsoft.ManagedIdentity/userAssignedIdentities/$UAI_NAME": {}
469-
}
470-
}
467+
"userAssignedIdentities": {
468+
"/subscriptions/$SUB_ID/resourceGroups/$UAI_RESOURCE_GROUP/providers/Microsoft.ManagedIdentity/userAssignedIdentities/$UAI_NAME": {}
469+
}
470+
}
471471
}
472472
```
473473

@@ -481,11 +481,11 @@ Note, `<APIVersion>` is the API version 2024-07-01 or newer.
481481

482482
```azurecli
483483
{
484-
"identity": {
484+
"identity": {
485485
"type": "UserAssigned",
486-
"userAssignedIdentities": {
487-
"/subscriptions/$SUB_ID/resourceGroups/$UAI_RESOURCE_GROUP/providers/Microsoft.ManagedIdentity/userAssignedIdentities/$UAI_NAME": null
488-
}
489-
}
486+
"userAssignedIdentities": {
487+
"/subscriptions/$SUB_ID/resourceGroups/$UAI_RESOURCE_GROUP/providers/Microsoft.ManagedIdentity/userAssignedIdentities/$UAI_NAME": null
488+
}
489+
}
490490
}
491491
```

0 commit comments

Comments
 (0)