Neon GA PowerShell CLI Command lets #27669
Open
Conversation
This file contains hidden or 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
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
added 2 commits
May 6, 2025 15:50
… neon-ga-ps-cli-generator
…2/azure-powershell into neon-ga-ps-cli-generator
added 7 commits
May 12, 2025 09:57
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the Neon GA PowerShell CLI commands for general availability by adding example markdown files with placeholders, updating command documentation with new parameter details, and aligning API and module versions.
- Added new example and help documentation files (e.g. Get-AzNeonPostgresCompute.md, Get-AzNeonPostgresBranch.md) with placeholders for titles, code, and outputs.
- Updated command documentation for organization, project, branch, compute, endpoint, database, and role operations with new parameter additions and adjusted API versions in UX JSON and AssemblyInfo files.
Reviewed Changes
Copilot reviewed 74 out of 74 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/*.md | Added placeholder examples for various cmdlets. |
| docs/*.md | Updated command syntax and parameter lists; added new parameters. |
| UX/Neon.Postgres/*.json | Updated API version and refined command specifications. |
| README.md | Updated commit id and module version information. |
| Properties/AssemblyInfo.cs | Updated assembly version to align with GA release. |
Comment on lines
+1
to
+21
| ### Example 1: {{ Add title here }} | ||
| ```powershell | ||
| {{ Add code here }} | ||
| ``` | ||
|
|
||
| ```output | ||
| {{ Add output here (remove the output block if the example doesn't have an output) }} | ||
| ``` | ||
|
|
||
| {{ Add description here }} | ||
|
|
||
| ### Example 2: {{ Add title here }} | ||
| ```powershell | ||
| {{ Add code here }} | ||
| ``` | ||
|
|
||
| ```output | ||
| {{ Add output here (remove the output block if the example doesn't have an output) }} | ||
| ``` | ||
|
|
||
| {{ Add description here }} |
There was a problem hiding this comment.
[nitpick] Replace placeholder text (e.g. '{{ Add title here }}', '{{ Add code here }}') with actual sample titles and code once available to ensure the examples are meaningful to end users.
Suggested change
| ### Example 1: {{ Add title here }} | |
| ```powershell | |
| {{ Add code here }} | |
| ``` | |
| ```output | |
| {{ Add output here (remove the output block if the example doesn't have an output) }} | |
| ``` | |
| {{ Add description here }} | |
| ### Example 2: {{ Add title here }} | |
| ```powershell | |
| {{ Add code here }} | |
| ``` | |
| ```output | |
| {{ Add output here (remove the output block if the example doesn't have an output) }} | |
| ``` | |
| {{ Add description here }} | |
| ### Example 1: Retrieve Compute Details for a Specific Neon Postgres Instance | |
| ```powershell | |
| Get-AzNeonPostgresCompute -ResourceGroupName "MyResourceGroup" -ServerName "MyPostgresServer" |
{
"name": "MyPostgresServer",
"status": "Running",
"location": "East US",
"sku": {
"name": "GP_Gen5_4",
"tier": "GeneralPurpose",
"capacity": 4
}
}
This example retrieves the compute details of a specific Neon Postgres server, including its name, status, location, and SKU information.
Example 2: List All Neon Postgres Compute Resources in a Resource Group
Get-AzNeonPostgresCompute -ResourceGroupName "MyResourceGroup"[
{
"name": "PostgresServer1",
"status": "Running",
"location": "East US",
"sku": {
"name": "GP_Gen5_2",
"tier": "GeneralPurpose",
"capacity": 2
}
},
{
"name": "PostgresServer2",
"status": "Stopped",
"location": "West US",
"sku": {
"name": "GP_Gen5_4",
"tier": "GeneralPurpose",
"capacity": 4
}
}
]
This example lists all Neon Postgres compute resources in the specified resource group, displaying details such as name, status, location, and SKU for each server.
Copilot uses AI. Check for mistakes.
| [-MarketplaceDetailSubscriptionStatus <String>] [-OfferDetailOfferId <String>] [-OfferDetailPlanId <String>] | ||
| [-OfferDetailPlanName <String>] [-OfferDetailPublisherId <String>] [-OfferDetailTermId <String>] | ||
| [-OfferDetailTermUnit <String>] [-PartnerOrganizationPropertyOrganizationId <String>] | ||
| [-PartnerOrganizationPropertyOrganizationName <String>] [-ProjectProperty <IProjectPropertiesUpdate>] |
There was a problem hiding this comment.
[nitpick] Verify consistency of the 'ProjectProperty' type between Update and New command documentation (IProjectPropertiesUpdate vs IProjectProperties) to avoid confusion.
Suggested change
| [-PartnerOrganizationPropertyOrganizationName <String>] [-ProjectProperty <IProjectPropertiesUpdate>] | |
| [-PartnerOrganizationPropertyOrganizationName <String>] [-ProjectProperty <IProjectProperties>] |
Copilot uses AI. Check for mistakes.
| @@ -40,7 +40,7 @@ try-require: | |||
| - $(repo)/specification/liftrneon/resource-manager/readme.powershell.md | |||
|
|
|||
| # For new RP, the version is 0.1.0 | |||
| module-version: 0.1.0 | |||
| module-version: 1.0.0 | |||
There was a problem hiding this comment.
[nitpick] Ensure that the module version in the README aligns with the assembly version and overall release plan for consistency.
Suggested change
| module-version: 1.0.0 | |
| module-version: 2.3.4 |
Copilot uses AI. Check for mistakes.
Comment on lines
+14
to
+62
| ### [Get-AzNeonPostgresBranch](Get-AzNeonPostgresBranch.md) | ||
| Get a Branch | ||
|
|
||
| ### [Get-AzNeonPostgresCompute](Get-AzNeonPostgresCompute.md) | ||
| List Compute resources by Branch | ||
|
|
||
| ### [Get-AzNeonPostgresEndpoint](Get-AzNeonPostgresEndpoint.md) | ||
| List Endpoint resources by Branch | ||
|
|
||
| ### [Get-AzNeonPostgresNeonDatabase](Get-AzNeonPostgresNeonDatabase.md) | ||
| List NeonDatabase resources by Branch | ||
|
|
||
| ### [Get-AzNeonPostgresNeonRole](Get-AzNeonPostgresNeonRole.md) | ||
| List NeonRole resources by Branch | ||
|
|
||
| ### [Get-AzNeonPostgresOrganization](Get-AzNeonPostgresOrganization.md) | ||
| Get a OrganizationResource | ||
|
|
||
| ### [Get-AzNeonPostgresProject](Get-AzNeonPostgresProject.md) | ||
| Get a Project | ||
|
|
||
| ### [Get-AzNeonPostgresProjectConnectionUri](Get-AzNeonPostgresProjectConnectionUri.md) | ||
| Action to retrieve the connection URI for the Neon Database. | ||
|
|
||
| ### [New-AzNeonPostgresBranch](New-AzNeonPostgresBranch.md) | ||
| create a Branch | ||
|
|
||
| ### [New-AzNeonPostgresOrganization](New-AzNeonPostgresOrganization.md) | ||
| create a OrganizationResource | ||
|
|
||
| ### [New-AzNeonPostgresProject](New-AzNeonPostgresProject.md) | ||
| create a Project | ||
|
|
||
| ### [Remove-AzNeonPostgresBranch](Remove-AzNeonPostgresBranch.md) | ||
| Delete a Branch | ||
|
|
||
| ### [Remove-AzNeonPostgresOrganization](Remove-AzNeonPostgresOrganization.md) | ||
| Delete a OrganizationResource | ||
|
|
||
| ### [Remove-AzNeonPostgresProject](Remove-AzNeonPostgresProject.md) | ||
| Delete a Project | ||
|
|
||
| ### [Update-AzNeonPostgresBranch](Update-AzNeonPostgresBranch.md) | ||
| update a Branch | ||
|
|
||
| ### [Update-AzNeonPostgresOrganization](Update-AzNeonPostgresOrganization.md) | ||
| update a OrganizationResource | ||
|
|
||
| ### [Update-AzNeonPostgresProject](Update-AzNeonPostgresProject.md) |
There was a problem hiding this comment.
[nitpick] Confirm that the grouping and order of cmdlet listings follow the established naming and presentation standards for easier discoverability.
Suggested change
| ### [Get-AzNeonPostgresBranch](Get-AzNeonPostgresBranch.md) | |
| Get a Branch | |
| ### [Get-AzNeonPostgresCompute](Get-AzNeonPostgresCompute.md) | |
| List Compute resources by Branch | |
| ### [Get-AzNeonPostgresEndpoint](Get-AzNeonPostgresEndpoint.md) | |
| List Endpoint resources by Branch | |
| ### [Get-AzNeonPostgresNeonDatabase](Get-AzNeonPostgresNeonDatabase.md) | |
| List NeonDatabase resources by Branch | |
| ### [Get-AzNeonPostgresNeonRole](Get-AzNeonPostgresNeonRole.md) | |
| List NeonRole resources by Branch | |
| ### [Get-AzNeonPostgresOrganization](Get-AzNeonPostgresOrganization.md) | |
| Get a OrganizationResource | |
| ### [Get-AzNeonPostgresProject](Get-AzNeonPostgresProject.md) | |
| Get a Project | |
| ### [Get-AzNeonPostgresProjectConnectionUri](Get-AzNeonPostgresProjectConnectionUri.md) | |
| Action to retrieve the connection URI for the Neon Database. | |
| ### [New-AzNeonPostgresBranch](New-AzNeonPostgresBranch.md) | |
| create a Branch | |
| ### [New-AzNeonPostgresOrganization](New-AzNeonPostgresOrganization.md) | |
| create a OrganizationResource | |
| ### [New-AzNeonPostgresProject](New-AzNeonPostgresProject.md) | |
| create a Project | |
| ### [Remove-AzNeonPostgresBranch](Remove-AzNeonPostgresBranch.md) | |
| Delete a Branch | |
| ### [Remove-AzNeonPostgresOrganization](Remove-AzNeonPostgresOrganization.md) | |
| Delete a OrganizationResource | |
| ### [Remove-AzNeonPostgresProject](Remove-AzNeonPostgresProject.md) | |
| Delete a Project | |
| ### [Update-AzNeonPostgresBranch](Update-AzNeonPostgresBranch.md) | |
| update a Branch | |
| ### [Update-AzNeonPostgresOrganization](Update-AzNeonPostgresOrganization.md) | |
| update a OrganizationResource | |
| ### [Update-AzNeonPostgresProject](Update-AzNeonPostgresProject.md) | |
| ### Get Cmdlets | |
| #### [Get-AzNeonPostgresBranch](Get-AzNeonPostgresBranch.md) | |
| Get a Branch | |
| #### [Get-AzNeonPostgresCompute](Get-AzNeonPostgresCompute.md) | |
| List Compute resources by Branch | |
| #### [Get-AzNeonPostgresEndpoint](Get-AzNeonPostgresEndpoint.md) | |
| List Endpoint resources by Branch | |
| #### [Get-AzNeonPostgresNeonDatabase](Get-AzNeonPostgresNeonDatabase.md) | |
| List NeonDatabase resources by Branch | |
| #### [Get-AzNeonPostgresNeonRole](Get-AzNeonPostgresNeonRole.md) | |
| List NeonRole resources by Branch | |
| #### [Get-AzNeonPostgresOrganization](Get-AzNeonPostgresOrganization.md) | |
| Get a OrganizationResource | |
| #### [Get-AzNeonPostgresProject](Get-AzNeonPostgresProject.md) | |
| Get a Project | |
| #### [Get-AzNeonPostgresProjectConnectionUri](Get-AzNeonPostgresProjectConnectionUri.md) | |
| Action to retrieve the connection URI for the Neon Database. | |
| ### New Cmdlets | |
| #### [New-AzNeonPostgresBranch](New-AzNeonPostgresBranch.md) | |
| create a Branch | |
| #### [New-AzNeonPostgresOrganization](New-AzNeonPostgresOrganization.md) | |
| create a OrganizationResource | |
| #### [New-AzNeonPostgresProject](New-AzNeonPostgresProject.md) | |
| create a Project | |
| ### Remove Cmdlets | |
| #### [Remove-AzNeonPostgresBranch](Remove-AzNeonPostgresBranch.md) | |
| Delete a Branch | |
| #### [Remove-AzNeonPostgresOrganization](Remove-AzNeonPostgresOrganization.md) | |
| Delete a OrganizationResource | |
| #### [Remove-AzNeonPostgresProject](Remove-AzNeonPostgresProject.md) | |
| Delete a Project | |
| ### Update Cmdlets | |
| #### [Update-AzNeonPostgresBranch](Update-AzNeonPostgresBranch.md) | |
| update a Branch | |
| #### [Update-AzNeonPostgresOrganization](Update-AzNeonPostgresOrganization.md) | |
| update a OrganizationResource | |
| #### [Update-AzNeonPostgresProject](Update-AzNeonPostgresProject.md) |
Copilot uses AI. Check for mistakes.
wyunchi-ms
reviewed
May 13, 2025
| {{ Add code here }} | ||
| ``` | ||
|
|
||
| ```output |
There was a problem hiding this comment.
Please fill the examples
added 2 commits
May 13, 2025 09:30
… neon-ga-ps-cli-generator
… neon-ga-ps-cli-generator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
The reported issues for the md files |
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
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.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.