Skip to content

Durabletask shorthand fixes and readme fixes #8414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kairu-ms merged 3 commits into from
Jan 26, 2025
Merged

Durabletask shorthand fixes and readme fixes #8414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdef5f5
removing extra hyphen in some command examples
RyanLettieri Jan 13, 2025
cbd04c1
Adding short hand annotations for CLI args
RyanLettieri Jan 9, 2025
899c8f3
Changing default string for resources to be --name
RyanLettieri Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class Create(AAZCommand):
"""Create a Scheduler

:example: Create a scheduler in northcentralus
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 "{}"
:example: Create a scheduler in eastus
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 "{}"
"""

_aaz_info = {
Expand Down Expand Up @@ -48,8 +48,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["-n", "--name", "--scheduler-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the Scheduler",
required=True,
fmt=AAZStrArgFormat(
Expand Down Expand Up @@ -171,7 +171,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down
8 changes: 4 additions & 4 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_delete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Delete(AAZCommand):
"""Delete a Scheduler

:example: Delete a scheduler
az durable-task scheduler delete --resource-group testrg --scheduler-name testscheduler
az durabletask scheduler delete --resource-group testrg --name testscheduler
"""

_aaz_info = {
Expand Down Expand Up @@ -49,8 +49,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["-n", "--name", "--scheduler-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the Scheduler",
required=True,
id_part="name",
Expand Down Expand Up @@ -132,7 +132,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down
2 changes: 1 addition & 1 deletion src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class List(AAZCommand):
"""List Schedulers by subscription

:example: List all schedulers in a resource group
az durable-task scheduler list -g testrg
az durabletask scheduler list -g testrg
"""

_aaz_info = {
Expand Down
8 changes: 4 additions & 4 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_show.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class Show(AAZCommand):
"""Get a Scheduler

:example: Show information on a particular scheduler
az durable-task scheduler show --resource-group testrg --scheduler-name testscheduler
az durabletask scheduler show --resource-group testrg --name testscheduler
"""

_aaz_info = {
Expand Down Expand Up @@ -47,8 +47,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["-n", "--name", "--scheduler-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the Scheduler",
required=True,
id_part="name",
Expand Down Expand Up @@ -109,7 +109,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down
8 changes: 4 additions & 4 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["-n", "--name", "--scheduler-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the Scheduler",
required=True,
id_part="name",
Expand Down Expand Up @@ -166,7 +166,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down Expand Up @@ -265,7 +265,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down
6 changes: 3 additions & 3 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/scheduler/_wait.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["-n", "--name", "--scheduler-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the Scheduler",
required=True,
id_part="name",
Expand Down Expand Up @@ -105,7 +105,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"schedulerName", self.ctx.args.scheduler_name,
"schedulerName", self.ctx.args.name,
required=True,
),
**self.serialize_url_param(
Expand Down
10 changes: 5 additions & 5 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class Create(AAZCommand):
"""Create a Task Hub

:example: Create a taskhub in a scheduler
az durabletask taskhub create --resource-group testrg--scheduler-name testscheduler --task-hub-name testtaskhub
az durabletask taskhub create --resource-group testrg --scheduler-name testscheduler --name testtaskhub
"""

_aaz_info = {
Expand Down Expand Up @@ -49,15 +49,15 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
fmt=AAZStrArgFormat(
pattern="^[a-zA-Z0-9-]{3,64}$",
),
)
_args_schema.task_hub_name = AAZStrArg(
options=["-n", "--name", "--task-hub-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the TaskHub",
required=True,
fmt=AAZStrArgFormat(
Expand Down Expand Up @@ -141,7 +141,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down
10 changes: 5 additions & 5 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_delete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Delete(AAZCommand):
"""Delete a Task Hub

:example: Delete a taskhub in a scheduler
az durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
az durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --name testtuskhub
"""

_aaz_info = {
Expand Down Expand Up @@ -50,16 +50,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
id_part="name",
fmt=AAZStrArgFormat(
pattern="^[a-zA-Z0-9-]{3,64}$",
),
)
_args_schema.task_hub_name = AAZStrArg(
options=["-n", "--name", "--task-hub-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the TaskHub",
required=True,
id_part="child_name_1",
Expand Down Expand Up @@ -149,7 +149,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down
2 changes: 1 addition & 1 deletion src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
fmt=AAZStrArgFormat(
Expand Down
10 changes: 5 additions & 5 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_show.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class Show(AAZCommand):
"""Get a Task Hub

:example: Show information on a particular taskhub
az durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
az durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --name testtuskhub
"""

_aaz_info = {
Expand Down Expand Up @@ -48,16 +48,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
id_part="name",
fmt=AAZStrArgFormat(
pattern="^[a-zA-Z0-9-]{3,64}$",
),
)
_args_schema.task_hub_name = AAZStrArg(
options=["-n", "--name", "--task-hub-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the TaskHub",
required=True,
id_part="child_name_1",
Expand Down Expand Up @@ -126,7 +126,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down
10 changes: 5 additions & 5 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
id_part="name",
fmt=AAZStrArgFormat(
pattern="^[a-zA-Z0-9-]{3,64}$",
),
)
_args_schema.task_hub_name = AAZStrArg(
options=["-n", "--name", "--task-hub-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the TaskHub",
required=True,
id_part="child_name_1",
Expand Down Expand Up @@ -139,7 +139,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down Expand Up @@ -242,7 +242,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down
8 changes: 4 additions & 4 deletions src/durabletask/azext_durabletask/aaz/latest/durabletask/taskhub/_wait.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ def _build_arguments_schema(cls, *args, **kwargs):
required=True,
)
_args_schema.scheduler_name = AAZStrArg(
options=["--scheduler-name"],
options=["-s", "--scheduler-name"],
help="The name of the Scheduler",
required=True,
id_part="name",
fmt=AAZStrArgFormat(
pattern="^[a-zA-Z0-9-]{3,64}$",
),
)
_args_schema.task_hub_name = AAZStrArg(
options=["-n", "--name", "--task-hub-name"],
_args_schema.name = AAZStrArg(
options=["-n", "--name"],
help="The name of the TaskHub",
required=True,
id_part="child_name_1",
Expand Down Expand Up @@ -122,7 +122,7 @@ def url_parameters(self):
required=True,
),
**self.serialize_url_param(
"taskHubName", self.ctx.args.task_hub_name,
"taskHubName", self.ctx.args.name,
required=True,
),
}
Expand Down
Loading