Update descriptions for identity source parameters#128293
Update descriptions for identity source parameters#128293et1975 wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
Clarify the GroupName role/optionality when adding an external source.
|
@et1975 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit fc26b00: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
This PR clarifies the documentation for identity source parameters in vCenter configuration, specifically updating the GroupName field descriptions to indicate it is optional and can be configured separately after the source is added.
Changes:
- Updated
GroupNamedescription in the LDAP with SSL section to indicate it's optional and reference theAdd-GroupToCloudAdminscmdlet - Updated
GroupNamedescription in the LDAP (non-SSL) section to indicate it's optional with a note that it can be done separately
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **BaseDNGroups** | The location to search for groups. For example, **CN=group1, DC=avslab,DC=local**. Base DN is required for LDAP authentication. | | ||
| | **Credential** | The domain username and password for authentication with the Windows Server Active Directory source (not CloudAdmin). The user must be in the `<username@avslab.local>` format. | | ||
| | **GroupName** | The group in your external identity source that grants CloudAdmin access. For example, **avs-admins**. | | ||
| | **GroupName** | Optional. The group in your external identity that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. Can be done separately later. | |
There was a problem hiding this comment.
The phrase "Can be done separately later." is vague. For consistency with line 117, consider referencing the Add-GroupToCloudAdmins cmdlet explicitly, e.g., "This can be done separately later via Add-GroupToCloudAdmins."
| | **GroupName** | Optional. The group in your external identity that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. Can be done separately later. | | |
| | **GroupName** | Optional. The group in your external identity that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. This can be done separately later via `Add-GroupToCloudAdmins`. | |
| | **BaseDNGroups** | The location to search for groups. For example, **CN=group1, DC=avslab,DC=local**. Base DN is required for LDAP authentication. | | ||
| | **Credential** | The domain username and password for authentication with the Windows Server Active Directory source (not CloudAdmin). The user must be in the `<username@avslab.local>` format. | | ||
| | **GroupName** | The group in your external identity source that grants CloudAdmin access. For example, **avs-admins**. | | ||
| | **GroupName** | Optional. The group in your external identity that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. Can be done separately later. | |
There was a problem hiding this comment.
The phrase 'external identity' appears to be missing the word 'source' — should read 'external identity source' to match the terminology used throughout the document and on line 117.
| | **GroupName** | Optional. The group in your external identity that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. Can be done separately later. | | |
| | **GroupName** | Optional. The group in your external identity source that will be granted CloudAdmin membership upon addition of the source. For example, **avs-admins**. Can be done separately later. | |
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
Clarify the GroupName role/optionality when adding an external source.