az durabletask taskhub

Note

This reference is part of the durabletask extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az durabletask taskhub command. Learn more about extensions.

Command group 'az durabletask' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage Durabletask taskhubs.

Commands

Name	Description	Type	Status
az durabletask taskhub create	Create a Task Hub.	Extension	Preview
az durabletask taskhub delete	Delete a Task Hub.	Extension	Preview
az durabletask taskhub list	List Task Hubs.	Extension	Preview
az durabletask taskhub show	Get a Task Hub.	Extension	Preview
az durabletask taskhub update	Update a Task Hub.	Extension	Preview

az durabletask taskhub create

Preview

Command group 'az durabletask taskhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Task Hub.

az durabletask taskhub create --name --task-hub-name
                              --namespace-name
                              --resource-group
                              [--tags]

Examples

Create a taskhub in a namespace

az durabletask taskhub create -g resource-grou-name -s testnamespace -n taskhub-name

Required Parameters

--name --task-hub-name -n

Task Hub name.

--namespace-name -s

The name of the namespace.

--resource-group -g

The name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az durabletask taskhub delete

Preview

Command group 'az durabletask taskhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Task Hub.

az durabletask taskhub delete [--ids]
                              [--name --task-hub-name]
                              [--namespace-name]
                              [--resource-group]
                              [--subscription]
                              [--yes]

Examples

Delete a taskhub

az durabletask taskhub delete -g resource-grou-name -s namespace-name -n taskhub-name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --task-hub-name -n

Task Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name -s

The name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

The name of the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az durabletask taskhub list

Preview

Command group 'az durabletask taskhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Task Hubs.

az durabletask taskhub list --namespace-name
                            --resource-group
                            [--max-items]
                            [--next-token]

Examples

List all taskhubs for a given namespace

az durabletask taskhub show -g resource-group-name -s namespace-name

Required Parameters

--namespace-name -s

The name of the namespace.

--resource-group -g

The name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az durabletask taskhub show

Preview

Command group 'az durabletask taskhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Task Hub.

az durabletask taskhub show [--ids]
                            [--name --task-hub-name]
                            [--namespace-name]
                            [--resource-group]
                            [--subscription]

Examples

Show information on a particular taskhub

az durabletask taskhub show -g resource-group-name -s namespace-name -n taskhub-name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --task-hub-name -n

Task Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name -s

The name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

The name of the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az durabletask taskhub update

Preview

Command group 'az durabletask taskhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Task Hub.

az durabletask taskhub update [--add]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--name --task-hub-name]
                              [--namespace-name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--tags]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --task-hub-name -n

Task Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name -s

The name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

The name of the resource group.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False