Skip to content

Commit 291f1cc

Browse files
NidhiMalpaniNidhi Malpani
NidhiMalpani
and
Nidhi Malpani
authored
Astronomer: Update CLI descriptions (#8767)
* Update CLI descriptions * Update version * Fix version sequence --------- Co-authored-by: Nidhi Malpani <[email protected]>
1 parent 8a45f6d commit 291f1cc

File tree

10 files changed

+31
-27
lines changed

10 files changed

+31
-27
lines changed

‎src/astronomer/HISTORY.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Release History
44
===============
55

6+
1.0.1
7+
++++++
8+
* Updated command descriptions.
9+
610
1.0.0
711
++++++
812
* Initial release.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"astronomer organization",
1616
)
1717
class __CMDGroup(AAZCommandGroup):
18-
"""Manage Organization resources.
18+
"""Manage Azure resources that represent organizations in the Astronomer platform
1919
"""
2020
pass
2121

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"astronomer organization create",
1616
)
1717
class Create(AAZCommand):
18-
"""Create a OrganizationResource
18+
"""Create an Azure resource that provisions a corresponding organization entity in Astronomer
1919
2020
:example: Create a OrganizationResource
2121
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):
5050
help="Name of the Organizations resource",
5151
required=True,
5252
fmt=AAZStrArgFormat(
53-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
53+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
5454
max_length=50,
5555
min_length=1,
5656
),
@@ -134,7 +134,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
134134
help="Organization name in partner's system",
135135
required=True,
136136
fmt=AAZStrArgFormat(
137-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
137+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
138138
max_length=50,
139139
min_length=1,
140140
),
@@ -151,7 +151,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
151151
options=["workspace-name"],
152152
help="Workspace name in partner's system",
153153
fmt=AAZStrArgFormat(
154-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
154+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
155155
max_length=50,
156156
min_length=1,
157157
),
@@ -185,7 +185,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
185185
help="Email address of the user",
186186
required=True,
187187
fmt=AAZStrArgFormat(
188-
pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$",
188+
pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$",
189189
),
190190
)
191191
user.first_name = AAZStrArg(
@@ -356,7 +356,7 @@ def content(self):
356356
typ=AAZObjectType,
357357
typ_kwargs={"flags": {"required": True, "client_flatten": True}}
358358
)
359-
_builder.set_prop("identity", AAZObjectType, ".identity")
359+
_builder.set_prop("identity", AAZIdentityObjectType, ".identity")
360360
_builder.set_prop("location", AAZStrType, ".location", typ_kwargs={"flags": {"required": True}})
361361
_builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
362362
_builder.set_prop("tags", AAZDictType, ".tags")
@@ -445,7 +445,7 @@ def _build_schema_on_200_201(cls):
445445
_schema_on_200_201.id = AAZStrType(
446446
flags={"read_only": True},
447447
)
448-
_schema_on_200_201.identity = AAZObjectType()
448+
_schema_on_200_201.identity = AAZIdentityObjectType()
449449
_schema_on_200_201.location = AAZStrType(
450450
flags={"required": True},
451451
)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
confirmation="Are you sure you want to perform this operation?",
1717
)
1818
class Delete(AAZCommand):
19-
"""Delete a OrganizationResource
19+
"""Delete the Azure resource linked to an organization entity in Astronomer
2020
2121
:example: Delete a OrganizationResource
2222
az astronomer organization delete -g MyResourceGroup -n MyAstronomerOrganization
@@ -52,7 +52,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
5252
required=True,
5353
id_part="name",
5454
fmt=AAZStrArgFormat(
55-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
55+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
5656
max_length=50,
5757
min_length=1,
5858
),

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"astronomer organization list",
1616
)
1717
class List(AAZCommand):
18-
"""List OrganizationResource resources by subscription ID
18+
"""List all Azure resources representing Astronomer organizations under the current subscription
1919
2020
:example: ist OrganizationResource resources.
2121
az astronomer organization list -g MyResourceGroup
@@ -163,7 +163,7 @@ def _build_schema_on_200(cls):
163163
_element.id = AAZStrType(
164164
flags={"read_only": True},
165165
)
166-
_element.identity = AAZObjectType()
166+
_element.identity = AAZIdentityObjectType()
167167
_element.location = AAZStrType(
168168
flags={"required": True},
169169
)
@@ -429,7 +429,7 @@ def _build_schema_on_200(cls):
429429
_element.id = AAZStrType(
430430
flags={"read_only": True},
431431
)
432-
_element.identity = AAZObjectType()
432+
_element.identity = AAZIdentityObjectType()
433433
_element.location = AAZStrType(
434434
flags={"required": True},
435435
)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"astronomer organization show",
1616
)
1717
class Show(AAZCommand):
18-
"""Get a OrganizationResource
18+
"""Retrieve details of the Azure resource associated with an Astronomer organization
1919
2020
:example: Get a OrganizationResource
2121
az astronomer organization show -g MyResourceGroup -n MyAstronomerOrganization
@@ -50,7 +50,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
5050
required=True,
5151
id_part="name",
5252
fmt=AAZStrArgFormat(
53-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
53+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
5454
max_length=50,
5555
min_length=1,
5656
),
@@ -161,7 +161,7 @@ def _build_schema_on_200(cls):
161161
_schema_on_200.id = AAZStrType(
162162
flags={"read_only": True},
163163
)
164-
_schema_on_200.identity = AAZObjectType()
164+
_schema_on_200.identity = AAZIdentityObjectType()
165165
_schema_on_200.location = AAZStrType(
166166
flags={"required": True},
167167
)

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"astronomer organization update",
1616
)
1717
class Update(AAZCommand):
18-
"""Update a OrganizationResource
18+
"""Update the Azure resource configuration for an Astronomer organization
1919
2020
:example: Update a OrganizationResource
2121
az astronomer organization update -g MyResourceGroup -n MyAstronomerOrganization --tags key1=value1
@@ -51,7 +51,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
5151
required=True,
5252
id_part="name",
5353
fmt=AAZStrArgFormat(
54-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
54+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
5555
max_length=50,
5656
min_length=1,
5757
),
@@ -110,7 +110,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
110110
options=["organization-name"],
111111
help="Organization name in partner's system",
112112
fmt=AAZStrArgFormat(
113-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
113+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
114114
max_length=50,
115115
min_length=1,
116116
),
@@ -127,7 +127,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
127127
options=["workspace-name"],
128128
help="Workspace name in partner's system",
129129
fmt=AAZStrArgFormat(
130-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
130+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
131131
max_length=50,
132132
min_length=1,
133133
),
@@ -160,7 +160,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
160160
options=["email-address"],
161161
help="Email address of the user",
162162
fmt=AAZStrArgFormat(
163-
pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$",
163+
pattern="^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$",
164164
),
165165
)
166166
user.first_name = AAZStrArg(
@@ -290,7 +290,7 @@ def content(self):
290290
typ=AAZObjectType,
291291
typ_kwargs={"flags": {"required": True, "client_flatten": True}}
292292
)
293-
_builder.set_prop("identity", AAZObjectType, ".identity")
293+
_builder.set_prop("identity", AAZIdentityObjectType, ".identity")
294294
_builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
295295
_builder.set_prop("tags", AAZDictType, ".tags")
296296

@@ -362,7 +362,7 @@ def _build_schema_on_200(cls):
362362
_schema_on_200.id = AAZStrType(
363363
flags={"read_only": True},
364364
)
365-
_schema_on_200.identity = AAZObjectType()
365+
_schema_on_200.identity = AAZIdentityObjectType()
366366
_schema_on_200.location = AAZStrType(
367367
flags={"required": True},
368368
)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
4646
required=True,
4747
id_part="name",
4848
fmt=AAZStrArgFormat(
49-
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$",
49+
pattern="^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$",
5050
max_length=50,
5151
min_length=1,
5252
),
@@ -157,7 +157,7 @@ def _build_schema_on_200(cls):
157157
_schema_on_200.id = AAZStrType(
158158
flags={"read_only": True},
159159
)
160-
_schema_on_200.identity = AAZObjectType()
160+
_schema_on_200.identity = AAZIdentityObjectType()
161161
_schema_on_200.location = AAZStrType(
162162
flags={"required": True},
163163
)

‎src/astronomer/azext_astronomer/azext_metadata.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"azext.minCliCoreVersion": "2.57.0"
2+
"azext.minCliCoreVersion": "2.70.0"
33
}

‎src/astronomer/setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111

1212
# HISTORY.rst entry.
13-
VERSION = '1.0.0'
13+
VERSION = '1.0.1'
1414

1515
# The full list of classifiers is available at
1616
# https://pypi.python.org/pypi?%3Aaction=list_classifiers

0 commit comments

Comments
 (0)