Skip to content

Neon GA PowerShell CLI Command lets #27669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
5fff3b2
updated the commitId and version
Apr 25, 2025
f7538d5
updated module version and removed unused operations
Apr 25, 2025
67cb690
updated the ReadMe.md
Apr 25, 2025
ce1e95f
added neon postgres project, branches, databases commands
Apr 28, 2025
a00e89a
Merge branch 'Azure:main' into neon-ga-ps-cli-generator
alluri02 Apr 29, 2025
21472af
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 6, 2025
31bba14
Merge branch 'neon-ga-ps-cli-generator' of https://github.com/alluri0…
May 6, 2025
3b0a0a0
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 12, 2025
6a041dc
update a new commit id and updated the commands
May 12, 2025
ed0c260
updated the change log
May 12, 2025
c4b35b4
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 12, 2025
eaf33de
merge from main
May 12, 2025
db91550
updated the tests
May 12, 2025
a59d8c2
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 12, 2025
9690b28
updated the tests
May 12, 2025
56b82b1
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 13, 2025
d62e6a6
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
May 16, 2025
9b85177
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
Jun 9, 2025
74e1f6c
updated the tests and commands
Jun 9, 2025
5104542
updated the help docs with sample commands and examples
Jun 9, 2025
ef45cf3
updated the docs with proper description , commands and examples
Jun 9, 2025
4ecbee2
updated the examples
Jun 9, 2025
d2590ec
updated the branch description in all files
Jun 9, 2025
3d24333
removed update project command as it is not in scope
Jun 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/NeonPostgres/NeonPostgres.Autorest/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
// is regenerated.

using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - NeonPostgres")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.1")]
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.1")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]

12 changes: 10 additions & 2 deletions src/NeonPostgres/NeonPostgres.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For information on how to develop for `Az.NeonPostgres`, see [how-to.md](how-to.

```yaml
# pin the swagger version by using the commit id instead of branch name
commit: 75fdb87b5367a3ab306e85fb6daa7501d54f0553
commit: fb9d32d1bddf171eb777b33ff7fb7dd30a8771da
require:
# readme.azure.noprofile.md is the common configuration file
- $(this-folder)/../../readme.azure.noprofile.md
Expand All @@ -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
Copy link
Preview

Copilot AI May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

# Normally, title is the service name
title: NeonPostgres
subject-prefix: $(service-name)
Expand Down Expand Up @@ -70,4 +70,12 @@ directive:
- where:
verb: Set
remove: true
- remove-operation:
- Organizations_GetPostgresVersions
- Projects_Update
- Branches_Update
- Compute_Get
- Endpoint_Get
- NeonRole_Get
- NeonDatabase_Get
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"resourceType": "organizations/projects/branches",
"apiVersion": "2025-03-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres"
},
"commands": [
{
"name": "Get-AzNeonPostgresBranch",
"description": "Get a Branch",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres/get-azneonpostgresbranch"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-OrganizationName <String>",
"-ProjectName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Get a Branch",
"parameters": [
{
"name": "-Name",
"value": "[Path.branchName]"
},
{
"name": "-OrganizationName",
"value": "[Path.organizationName]"
},
{
"name": "-ProjectName",
"value": "[Path.projectName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzNeonPostgresBranch",
"description": "Delete a Branch",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres/remove-azneonpostgresbranch"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-OrganizationName <String>",
"-ProjectName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Delete a Branch",
"parameters": [
{
"name": "-Name",
"value": "[Path.branchName]"
},
{
"name": "-OrganizationName",
"value": "[Path.organizationName]"
},
{
"name": "-ProjectName",
"value": "[Path.projectName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"resourceType": "organizations/projects",
"apiVersion": "2025-03-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres"
},
"commands": [
{
"name": "Get-AzNeonPostgresProject",
"description": "Get a Project",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres/get-azneonpostgresproject"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-OrganizationName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Get a Project",
"parameters": [
{
"name": "-Name",
"value": "[Path.projectName]"
},
{
"name": "-OrganizationName",
"value": "[Path.organizationName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzNeonPostgresProject",
"description": "Delete a Project",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres/remove-azneonpostgresproject"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-OrganizationName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Delete a Project",
"parameters": [
{
"name": "-Name",
"value": "[Path.projectName]"
},
{
"name": "-OrganizationName",
"value": "[Path.organizationName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "organizations",
"apiVersion": "2024-08-01-preview",
"apiVersion": "2025-03-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.neonpostgres"
},
Expand Down
41 changes: 40 additions & 1 deletion src/NeonPostgres/NeonPostgres.Autorest/docs/Az.NeonPostgres.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Module Name: Az.NeonPostgres
Module Guid: b3e01e02-1629-4884-8793-ec1494a14142
Module Guid: d4e816d0-a83b-498b-8354-4bae7cfba1e6
Download Help Link: https://learn.microsoft.com/powershell/module/az.neonpostgres
Help Version: 1.0.0.0
Locale: en-US
Expand All @@ -11,15 +11,54 @@ Locale: en-US
Microsoft Azure PowerShell: NeonPostgres cmdlets

## Az.NeonPostgres 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-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)
Copy link
Preview

Copilot AI May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

update a Project

Loading