Updated new powershell commandlets for Multisite #3815
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Learn Build status updates of commit faf6a8e:
|
sdwheeler
requested changes
May 16, 2024
There was a problem hiding this comment.
This PR needs a lot of work.
- Please fix the style and formatting issues I identified.
- Add missing descriptions and examples.
- Fix all build warnings and errors.
- For signoff - see https://review.learn.microsoft.com/en-us/office-authoring-guide/quick-start/pubops-publishing-process?bc=%2Foffice-authoring-guide%2Fbreadcrumb%2Ftoc.json&toc=%2Foffice-authoring-guide%2Ftoc.json&branch=main&tabs=standard#merge-and-publish-your-content
Comment on lines
+11
to
+31
| {{ Fill in the Synopsis }} | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-NetworkControllerLearnedIpAddress [[-ResourceId] <String[]>] -ConnectionUri <Uri> | ||
| [-CertificateThumbprint <String>] [-Credential <PSCredential>] [-PassInnerException] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| {{ Fill in the Description }} | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
| ```powershell | ||
| PS C:\> {{ Add example code here }} | ||
| ``` | ||
|
|
||
| {{ Add example description here }} | ||
|
|
There was a problem hiding this comment.
Fill in missing information for all cmdlets.
There was a problem hiding this comment.
Let me remove these files from my pull request. Realizing now that I didn't mean to pull those in. I don't handle those features, so I'll defer content to the appropriate owners.
Comment on lines
+21
to
+22
| The Get-NetworkControllerMultisiteConfiguration cmdlet gets current Multisite settings. Use this cmdlet to obtain site details, site names and encryption details. | ||
| This cmdlet can also be used as a sanity check for the state of a deployment, whether it is in an initiated state, failed state, successful state, etc. |
There was a problem hiding this comment.
- Insert blank lines between Markdown block elements
- Limit lines to 100 characters
- Put cmdlet names in backticks
- Don't use latin terms like etc. - the list of states is not needed at the front of the document. It should be documented in an example or in the NOTES section.
Suggested change
| The Get-NetworkControllerMultisiteConfiguration cmdlet gets current Multisite settings. Use this cmdlet to obtain site details, site names and encryption details. | |
| This cmdlet can also be used as a sanity check for the state of a deployment, whether it is in an initiated state, failed state, successful state, etc. | |
| The `Get-NetworkControllerMultisiteConfiguration` cmdlet gets current Multisite settings. Use this | |
| cmdlet to obtain site details, site names and encryption details. This cmdlet can also be used as a | |
| sanity check for the state of a deployment. |
See the following resources for style and formatting rules:
|
|
||
| ### Example 1: Check Peering State | ||
| ```powershell | ||
| PS C:\> Get-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site1.com" | ConvertTo-JSON -depth 100 |
There was a problem hiding this comment.
- Limit code lines to 96 characters - use PowerShell natural line breaks to split code across lines
- Don't include the PowerShell prompt in examples unless the example is referencing the prompt
- Don't use quotes when not needed
- Use single-quotes for strings that don't require expansion
- Only use double-quotes for string that contain wildcards or expandable expressions
Suggested change
| PS C:\> Get-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site1.com" | ConvertTo-JSON -depth 100 | |
| Get-NetworkControllerMultisiteConfiguration -ConnectionUri https://site1.com | | |
| ConvertTo-JSON -depth 100 |
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Check Peering State |
There was a problem hiding this comment.
- Insert blank lines between Markdown block elements
Suggested change
| ### Example 1: Check Peering State | |
| ### Example 1: Check Peering State | |
Comment on lines
+34
to
+36
| ### -CertificateThumbprint | ||
| Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. | ||
| Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster. |
There was a problem hiding this comment.
- Insert blank lines between Markdown block elements throughout all articles.
- Reflow lines to break at 100 characters - Use the Reflow Markdown extension in VS Code to reflow paragraphs to fit the prescribed line length.
|
|
||
| ### System.Object | ||
|
|
||
| ### System.Object#https://localhost/ |
There was a problem hiding this comment.
What is the URL here for? This looks like a duplicate line that needs to be removed.
Suggested change
| ### System.Object#https://localhost/ |
| ``` | ||
|
|
||
| ### -PassInnerException | ||
| This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user. |
There was a problem hiding this comment.
- Bold for parameter names
- backtick for cmdlets
- 100-char line wrap
Suggested change
| This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user. | |
| This thumbprint must also be provided in the **ClientCertificateThumbprint** parameter in the | |
| `Install-NetworkController` or `Set-NetworkController` cmdlet so that Network Controller can | |
| authorize this user. |
| --- | ||
| external help file: Microsoft.NetworkController.Powershell.dll-help.xml | ||
| Module Name: NetworkController | ||
| online version: |
There was a problem hiding this comment.
The online version: metadata should be the URL that links to the published webpage. Note the pattern and fix this for all cmdlets.
Suggested change
| online version: | |
| online version: https://learn.microsoft.com/powershell/module/networkcontroller/get-networkcontrollerlearnedipaddress?view=windowsserver2025-ps |
Comment on lines
+174
to
+186
| Specifies a site configuration for Multisite Peering. Site configuration comes as a NetworkControllerMultisiteProperties object. This object can be defined as new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties. Here are the following properties that can be changed: | ||
| - CertificateSubjectName | ||
| - [[Sites] \<NetworkControllerSite\>] | ||
| - ResourceID/RESTIPAddress | ||
| - IsPrimary | ||
| - State | ||
| - DeploymentID | ||
| - APIVersion | ||
| - ConfigurationState | ||
| - [[Properties] \<NetworkControllerSiteProperties\>] | ||
| - RestIPAddress | ||
| - CertificateSubjectName | ||
| - EncodedCertificate |
There was a problem hiding this comment.
Most of this information belongs in an example.
Suggested change
| Specifies a site configuration for Multisite Peering. Site configuration comes as a NetworkControllerMultisiteProperties object. This object can be defined as new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties. Here are the following properties that can be changed: | |
| - CertificateSubjectName | |
| - [[Sites] \<NetworkControllerSite\>] | |
| - ResourceID/RESTIPAddress | |
| - IsPrimary | |
| - State | |
| - DeploymentID | |
| - APIVersion | |
| - ConfigurationState | |
| - [[Properties] \<NetworkControllerSiteProperties\>] | |
| - RestIPAddress | |
| - CertificateSubjectName | |
| - EncodedCertificate | |
| Specifies a site configuration for Multisite Peering. This parameter expects a | |
| **NetworkControllerMultisiteProperties** object. Create a **NetworkControllerMultisiteProperties** | |
| object containing the property values you want to set. |
Talk about the settable properties in the example.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
PR Checklist