task_hubs

Creates, updates, deletes, gets or lists a task_hubs resource.

Overview

Name	task_hubs
Type	Resource
Id	azure.durable_task.task_hubs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dashboardUrl	string	URL of the durable task scheduler dashboard.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_scheduler

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dashboardUrl	string	URL of the durable task scheduler dashboard.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, scheduler_name, task_hub_name, subscription_id		Get a Task Hub.
list_by_scheduler	select	resource_group_name, scheduler_name, subscription_id		List Task Hubs.
create_or_update	insert	resource_group_name, scheduler_name, task_hub_name, subscription_id		Create or Update a Task Hub.
create_or_update	replace	resource_group_name, scheduler_name, task_hub_name, subscription_id		Create or Update a Task Hub.
delete	delete	resource_group_name, scheduler_name, task_hub_name, subscription_id		Delete a Task Hub.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scheduler_name	string	The name of the Scheduler. Required.
subscription_id	string
task_hub_name	string	The name of the TaskHub. Required.

SELECT examples

get

Get a Task Hub.

SELECT
id,
name,
dashboardUrl,
provisioningState,
systemData,
type
FROM azure.durable_task.task_hubs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND task_hub_name = '{{ task_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_scheduler

List Task Hubs.

SELECT
id,
name,
dashboardUrl,
provisioningState,
systemData,
type
FROM azure.durable_task.task_hubs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update a Task Hub.

INSERT INTO azure.durable_task.task_hubs (
properties,
resource_group_name,
scheduler_name,
task_hub_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scheduler_name }}',
'{{ task_hub_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: task_hubs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the task_hubs resource.
  - name: scheduler_name
    value: "{{ scheduler_name }}"
    description: Required parameter for the task_hubs resource.
  - name: task_hub_name
    value: "{{ task_hub_name }}"
    description: Required parameter for the task_hubs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the task_hubs resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      dashboardUrl: "{{ dashboardUrl }}"

REPLACE examples

create_or_update

Create or Update a Task Hub.

REPLACE azure.durable_task.task_hubs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND task_hub_name = '{{ task_hub_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Task Hub.

DELETE FROM azure.durable_task.task_hubs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND task_hub_name = '{{ task_hub_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;