Skip to content
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.

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

DurableTask Readme fixes and short hand argument fix #672

Merged
merged 3 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Commands/durabletask/scheduler/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Create a Scheduler

- Create a scheduler in eastus
```bash
durable-task scheduler create --resource-group testrg --scheduler-name testscheduler --location eastus --ip-allowlist "[0.0.0.0/0]" --sku-capacity "1", --sku-name "Dedicated" --tags "{}"
durabletask scheduler create --resource-group testrg --name testscheduler --location eastus --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1, --sku-name "Dedicated" --tags "{}"
```
2 changes: 1 addition & 1 deletion Commands/durabletask/scheduler/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Delete a Scheduler

- Delete a scheduler
```bash
durable-task scheduler delete --resource-group testrg --scheduler-name testscheduler
durabletask scheduler delete --resource-group testrg --name testscheduler
```
2 changes: 1 addition & 1 deletion Commands/durabletask/scheduler/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ List Schedulers by subscription

- List all schedulers in a resource group
```bash
durable-task scheduler list -g testrg
durabletask scheduler list -g testrg
```
2 changes: 1 addition & 1 deletion Commands/durabletask/scheduler/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Get a Scheduler

- Show information on a particular scheduler
```bash
durable-task scheduler show --resource-group testrg --scheduler-name testscheduler
durabletask scheduler show --resource-group testrg --name testscheduler
```
2 changes: 1 addition & 1 deletion Commands/durabletask/taskhub/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Create a Task Hub

- Create a taskhub in a scheduler
```bash
durabletask taskhub create --resource-group testrg--scheduler-name testscheduler --task-hub-name testtaskhub
durabletask taskhub create --resource-group testrg --scheduler-name testscheduler --name testtaskhub
```
2 changes: 1 addition & 1 deletion Commands/durabletask/taskhub/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Delete a Task Hub

- Delete a taskhub in a scheduler
```bash
durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --name testtuskhub
```
2 changes: 1 addition & 1 deletion Commands/durabletask/taskhub/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Get a Task Hub

