Skip to content

Commit 24b3e35

Browse files
RyanLettieriRyanLettieri
authored
Durabletask shorthand fixes and readme fixes (#8414)
* removing extra hyphen in some command examples Signed-off-by: Ryan Lettieri <[email protected]> * Adding short hand annotations for CLI args Signed-off-by: Ryan Lettieri <[email protected]> * Changing default string for resources to be --name Signed-off-by: Ryan Lettieri <[email protected]> --------- Signed-off-by: Ryan Lettieri <[email protected]>
1 parent d098679 commit 24b3e35

File tree

12 files changed

+46
-46
lines changed

12 files changed

+46
-46
lines changed

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_create.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
class Create(AAZCommand):
1818
"""Create a Scheduler
1919
20-
:example: Create a scheduler in northcentralus
21-
az durable-task scheduler create --resource-group testrg --scheduler-name testscheduler --location northcentralus --ip-allowlist "[0.0.0.0/0]" --sku-capacity "1", --sku-name "Dedicated" --tags "{}"
20+
:example: Create a scheduler in eastus
21+
az durabletask scheduler create --resource-group testrg --name testscheduler --location eastus --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1, --sku-name "Dedicated" --tags "{}"
2222
"""
2323

2424
_aaz_info = {
@@ -48,8 +48,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
4848
_args_schema.resource_group = AAZResourceGroupNameArg(
4949
required=True,
5050
)
51-
_args_schema.scheduler_name = AAZStrArg(
52-
options=["-n", "--name", "--scheduler-name"],
51+
_args_schema.name = AAZStrArg(
52+
options=["-n", "--name"],
5353
help="The name of the Scheduler",
5454
required=True,
5555
fmt=AAZStrArgFormat(
@@ -171,7 +171,7 @@ def url_parameters(self):
171171
required=True,
172172
),
173173
**self.serialize_url_param(
174-
"schedulerName", self.ctx.args.scheduler_name,
174+
"schedulerName", self.ctx.args.name,
175175
required=True,
176176
),
177177
**self.serialize_url_param(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_delete.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Delete(AAZCommand):
1919
"""Delete a Scheduler
2020
2121
:example: Delete a scheduler
22-
az durable-task scheduler delete --resource-group testrg --scheduler-name testscheduler
22+
az durabletask scheduler delete --resource-group testrg --name testscheduler
2323
"""
2424

2525
_aaz_info = {
@@ -49,8 +49,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
4949
_args_schema.resource_group = AAZResourceGroupNameArg(
5050
required=True,
5151
)
52-
_args_schema.scheduler_name = AAZStrArg(
53-
options=["-n", "--name", "--scheduler-name"],
52+
_args_schema.name = AAZStrArg(
53+
options=["-n", "--name"],
5454
help="The name of the Scheduler",
5555
required=True,
5656
id_part="name",
@@ -132,7 +132,7 @@ def url_parameters(self):
132132
required=True,
133133
),
134134
**self.serialize_url_param(
135-
"schedulerName", self.ctx.args.scheduler_name,
135+
"schedulerName", self.ctx.args.name,
136136
required=True,
137137
),
138138
**self.serialize_url_param(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_list.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class List(AAZCommand):
1818
"""List Schedulers by subscription
1919
2020
:example: List all schedulers in a resource group
21-
az durable-task scheduler list -g testrg
21+
az durabletask scheduler list -g testrg
2222
"""
2323

2424
_aaz_info = {

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_show.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class Show(AAZCommand):
1818
"""Get a Scheduler
1919
2020
:example: Show information on a particular scheduler
21-
az durable-task scheduler show --resource-group testrg --scheduler-name testscheduler
21+
az durabletask scheduler show --resource-group testrg --name testscheduler
2222
"""
2323

2424
_aaz_info = {
@@ -47,8 +47,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
4747
_args_schema.resource_group = AAZResourceGroupNameArg(
4848
required=True,
4949
)
50-
_args_schema.scheduler_name = AAZStrArg(
51-
options=["-n", "--name", "--scheduler-name"],
50+
_args_schema.name = AAZStrArg(
51+
options=["-n", "--name"],
5252
help="The name of the Scheduler",
5353
required=True,
5454
id_part="name",
@@ -109,7 +109,7 @@ def url_parameters(self):
109109
required=True,
110110
),
111111
**self.serialize_url_param(
112-
"schedulerName", self.ctx.args.scheduler_name,
112+
"schedulerName", self.ctx.args.name,
113113
required=True,
114114
),
115115
**self.serialize_url_param(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_update.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
4747
_args_schema.resource_group = AAZResourceGroupNameArg(
4848
required=True,
4949
)
50-
_args_schema.scheduler_name = AAZStrArg(
51-
options=["-n", "--name", "--scheduler-name"],
50+
_args_schema.name = AAZStrArg(
51+
options=["-n", "--name"],
5252
help="The name of the Scheduler",
5353
required=True,
5454
id_part="name",
@@ -166,7 +166,7 @@ def url_parameters(self):
166166
required=True,
167167
),
168168
**self.serialize_url_param(
169-
"schedulerName", self.ctx.args.scheduler_name,
169+
"schedulerName", self.ctx.args.name,
170170
required=True,
171171
),
172172
**self.serialize_url_param(
@@ -265,7 +265,7 @@ def url_parameters(self):
265265
required=True,
266266
),
267267
**self.serialize_url_param(
268-
"schedulerName", self.ctx.args.scheduler_name,
268+
"schedulerName", self.ctx.args.name,
269269
required=True,
270270
),
271271
**self.serialize_url_param(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_wait.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
4343
_args_schema.resource_group = AAZResourceGroupNameArg(
4444
required=True,
4545
)
46-
_args_schema.scheduler_name = AAZStrArg(
47-
options=["-n", "--name", "--scheduler-name"],
46+
_args_schema.name = AAZStrArg(
47+
options=["-n", "--name"],
4848
help="The name of the Scheduler",
4949
required=True,
5050
id_part="name",
@@ -105,7 +105,7 @@ def url_parameters(self):
105105
required=True,
106106
),
107107
**self.serialize_url_param(
108-
"schedulerName", self.ctx.args.scheduler_name,
108+
"schedulerName", self.ctx.args.name,
109109
required=True,
110110
),
111111
**self.serialize_url_param(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_create.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class Create(AAZCommand):
1818
"""Create a Task Hub
1919
2020
:example: Create a taskhub in a scheduler
21-
az durabletask taskhub create --resource-group testrg--scheduler-name testscheduler --task-hub-name testtaskhub
21+
az durabletask taskhub create --resource-group testrg --scheduler-name testscheduler --name testtaskhub
2222
"""
2323

2424
_aaz_info = {
@@ -49,15 +49,15 @@ def _build_arguments_schema(cls, *args, **kwargs):
4949
required=True,
5050
)
5151
_args_schema.scheduler_name = AAZStrArg(
52-
options=["--scheduler-name"],
52+
options=["-s", "--scheduler-name"],
5353
help="The name of the Scheduler",
5454
required=True,
5555
fmt=AAZStrArgFormat(
5656
pattern="^[a-zA-Z0-9-]{3,64}$",
5757
),
5858
)
59-
_args_schema.task_hub_name = AAZStrArg(
60-
options=["-n", "--name", "--task-hub-name"],
59+
_args_schema.name = AAZStrArg(
60+
options=["-n", "--name"],
6161
help="The name of the TaskHub",
6262
required=True,
6363
fmt=AAZStrArgFormat(
@@ -141,7 +141,7 @@ def url_parameters(self):
141141
required=True,
142142
),
143143
**self.serialize_url_param(
144-
"taskHubName", self.ctx.args.task_hub_name,
144+
"taskHubName", self.ctx.args.name,
145145
required=True,
146146
),
147147
}

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_delete.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Delete(AAZCommand):
1919
"""Delete a Task Hub
2020
2121
:example: Delete a taskhub in a scheduler
22-
az durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
22+
az durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --name testtuskhub
2323
"""
2424

2525
_aaz_info = {
@@ -50,16 +50,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
5050
required=True,
5151
)
5252
_args_schema.scheduler_name = AAZStrArg(
53-
options=["--scheduler-name"],
53+
options=["-s", "--scheduler-name"],
5454
help="The name of the Scheduler",
5555
required=True,
5656
id_part="name",
5757
fmt=AAZStrArgFormat(
5858
pattern="^[a-zA-Z0-9-]{3,64}$",
5959
),
6060
)
61-
_args_schema.task_hub_name = AAZStrArg(
62-
options=["-n", "--name", "--task-hub-name"],
61+
_args_schema.name = AAZStrArg(
62+
options=["-n", "--name"],
6363
help="The name of the TaskHub",
6464
required=True,
6565
id_part="child_name_1",
@@ -149,7 +149,7 @@ def url_parameters(self):
149149
required=True,
150150
),
151151
**self.serialize_url_param(
152-
"taskHubName", self.ctx.args.task_hub_name,
152+
"taskHubName", self.ctx.args.name,
153153
required=True,
154154
),
155155
}

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_list.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
4949
required=True,
5050
)
5151
_args_schema.scheduler_name = AAZStrArg(
52-
options=["--scheduler-name"],
52+
options=["-s", "--scheduler-name"],
5353
help="The name of the Scheduler",
5454
required=True,
5555
fmt=AAZStrArgFormat(

‎src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_show.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class Show(AAZCommand):
1818
"""Get a Task Hub
1919
2020
:example: Show information on a particular taskhub
21-
az durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
21+
az durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --name testtuskhub
2222
"""
2323

2424
_aaz_info = {
@@ -48,16 +48,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
4848
required=True,
4949
)
5050
_args_schema.scheduler_name = AAZStrArg(
51-
options=["--scheduler-name"],
51+
options=["-s", "--scheduler-name"],
5252
help="The name of the Scheduler",
5353
required=True,
5454
id_part="name",
5555
fmt=AAZStrArgFormat(
5656
pattern="^[a-zA-Z0-9-]{3,64}$",
5757
),
5858
)
59-
_args_schema.task_hub_name = AAZStrArg(
60-
options=["-n", "--name", "--task-hub-name"],
59+
_args_schema.name = AAZStrArg(
60+
options=["-n", "--name"],
6161
help="The name of the TaskHub",
6262
required=True,
6363
id_part="child_name_1",
@@ -126,7 +126,7 @@ def url_parameters(self):
126126
required=True,
127127
),
128128
**self.serialize_url_param(
129-
"taskHubName", self.ctx.args.task_hub_name,
129+
"taskHubName", self.ctx.args.name,
130130
required=True,
131131
),
132132
}

0 commit comments

Comments
 (0)