Skip to content

Commit 74bf22f

Browse files
authored
Merge pull request #293147 from MicrosoftDocs/repo_sync_working_branch
Confirm merge from repo_sync_working_branch to main to sync with https://github.com/MicrosoftDocs/azure-docs (branch main)
2 parents b4171a7 + aabe065 commit 74bf22f

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

articles/operator-nexus/howto-baremetal-bmc-ssh.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ ms.custom: template-how-to, devx-track-azurecli
1717
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure are exhausted. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Entra Group ID>`.
1818

1919
Users in a keyset are validated every four hours, and also when any changes are made to any keyset. Each user's status is then set to "Active" or "Invalid." Invalid users remain in the keyset but their keys are removed from all hosts and they aren't allowed access. Reasons for a user being invalid are:
20-
- The user's User Principal Name isn't a member of the given Entra group (if specified)
21-
- The given Entra group (if specified) doesn't exist (in which case all users in the keyset are invalid)
20+
- The user's User Principal Name hasn't been specified
21+
- The user's User Principal Name isn't a member of the given Entra group
22+
- The given Entra group doesn't exist (in which case all users in the keyset are invalid)
2223
- The keyset is expired (in which case all users in the keyset are invalid)
2324

2425
> [!NOTE]
25-
> There is currently a transitional period where specifying User Principal Names is optional. In a future release, it will become mandatory and Microsoft Entra ID validation will be enforced for all users. Users are encouraged to add User Principal Names to their keysets before the transitional period ends (planned for July 2024) to avoid keysets being invalidated. Note that if any User Principal Names are added to a keyset, even if they are not added for all users, Microsoft Entra ID validation will be enabled, and this will result in the entire keyset being invalidated if the Group ID specified is not valid.
26+
> The User Principal Name is now required for keysets as Microsoft Entra ID validation is enforced for all users. Current keysets that do not specify User Principal Names for all users will continue to work until the expiration date. If a keyset without User Principal Names expires, the keyset will need to be updated with User Principal Names, for all users, in order to become valid again. Keysets that have not been updated with the User Principal Names for all users prior to December 2024 are at-risk of being `Invalid`. Note that if any user fails to specify a User Principal Name this results in the entire keyset being invalidated.
2627
2728
The keyset and each individual user also have detailed status messages communicating other information:
2829
- The keyset's detailedStatusMessage tells you whether the keyset is expired, and other information about problems encountered while updating the keyset across the cluster.
@@ -101,7 +102,7 @@ az networkcloud cluster bmckeyset create \
101102
azure-user-name: Required. User name used to login to the server.
102103
description: The free-form description for this user.
103104
key-data: Required. The public ssh key of the user.
104-
userPrincipalName: Optional. The User Principal Name of the User.
105+
userPrincipalName: Required. The User Principal Name of the User.
105106
106107
Multiple users can be specified by using more than one --user-list argument.
107108
--tags : Space-separated tags: key[=value]
@@ -227,7 +228,7 @@ az networkcloud cluster bmckeyset update \
227228
azure-user-name: Required. User name used to login to the server.
228229
description: The free-form description for this user.
229230
key-data: Required. The public SSH key of the user.
230-
userPrincipalName: Optional. The User Principal Name of the User.
231+
userPrincipalName: Required. The User Principal Name of the User.
231232
232233
Multiple users can be specified by using more than one --user-list argument.
233234
--resource-group -g [Required] : Name of resource group. Optional if

articles/operator-nexus/howto-baremetal-bmm-ssh.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,19 @@ ms.custom: template-how-to, devx-track-azurecli
1212
# Manage emergency access to a bare metal machine using the `az networkcloud cluster baremetalmachinekeyset`
1313

1414
> [!CAUTION]
15-
> Please note this process is used in emergency situations when all other troubleshooting options using Azure have been exhausted. Any write or edit actions executed on the BMM node(s) will require users to ['reimage'](./howto-baremetal-functions.md) in order to restore Microsoft support to the impacted BMM node(s).
15+
> Please note this process is used in emergency situations when all other troubleshooting options using Azure have been exhausted. Any write or edit actions executed on the BMM node(s) will require users to ['reimage'](./howto-baremetal-functions.md) in order to restore Microsoft support to the impacted BMM node(s).
1616
Please note that SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1717

1818
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways via Azure are exhausted. Azure Operator Nexus provides the `az networkcloud cluster baremetalmachinekeyset` command so users can manage SSH access to these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Microsoft Entra Group ID `--azure-group-id <Entra Group ID>`.
1919

2020
Users in a keyset are validated every four hours, and also when any changes are made to any keyset. Each user's status is then set to "Active" or "Invalid." Invalid users remain in the keyset but their keys are removed from all hosts and they aren't allowed access. Reasons for a user being invalid are:
21-
- The user's User Principal Name isn't a member of the given Entra group (if specified)
22-
- The given Entra group (if specified) doesn't exist (in which case all users in the keyset are invalid)
21+
- The user's User Principal Name hasn't been specified
22+
- The user's User Principal Name isn't a member of the given Entra group
23+
- The given Entra group doesn't exist (in which case all users in the keyset are invalid)
2324
- The keyset is expired (in which case all users in the keyset are invalid)
2425

2526
> [!NOTE]
26-
> There is currently a transitional period where specifying User Principal Names is optional. In a future release, it will become mandatory and Microsoft Entra ID validation will be enforced for all users. Users are encouraged to add User Principal Names to their keysets before the transitional period ends (planned for July 2024) to avoid keysets being invalidated. Note that if any User Principal Names are added to a keyset, even if they are not added for all users, Microsoft Entra ID validation will be enabled, and this will result in the entire keyset being invalidated if the Group ID specified is not valid.
27+
>> The User Principal Name is now required for keysets as Microsoft Entra ID validation is enforced for all users. Current keysets that do not specify User Principal Names for all users will continue to work until the expiration date. If a keyset without User Principal Names expires, the keyset will need to be updated with User Principal Names, for all users, in order to become valid again. Keysets that have not been updated with the User Principal Names for all users prior to December 2024 are at-risk of being `Invalid`. Note that if any user fails to specify a User Principal Name this results in the entire keyset being invalidated.
2728
2829
The keyset and each individual user also have detailed status messages communicating other information:
2930
- The keyset's detailedStatusMessage tells you whether the keyset is expired, and other information about problems encountered while updating the keyset across the cluster.
@@ -117,7 +118,7 @@ az networkcloud cluster baremetalmachinekeyset create \
117118
azure-user-name: Required. User name used to login to the server.
118119
description: The free-form description for this user.
119120
key-data: Required. The public ssh key of the user.
120-
userPrincipalName: Optional. The User Principal Name of the User.
121+
userPrincipalName: Required. The User Principal Name of the User.
121122
122123
Multiple users can be specified by using more than one --user-list argument.
123124
--os-group-name : The name of the group that users are assigned
@@ -252,7 +253,7 @@ az networkcloud cluster baremetalmachinekeyset update \
252253
azure-user-name: Required. User name used to login to the server.
253254
description: The free-form description for this user.
254255
key-data: Required. The public SSH key of the user.
255-
userPrincipalName: Optional. The User Principal Name of the User.
256+
userPrincipalName: Required. The User Principal Name of the User.
256257
257258
Multiple users can be specified by using more than one --user-list argument.
258259
--resource-group -g [Required] : Name of cluster resource group. Optional if

0 commit comments

Comments
 (0)