- Show information on a particular taskhub
```bash
durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub
durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --name testtuskhub
```
14 changes: 7 additions & 7 deletions Commands/tree.json
Original file line number Diff line number Diff line change
Expand Up @@ -51155,7 +51155,7 @@
"examples": [
{
"commands": [
"durable-task scheduler create --resource-group testrg --scheduler-name testscheduler --location eastus --ip-allowlist \"[0.0.0.0/0]\" --sku-capacity \"1\", --sku-name \"Dedicated\" --tags \"{}\""
"durabletask scheduler create --resource-group testrg --name testscheduler --location eastus --ip-allowlist \"[0.0.0.0/0]\" --sku-capacity 1, --sku-name \"Dedicated\" --tags \"{}\""
],
"name": "Create a scheduler in eastus"
}
Expand Down Expand Up @@ -51185,7 +51185,7 @@
"examples": [
{
"commands": [
"durable-task scheduler delete --resource-group testrg --scheduler-name testscheduler"
"durabletask scheduler delete --resource-group testrg --name testscheduler"
],
"name": "Delete a scheduler"
}
Expand Down Expand Up @@ -51215,7 +51215,7 @@
"examples": [
{
"commands": [
"durable-task scheduler list -g testrg"
"durabletask scheduler list -g testrg"
],
"name": "List all schedulers in a resource group"
}
Expand Down Expand Up @@ -51250,7 +51250,7 @@
"examples": [
{
"commands": [
"durable-task scheduler show --resource-group testrg --scheduler-name testscheduler"
"durabletask scheduler show --resource-group testrg --name testscheduler"
],
"name": "Show information on a particular scheduler"
}
Expand Down Expand Up @@ -51332,7 +51332,7 @@
"examples": [
{
"commands": [
"durabletask taskhub create --resource-group testrg--scheduler-name testscheduler --task-hub-name testtaskhub"
"durabletask taskhub create --resource-group testrg --scheduler-name testscheduler --name testtaskhub"
],
"name": "Create a taskhub in a scheduler"
}
Expand Down Expand Up @@ -51381,7 +51381,7 @@
"examples": [
{
"commands": [
"durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub"
"durabletask taskhub delete --resource-group testrg --scheduler-name testscheduler --name testtuskhub"
],
"name": "Delete a taskhub in a scheduler"
}
Expand Down Expand Up @@ -51479,7 +51479,7 @@
"examples": [
{
"commands": [
"durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --task-hub-name testtuskhub"
"durabletask taskhub show --resource-group testrg --scheduler-name testscheduler --name testtuskhub"
],
"name": "Show information on a particular taskhub"
}
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}" version="2024-10-01-preview" swagger="mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0=/V/MjAyNC0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.schedulerName" options="scheduler-name name n" required="True" idPart="name">
<arg type="string" var="$Path.schedulerName" options="name n" required="True" group="" idPart="name">
<help short="The name of the Scheduler"/>
<format pattern="^[a-zA-Z0-9-]{3,64}$"/>
</arg>
Expand Down Expand Up @@ -114,7 +114,7 @@
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}" version="2024-10-01-preview" swagger="mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0=/V/MjAyNC0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.schedulerName" options="scheduler-name name n" required="True" idPart="name">
<arg type="string" var="$Path.schedulerName" options="name n" required="True" group="" idPart="name">
<help short="The name of the Scheduler"/>
<format pattern="^[a-zA-Z0-9-]{3,64}$"/>
</arg>
Expand Down Expand Up @@ -162,7 +162,7 @@
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}" version="2024-10-01-preview" swagger="mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0=/V/MjAyNC0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.schedulerName" options="scheduler-name name n" required="True" idPart="name">
<arg type="string" var="$Path.schedulerName" options="name n" required="True" group="" idPart="name">
<help short="The name of the Scheduler"/>
<format pattern="^[a-zA-Z0-9-]{3,64}$"/>
</arg>
Expand Down Expand Up @@ -317,7 +317,7 @@
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}" version="2024-10-01-preview" swagger="mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0=/V/MjAyNC0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.schedulerName" options="scheduler-name name n" required="True" idPart="name">
<arg type="string" var="$Path.schedulerName" options="name n" required="True" group="" idPart="name">
<help short="The name of the Scheduler"/>
<format pattern="^[a-zA-Z0-9-]{3,64}$"/>
</arg>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}/taskhubs", "version": "2024-10-01-preview", "swagger": "mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0vdGFza0h1YnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "commandGroups": [{"name": "durabletask taskhub", "commands": [{"name": "list", "version": "2024-10-01-preview", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}/taskhubs", "version": "2024-10-01-preview", "swagger": "mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0vdGFza0h1YnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "string", "var": "$Path.schedulerName", "options": ["scheduler-name"], "required": true, "idPart": "name", "help": {"short": "The name of the Scheduler"}, "format": {"pattern": "^[a-zA-Z0-9-]{3,64}$"}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}], "operations": [{"operationId": "TaskHubs_ListByScheduler", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "schedulerName", "arg": "$Path.schedulerName", "required": true, "format": {"pattern": "^[a-zA-Z0-9-]{3,64}$"}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-10-01-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.DurableTask/schedulers/{}/taskHubs/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"readOnly": true, "type": "string", "name": "dashboardUrl"}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Accepted"}, {"value": "Canceled"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Provisioning"}, {"value": "Succeeded"}, {"value": "Updating"}]}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt"}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt"}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}/taskhubs", "version": "2024-10-01-preview", "swagger": "mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0vdGFza0h1YnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "commandGroups": [{"name": "durabletask taskhub", "commands": [{"name": "list", "version": "2024-10-01-preview", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}/taskhubs", "version": "2024-10-01-preview", "swagger": "mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0vdGFza0h1YnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "string", "var": "$Path.schedulerName", "options": ["s", "scheduler-name"], "required": true, "group": "", "idPart": "name", "help": {"short": "The name of the Scheduler"}, "format": {"pattern": "^[a-zA-Z0-9-]{3,64}$"}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}], "operations": [{"operationId": "TaskHubs_ListByScheduler", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "schedulerName", "arg": "$Path.schedulerName", "required": true, "format": {"pattern": "^[a-zA-Z0-9-]{3,64}$"}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-10-01-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.DurableTask/schedulers/{}/taskHubs/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"readOnly": true, "type": "string", "name": "dashboardUrl"}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Accepted"}, {"value": "Canceled"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Provisioning"}, {"value": "Succeeded"}, {"value": "Updating"}]}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt"}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt"}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.durabletask/schedulers/{}/taskhubs" version="2024-10-01-preview" swagger="mgmt-plane/durabletask/ResourceProviders/Microsoft.DurableTask/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuRHVyYWJsZVRhc2svc2NoZWR1bGVycy97c2NoZWR1bGVyTmFtZX0vdGFza0h1YnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.schedulerName" options="scheduler-name" required="True" idPart="name">
<arg type="string" var="$Path.schedulerName" options="scheduler-name s" required="True" group="" idPart="name">
<help short="The name of the Scheduler"/>
<format pattern="^[a-zA-Z0-9-]{3,64}$"/>
</arg>
Expand Down

Large diffs are not rendered by default.

Loading
Loading