Astronomer: Update CLI descriptions

src/astronomer/HISTORY.rst

@@ -3,6 +3,10 @@
 Release History
 ===============
 
+1.0.1
+++++++
+* Updated command descriptions.
+
 1.0.0
 ++++++
 * Initial release.

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/__cmd_group.py

@@ -15,7 +15,7 @@
     "astronomer organization",
 )
 class __CMDGroup(AAZCommandGroup):
-    """Manage Organization resources.
+    """Manage Azure resources that represent organizations in the Astronomer platform
     """
     pass
 

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_create.py

@@ -15,7 +15,7 @@
     "astronomer organization create",
 )
 class Create(AAZCommand):
-    """Create a OrganizationResource
+    """Create an Azure resource that provisions a corresponding organization entity in Astronomer
 
     :example: Create a OrganizationResource
         az astronomer organization create --resource-group MyResourceGroup --name MyAstronomerOrganization --location "eastus" --marketplace {"subscription-id":"ntthclydlpqmasr","offer-details":{"publisher-id":"gfsqxygpnerxmvols","offer-id":"krzkefmpxztqyusidzgpchfaswuyce","plan-id":"kndxzygsanuiqzwbfbbvoipv","plan-name":"pwqjwlq","term-unit":"xyygyzcazkuelz","term-id":"pwds"}} --partner-organization {"organization-name":"orgname","workspace-name":"workspacename","single-sign-on-properties":{"aad-domains":["kfbleh"]}} --user {"first-name":"nfh","last-name":"lazfbstcccykibvcrxpmglqam","email-address":"[email protected]"}
@@ -50,7 +50,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             help="Name of the Organizations resource",
             required=True,
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -134,7 +134,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             help="Organization name in partner's system",
             required=True,
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -151,7 +151,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             options=["workspace-name"],
             help="Workspace name in partner's system",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -185,7 +185,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             help="Email address of the user",
             required=True,
             fmt=AAZStrArgFormat(
-                pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$",
+                pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$",
             ),
         )
         user.first_name = AAZStrArg(
@@ -356,7 +356,7 @@ def content(self):
                 typ=AAZObjectType,
                 typ_kwargs={"flags": {"required": True, "client_flatten": True}}
             )
-            _builder.set_prop("identity", AAZObjectType, ".identity")
+            _builder.set_prop("identity", AAZIdentityObjectType, ".identity")
             _builder.set_prop("location", AAZStrType, ".location", typ_kwargs={"flags": {"required": True}})
             _builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
             _builder.set_prop("tags", AAZDictType, ".tags")
@@ -445,7 +445,7 @@ def _build_schema_on_200_201(cls):
             _schema_on_200_201.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _schema_on_200_201.identity = AAZObjectType()
+            _schema_on_200_201.identity = AAZIdentityObjectType()
             _schema_on_200_201.location = AAZStrType(
                 flags={"required": True},
             )

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_delete.py

@@ -16,7 +16,7 @@
     confirmation="Are you sure you want to perform this operation?",
 )
 class Delete(AAZCommand):
-    """Delete a OrganizationResource
+    """Delete the Azure resource linked to an organization entity in Astronomer
 
     :example: Delete a OrganizationResource
         az astronomer organization delete -g MyResourceGroup -n MyAstronomerOrganization
@@ -52,7 +52,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
             id_part="name",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_list.py

@@ -15,7 +15,7 @@
     "astronomer organization list",
 )
 class List(AAZCommand):
-    """List OrganizationResource resources by subscription ID
+    """List all Azure resources representing Astronomer organizations under the current subscription
 
     :example: ist OrganizationResource resources.
         az astronomer organization list -g MyResourceGroup
@@ -163,7 +163,7 @@ def _build_schema_on_200(cls):
             _element.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _element.identity = AAZObjectType()
+            _element.identity = AAZIdentityObjectType()
             _element.location = AAZStrType(
                 flags={"required": True},
             )
@@ -429,7 +429,7 @@ def _build_schema_on_200(cls):
             _element.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _element.identity = AAZObjectType()
+            _element.identity = AAZIdentityObjectType()
             _element.location = AAZStrType(
                 flags={"required": True},
             )

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_show.py

@@ -15,7 +15,7 @@
     "astronomer organization show",
 )
 class Show(AAZCommand):
-    """Get a OrganizationResource
+    """Retrieve details of the Azure resource associated with an Astronomer organization
 
     :example: Get a OrganizationResource
         az astronomer organization show -g MyResourceGroup -n MyAstronomerOrganization
@@ -50,7 +50,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
             id_part="name",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -161,7 +161,7 @@ def _build_schema_on_200(cls):
             _schema_on_200.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _schema_on_200.identity = AAZObjectType()
+            _schema_on_200.identity = AAZIdentityObjectType()
             _schema_on_200.location = AAZStrType(
                 flags={"required": True},
             )

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_update.py

@@ -15,7 +15,7 @@
     "astronomer organization update",
 )
 class Update(AAZCommand):
-    """Update a OrganizationResource
+    """Update the Azure resource configuration for an Astronomer organization
 
     :example: Update a OrganizationResource
         az astronomer organization update -g MyResourceGroup -n MyAstronomerOrganization --tags key1=value1
@@ -51,7 +51,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
             id_part="name",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -110,7 +110,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             options=["organization-name"],
             help="Organization name in partner's system",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -127,7 +127,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             options=["workspace-name"],
             help="Workspace name in partner's system",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -160,7 +160,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             options=["email-address"],
             help="Email address of the user",
             fmt=AAZStrArgFormat(
-                pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$",
+                pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$",
             ),
         )
         user.first_name = AAZStrArg(
@@ -290,7 +290,7 @@ def content(self):
                 typ=AAZObjectType,
                 typ_kwargs={"flags": {"required": True, "client_flatten": True}}
             )
-            _builder.set_prop("identity", AAZObjectType, ".identity")
+            _builder.set_prop("identity", AAZIdentityObjectType, ".identity")
             _builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
             _builder.set_prop("tags", AAZDictType, ".tags")
 
@@ -362,7 +362,7 @@ def _build_schema_on_200(cls):
             _schema_on_200.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _schema_on_200.identity = AAZObjectType()
+            _schema_on_200.identity = AAZIdentityObjectType()
             _schema_on_200.location = AAZStrType(
                 flags={"required": True},
             )

src/astronomer/azext_astronomer/aaz/latest/astronomer/organization/_wait.py

@@ -46,7 +46,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
             id_part="name",
             fmt=AAZStrArgFormat(
-                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
+                pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
                 max_length=50,
                 min_length=1,
             ),
@@ -157,7 +157,7 @@ def _build_schema_on_200(cls):
             _schema_on_200.id = AAZStrType(
                 flags={"read_only": True},
             )
-            _schema_on_200.identity = AAZObjectType()
+            _schema_on_200.identity = AAZIdentityObjectType()
             _schema_on_200.location = AAZStrType(
                 flags={"required": True},
             )

src/astronomer/azext_astronomer/azext_metadata.json

@@ -1,3 +1,3 @@
 {
-    "azext.minCliCoreVersion": "2.57.0"
+    "azext.minCliCoreVersion": "2.70.0"
 }

src/astronomer/setup.py

@@ -10,7 +10,7 @@
 
 
 # HISTORY.rst entry.
-VERSION = '1.0.0'
+VERSION = '1.0.1'
 
 # The full list of classifiers is available at
 # https://pypi.python.org/pypi?%3Aaction=list_classifiers