Skip to content

Commit beb429d

Browse files
authored
Merge pull request #270265 from JAC0BSMITH/jac0bsmith_cli
Update SP expectations
2 parents c6f4df6 + cbdfb8b commit beb429d

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

articles/operator-nexus/howto-service-principal-rotation.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ description: Instructions on service principal rotation lifecycle management.
44
ms.service: azure-operator-nexus
55
ms.custom: template-how-to
66
ms.topic: how-to
7-
ms.date: 02/05/2024
7+
ms.date: 03/05/2024
88
author: sbatchu0108
99
ms.author: sbatchu
1010
---
1111

12-
# Service principal rotation on the target cluster
12+
# Service Principal rotation on the target Cluster
1313

14-
This document provides an overview on the process of performing service principal rotation on the target cluster.
14+
This document provides an overview on the process of performing Service Principal rotation on the target Nexus cluster.
15+
In alignment with security best practices, a Security Principal should be rotated periodically. Anytime the integrity of the Service Principal is suspected or known to be compromised, it should be rotated immediately.
1516

1617
## Prerequisites
1718

@@ -23,38 +24,38 @@ This document provides an overview on the process of performing service principa
2324
6. Service Principal rotation should be performed prior to the configured credentials expiring.
2425
7. Service Principal should have owner privilege on the subscription of the target cluster.
2526

26-
## Append secondary credential to the existing service principal
27+
## Append secondary credential to the existing Service Principal
2728

28-
List existing credentials info for the service principal
29+
List existing credentials info for the Service Principal
2930

3031
```azurecli
3132
az ad app credential list --id "<SP Application (client) ID>"
3233
```
3334

34-
Append secondary credential to the service principal. Please copy the resulting generated password somewhere safe.
35+
Append secondary credential to the Service Principal. Please copy the resulting generated password somewhere safe, following best practices.
3536

3637
```azurecli
3738
az ad app credential reset --id "<SP Application (client) ID>" --append --display-name "<human-readable description>"
3839
```
39-
## Create a new service principal
40+
## Create a new Service Principal
4041

41-
New service principal should have owner privilege scope on the target cluster subscription.
42+
New Service Principal should have owner privilege scope on the target Cluster subscription.
4243

4344
```azurecli
4445
az ad sp create-for-rbac -n "<service principal display name>" --role owner --scopes /subscriptions/<subscription-id>
4546
```
4647

47-
## Rotate service principal on the target cluster
48+
## Rotate Service Principal on the target Cluster
4849

49-
Service principal can be rotated on the target cluster by supplying the new information, which can either be only secondary credential update or it could be the new service principal for the target cluster.
50+
Service Principal can be rotated on the target Cluster by supplying the new information, which can either be only secondary credential update or it could be the new Service Principal for the target Cluster.
5051

5152
```azurecli
5253
az networkcloud cluster update --resource-group "<resourceGroupName>" --cluster-service-principal application-id="<sp app id>" password="<cleartext password>" principal-id="<sp id>" tenant-id="<tenant id>" -n <cluster name> --subscription <subscription-id>
5354
```
5455

55-
## Verify new service principal update on the target cluster
56+
## Verify new Service Principal update on the target Cluster
5657

57-
Cluster show will list the new service principal changes if its rotated on the target cluster.
58+
Cluster show will list the new Service Principal changes if its rotated on the target Cluster.
5859

5960
```azurecli
6061
az networkcloud cluster show --name "clusterName" --resource-group "resourceGroup"
@@ -71,9 +72,9 @@ In the output, you can find the details under `clusterServicePrincipal` property
7172
```
7273

7374
> [!NOTE]
74-
> Ensure you're using the correct service principal ID(object ID in Azure) when updating it. There are two different object IDs retrievable from Azure for the same Service Principal name, follow these steps to find the right one:
75+
> Ensure you're using the correct Service Principal ID(object ID in Azure) when updating it. There are two different object IDs retrievable from Azure for the same Service Principal name, follow these steps to find the right one:
7576
> 1. Avoid retrieving the object ID from the Service Principal of type application that appears when you search for service principal on the Azure portal search bar.
7677
> 2. Instead, Search for the service principal name under "Enterprise applications" in Azure Services to find the correct object ID and use it as principal ID.
7778
7879
If you still have questions, [contact support](https://portal.azure.com/?#blade/Microsoft_Azure_Support/HelpAndSupportBlade).
79-
For more information about Support plans, see [Azure Support plans](https://azure.microsoft.com/support/plans/response/).
80+
For more information about Support plans, see [Azure Support plans](https://azure.microsoft.com/support/plans/response/).

0 commit comments

Comments
 (0)