Neon CLI Support for GA Features - Change Plan, Projects and Branches (#8679)

* added project cli commands for preview version

* added support for projects, branches and changeplan features

* updated examples in the read me

* added examples for the update branch and project

* updated the release history file

* update the branch parameters

* addressed comments and added scenario tests

* removed the update commands for Project and Branches

* fix integration test issue

* mask the test subscription in scenario tests

---------

Co-authored-by: Srinivas Alluri <sralluri@microsoft.com>

Author: alluri02

.github/copilot-instructions.md

@@ -0,0 +1 @@
+- @azure Rule - Use Azure Best Practices: When generating code for Azure, running terminal commands for Azure, or performing operations related to Azure, invoke your `azure_development-get_best_practices` tool if available.

src/neon/HISTORY.rst

@@ -9,4 +9,8 @@ Release History
 
 1.0.0b2
 ++++++
-* Updated command descriptions.
+* Updated command descriptions.
+
+1.0.0b3
+++++++
+* GA release of Neon CLI. Supports Change Plan, Project, Branches and Database Connection commands.

src/neon/README.md

@@ -1,55 +1,136 @@
-
 # Azure CLI Neon Extension #
+
 This is an extension to Azure CLI to manage Neon Postgres resources.
 
 ## How to use ##
-#### Install the extension ####
+
+### Install the extension ###
+
 Install this extension using the below CLI command:
 ```
 az extension add --name neon
 ```
 
-#### Check the version ####
+### Check the version ###
+
 ```
 az extension show --name neon --query version
 ```
 
-#### Connect to Azure subscription ####
+### Connect to Azure subscription ###
+
 ```
 az login
 az account set -s {subs_id}
 ```
 
-#### Create a resource group (or use an existing one) ####
+### Create a resource group (or use an existing one) ###
+
 ```
 az group create -n demoResourceGroup -l eastus
 ```
 
 ## Available Commands ##
 
-### Create a Neon Postgres Instance ###
+### Organization Commands ###
+
+#### Create a Neon Postgres Organization ####
+
 ```
-az neon postgres create --resource-group {resource_group} --name {resource_name} --user-details '{"first-name": "{user_first_name}", "last-name": "{user_last_name}", "email-address": "{user_email}", "upn": "{user_upn}", "phone-number": "{user_phone}"}' --company-details '{"company-name": "{company_name}", "office-address": "{office_address}", "country": "{country}", "domain": "{domain}", "number-of-employees": {number_of_employee}}' --partner-organization-properties '{"organization-id": "{org_id}", "org-name": "{partner_org_name}", "single-sign-on-properties": {"single-sign-on-state": "{sso_state}", "enterprise-app-id": "{app_id}", "single-sign-on-url": "{sso_url}", "aad-domains": ["{domain}"]}}' --tags "{key:value}" --location {location}
+az neon postgres organization create --resource-group {resource_group} --name {resource_name} --user-details '{{"first-name": "{user_first_name}", "last-name": "{user_last_name}", "email-address": "{user_email}", "upn": "{user_upn}", "phone-number": "{user_phone}"}}' --marketplace-details '{{"subscription-id": "{subscription_id}", "subscription-status": "{subscription_status}", "offer-details": {{"publisher-id": "{publisher_id}", "offer-id": "{offer_id}", "plan-id": "{plan_id}", "plan-name": "{plan_name}", "term-unit": "{term_unit}", "term-id": "{term_id}"}}}}' --company-details '{{"company-name": "{company_name}", "office-address": "{office_address}", "country": "{country}", "domain": "{domain}", "number-of-employees": {number_of_employee}}}' --partner-organization-properties '{{"organization-id": "{org_id}", "org-name": "{partner_org_name}", "single-sign-on-properties": {{"single-sign-on-state": "{sso_state}", "enterprise-app-id": "{app_id}", "single-sign-on-url": "{sso_url}", "aad-domains": ["{domain}"]}}}}' --tags "{key:value}" --location {location}
 ```
 
-### Show a Neon Postgres Organization ###
+#### Show a Neon Postgres Organization ####
+
 ```
 az neon postgres organization show --resource-group {resource_group} --name {resource_name}
 ```
 
-### Delete a Neon Postgres Organization ###
+#### Delete a Neon Postgres Organization ####
+
 ```
 az neon postgres organization delete --resource-group {resource_group} --name {resource_name}
 ```
 
-### List Neon resources by subscription ID ###
+#### List Neon Organizations by Subscription ####
+
 ```
 az neon postgres organization list --subscription {subscription_id} --resource-group {resource_group}
 ```
 
-### Update a Neon Postgres Organization (without location and marketplace details) ###
+#### Update a Neon Postgres Organization ####
+
+```
+az neon postgres organization create --resource-group {resource_group} --name {resource_name} --user-details '{{"first-name": "{user_first_name}", "last-name": "{user_last_name}", "email-address": "{user_email}", "upn": "{user_upn}", "phone-number": "{user_phone}"}}' --marketplace-details '{{"subscription-id": "{subscription_id}", "subscription-status": "{subscription_status}", "offer-details": {{"publisher-id": "{publisher_id}", "offer-id": "{offer_id}", "plan-id": "{plan_id}", "plan-name": "{plan_name}", "term-unit": "{term_unit}", "term-id": "{term_id}"}}}}' --company-details '{{"company-name": "{company_name}", "office-address": "{office_address}", "country": "{country}", "domain": "{domain}", "number-of-employees": {number_of_employee}}}' --partner-organization-properties '{{"organization-id": "{org_id}", "org-name": "{partner_org_name}", "single-sign-on-properties": {{"single-sign-on-state": "{sso_state}", "enterprise-app-id": "{app_id}", "single-sign-on-url": "{sso_url}", "aad-domains": ["{domain}"]}}}}' --tags "{key:value}" --location {location}
+```
+
+### Project Commands ###
+
+#### Create a Neon Postgres Project with in an Organization ####
+
+```
+az neon postgres project create --resource-group {resource_group} --organization-name {organization_name} --name {project_name} --region {region} --pg-version {pg_version} --branch '{{"branch-name": "{banch_name}", "database-name": "{database_name}", "role-name": "{reole_name}""}}'
+```
+
+#### Show a Neon Postgres Project in an Organization ####
+
+```
+az neon postgres project show --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id}
+```
+
+#### List Neon Postgres Projects under an Organization ####
+
+```
+az neon postgres project list --resource-group {resource_group} --organization-name {organization_name}
+```
+
+#### Delete a Neon Postgres Project in an Organization ####
+
+```
+az neon postgres project delete --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id}
+```
+
+### Branch Commands ###
+
+#### Create a Branch in a Neon Postgres Project ####
+
+```
+az neon postgres branch create --resource-group {resource_group} --organization-name {organization_name} --project-name {project_id} --project-id {project_id} --branch-name {branch_name} --role-name {role_name} --database-name {database_name}
+```
+
+#### Show a Branch in a Neon Postgres Project ####
+
+```
+az neon postgres branch show --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id} --branch-id {branch_id}
+```
+
+#### List Branches in a Neon Postgres Project ####
+
+```
+az neon postgres branch list --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id}
 ```
-az neon postgres organization update --resource-group {resource_group} --name {resource_name} --user-details '{"first-name": "{user_first_name}", "last-name": "{user_last_name}", "email-address": "{user_email}", "upn": "{user_upn}", "phone-number": "{user_phone}"}' --company-details '{"company-name": "{company_name}", "office-address": "{office_address}", "country": "{country}", "domain": "{domain}", "number-of-employees": {number_of_employee}}' --partner-organization-properties '{"organization-id": "{org_id}", "org-name": "{partner_org_name}", "single-sign-on-properties": {"single-sign-on-state": "{sso_state}", "enterprise-app-id": "{app_id}", "single-sign-on-url": "{sso_url}", "aad-domains": ["{domain}"]}}' --tags "{key:value}"
+
+#### Delete a Branch in a Neon Postgres Project ####
+
+```
+az neon postgres branch delete --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id} --branch-id {branch_id}
+```
+
+### Neon Database Commands ###
+
+#### List Databases in a Neon Postgres Branch ####
+
+```
+az neon postgres database list --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id} --branch-id {branch_id}
+```
+
+### Neon Role Commands ###
+
+#### List Roles in a Neon Postgres Branch ####
+
+```
+az neon postgres neon-role list --resource-group {resource_group} --organization-name {organization_name} --project-id {project_id} --branch-id {branch_id}
+
 ```
 
 If you have issues, please give feedback by opening an issue at https://github.com/Azure/azure-cli-extensions/issues.

src/neon/azext_neon/aaz/latest/neon/__cmd_group.py

@@ -13,7 +13,6 @@
 
 @register_command_group(
     "neon",
-    is_preview=True,
 )
 class __CMDGroup(AAZCommandGroup):
     """Manage Neon Postgres

src/neon/azext_neon/aaz/latest/neon/postgres/__cmd_group.py

@@ -13,7 +13,6 @@
 
 @register_command_group(
     "neon postgres",
-    is_preview=True,
 )
 class __CMDGroup(AAZCommandGroup):
     """Manage Neon Postgres

src/neon/azext_neon/aaz/latest/neon/postgres/_create.py

@@ -11,10 +11,6 @@
 from azure.cli.core.aaz import *
 
 
-@register_command(
-    "neon postgres create",
-    is_preview=True,
-)
 class Create(AAZCommand):
     """Create a Neon organization
 

src/neon/azext_neon/aaz/latest/neon/postgres/branch/__cmd_group.py

@@ -0,0 +1,23 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+#
+# Code generated by aaz-dev-tools
+# --------------------------------------------------------------------------------------------
+
+# pylint: skip-file
+# flake8: noqa
+
+from azure.cli.core.aaz import *
+
+
+@register_command_group(
+    "neon postgres branch",
+)
+class __CMDGroup(AAZCommandGroup):
+    """Manage Branch
+    """
+    pass
+
+
+__all__ = ["__CMDGroup"]

src/neon/azext_neon/aaz/latest/neon/postgres/branch/__init__.py

@@ -0,0 +1,17 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+#
+# Code generated by aaz-dev-tools
+# --------------------------------------------------------------------------------------------
+
+# pylint: skip-file
+# flake8: noqa
+
+from .__cmd_group import *
+from ._create import *
+from ._delete import *
+from ._list import *
+from ._show import *
+from ._update import *
+from ._wait import *