confluent cli description update (#8786)

* update the cli description to support ai related quiries

* updated the version in setup.py

* Update src/confluent/setup.py

as per the reviewer suggestion

Co-authored-by: AllyW <[email protected]>

* updated the version as per the pr comments

* updated test recordings for confluent

* fix linter and style issues in confluent

---------

Co-authored-by: Srinivas Alluri <[email protected]>
Co-authored-by: AllyW <[email protected]>

Author: 3 people

src/confluent/HISTORY.rst

@@ -2,6 +2,10 @@
 
 Release History
 ===============
+1.0.0
++++++
+* Updated CLI command descriptions to be more user and support az mcp commands.
+
 0.6.0
 +++++
 * Added more commands for user access management

src/confluent/azext_confluent/aaz/latest/confluent/organization/__cmd_group.py

@@ -15,7 +15,7 @@
     "confluent organization",
 )
 class __CMDGroup(AAZCommandGroup):
-    """Commands to perform actions on a confluent organization
+    """Perform administrative operations on Confluent organization entities via Azure.
     """
     pass
 

src/confluent/azext_confluent/aaz/latest/confluent/organization/__init__.py

@@ -14,6 +14,7 @@
 from ._create_user import *
 from ._delete import *
 from ._list import *
+from ._list_region import *
 from ._list_role_binding import *
 from ._list_service_accounts import *
 from ._list_users import *

src/confluent/azext_confluent/aaz/latest/confluent/organization/_create.py

@@ -15,7 +15,7 @@
     "confluent organization create",
 )
 class Create(AAZCommand):
-    """Create Organization resource
+    """Create a new Confluent organization entity through Azure integration.
     """
 
     _aaz_info = {
@@ -48,8 +48,6 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
         )
         _args_schema.resource_group = AAZResourceGroupNameArg(
-            options=["--resource-group"],
-            help="Resource Group Name",
             required=True,
         )
 
@@ -176,7 +174,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             help="Email address",
             required=True,
             fmt=AAZStrArgFormat(
-                pattern="^\S+@\S+\.\S+$",
+                pattern="^\\S+@\\S+\\.\\S+$",
             ),
         )
         user_detail.first_name = AAZStrArg(
@@ -401,6 +399,7 @@ def _build_schema_on_200_201(cls):
             )
             properties.provisioning_state = AAZStrType(
                 serialized_name="provisioningState",
+                flags={"read_only": True},
             )
             properties.sso_url = AAZStrType(
                 serialized_name="ssoUrl",

src/confluent/azext_confluent/aaz/latest/confluent/organization/_create_role_binding.py

@@ -15,7 +15,7 @@
     "confluent organization create-role-binding",
 )
 class CreateRoleBinding(AAZCommand):
-    """Organization role bindings
+    """Assign roles to users or groups within a Confluent organization.
     """
 
     _aaz_info = {
@@ -48,8 +48,6 @@ def _build_arguments_schema(cls, *args, **kwargs):
             id_part="name",
         )
         _args_schema.resource_group = AAZResourceGroupNameArg(
-            options=["--resource-group"],
-            help="Resource group name",
             required=True,
         )
 

src/confluent/azext_confluent/aaz/latest/confluent/organization/_create_user.py

@@ -15,7 +15,7 @@
     "confluent organization create-user",
 )
 class CreateUser(AAZCommand):
-    """Invite user to the organization
+    """Invite a new user to join the Confluent organization.
     """
 
     _aaz_info = {

src/confluent/azext_confluent/aaz/latest/confluent/organization/_delete.py

@@ -16,7 +16,7 @@
     confirmation="Are you sure you want to perform this operation?",
 )
 class Delete(AAZCommand):
-    """Delete Organization resource
+    """Delete an existing Confluent organization entity via Azure.
     """
 
     _aaz_info = {
@@ -50,8 +50,6 @@ def _build_arguments_schema(cls, *args, **kwargs):
             id_part="name",
         )
         _args_schema.resource_group = AAZResourceGroupNameArg(
-            options=["--resource-group"],
-            help="Resource Group Name",
             required=True,
         )
         return cls._args_schema

src/confluent/azext_confluent/aaz/latest/confluent/organization/_list.py

@@ -15,7 +15,7 @@
     "confluent organization list",
 )
 class List(AAZCommand):
-    """List all organizations under the specified subscription.
+    """List all Confluent organizations under the specified resource group or subscription.
     """
 
     _aaz_info = {
@@ -43,20 +43,17 @@ def _build_arguments_schema(cls, *args, **kwargs):
         # define Arg Group ""
 
         _args_schema = cls._args_schema
-        _args_schema.resource_group = AAZResourceGroupNameArg(
-            options=["--resource-group"],
-            help="Resource Group Name",
-        )
+        _args_schema.resource_group = AAZResourceGroupNameArg()
         return cls._args_schema
 
     def _execute_operations(self):
         self.pre_operations()
-        condition_0 = has_value(self.ctx.args.resource_group) and has_value(self.ctx.subscription_id)
-        condition_1 = has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
+        condition_0 = has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
+        condition_1 = has_value(self.ctx.args.resource_group) and has_value(self.ctx.subscription_id)
         if condition_0:
-            self.OrganizationListByResourceGroup(ctx=self.ctx)()
-        if condition_1:
             self.OrganizationListBySubscription(ctx=self.ctx)()
+        if condition_1:
+            self.OrganizationListByResourceGroup(ctx=self.ctx)()
         self.post_operations()
 
     @register_callback
@@ -72,7 +69,7 @@ def _output(self, *args, **kwargs):
         next_link = self.deserialize_output(self.ctx.vars.instance.next_link)
         return result, next_link
 
-    class OrganizationListByResourceGroup(AAZHttpOperation):
+    class OrganizationListBySubscription(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -86,7 +83,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations",
+                "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations",
                 **self.url_parameters
             )
 
@@ -101,10 +98,6 @@ def error_format(self):
         @property
         def url_parameters(self):
             parameters = {
-                **self.serialize_url_param(
-                    "resourceGroupName", self.ctx.args.resource_group,
-                    required=True,
-                ),
                 **self.serialize_url_param(
                     "subscriptionId", self.ctx.subscription_id,
                     required=True,
@@ -192,6 +185,7 @@ def _build_schema_on_200(cls):
             )
             properties.provisioning_state = AAZStrType(
                 serialized_name="provisioningState",
+                flags={"read_only": True},
             )
             properties.sso_url = AAZStrType(
                 serialized_name="ssoUrl",
@@ -279,7 +273,7 @@ def _build_schema_on_200(cls):
 
             return cls._schema_on_200
 
-    class OrganizationListBySubscription(AAZHttpOperation):
+    class OrganizationListByResourceGroup(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -293,7 +287,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations",
+                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations",
                 **self.url_parameters
             )
 
@@ -308,6 +302,10 @@ def error_format(self):
         @property
         def url_parameters(self):
             parameters = {
+                **self.serialize_url_param(
+                    "resourceGroupName", self.ctx.args.resource_group,
+                    required=True,
+                ),
                 **self.serialize_url_param(
                     "subscriptionId", self.ctx.subscription_id,
                     required=True,
@@ -395,6 +393,7 @@ def _build_schema_on_200(cls):
             )
             properties.provisioning_state = AAZStrType(
                 serialized_name="provisioningState",
+                flags={"read_only": True},
             )
             properties.sso_url = AAZStrType(
                 serialized_name="ssoUrl",