Skip to content

Commit bc72e29

Browse files
Merge pull request #300666 from eak13/main
Adding reference table that shows deprecating resource fields and their replacements
2 parents 9ce473e + d13aded commit bc72e29

File tree

1 file changed

+61
-2
lines changed

1 file changed

+61
-2
lines changed

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

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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 will 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 causes 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 will cause a brief disruption in sending metrics to the LAW as the extensions which use the LAW need to be reinstalled.
400+
> Changing the LAW settings causes 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" \
@@ -489,3 +489,62 @@ Note, `<APIVersion>` is the API version 2024-07-01 or newer.
489489
}
490490
}
491491
```
492+
493+
## Field deprecations and replacements
494+
495+
This section is a reference for the deprecated resource fields and their replacements. All fields are found on the Cluster resource except for the Cluster Manager managed identity used for the deprecated key vault method. This list also assumes that an associated managed identity is defined on the Cluster that corresponds with the managed identity for the resource.
496+
497+
`identity-resource-id` is only required when using a UAMI. It shouldn't be specified if using a SAMI for the resource.
498+
499+
### Storage Account
500+
501+
_**Deprecated Fields:**_ N/A
502+
503+
_**Replacing Fields:**_
504+
505+
```azurecli
506+
command-output-settings:
507+
container-url
508+
identity-type
509+
identity-resource-id
510+
```
511+
512+
_**Notes:**_ Deprecated Fields is N/A because the Cluster Manager storage account gets created automatically today and doesn't require user input.
513+
514+
### Key Vault
515+
516+
_**Deprecated Fields:**_
517+
518+
```azurecli
519+
cluster-secret-archive:
520+
use-key-vault
521+
key-vault-id
522+
```
523+
524+
Cluster Manager managed identity
525+
526+
_**Replacing Fields:**_
527+
528+
```azurecli
529+
secret-archive-settings:
530+
vault-uri
531+
identity-type
532+
identity-resource-id
533+
```
534+
535+
_**Notes:**_ `vault-uri` in `secret-archive-settings` is the URI for the Key Vault being specified versus the ARM resource ID that is specified for `key-vault-id`. The same managed identity that was specified for the Cluster Manager can be used on the Cluster.
536+
537+
### Log Analytics Workspace
538+
539+
_**Deprecated Fields:**_ `analytics-workspace-id`
540+
541+
_**Replacing Fields:**_
542+
543+
```azurecli
544+
analytics-output-settings:
545+
analytics-workspace-id
546+
identity-type
547+
identity-resource-id
548+
```
549+
550+
_**Notes:**_ The input format (LAW ARM resource ID) is the same between the deprecated `analytics-workspace-id` field and the `analytics-workspace-id` within `analytics-output-settings`.

0 commit comments

Comments
 (0)