schedulers

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

Overview

Name	schedulers
Type	Resource
Id	azure.durable_task.schedulers

Fields

The following fields are returned by SELECT queries:

get_private_link

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.
groupId	string	The private link resource group id.
requiredMembers	array	The private link resource required member names.
requiredZoneNames	array	The private link resource private link DNS zone name.
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".

get_private_endpoint_connection

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.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, Deleting, Failed)
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".

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.
endpoint	string	URL of the durable task scheduler.
ipAllowlist	array	IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The private endpoints exposed by this resource.
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)
publicNetworkAccess	string	Allow or disallow public network access to durable task scheduler. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	SKU of the durable task scheduler. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
endpoint	string	URL of the durable task scheduler.
ipAllowlist	array	IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The private endpoints exposed by this resource.
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)
publicNetworkAccess	string	Allow or disallow public network access to durable task scheduler. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	SKU of the durable task scheduler. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
endpoint	string	URL of the durable task scheduler.
ipAllowlist	array	IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The private endpoints exposed by this resource.
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)
publicNetworkAccess	string	Allow or disallow public network access to durable task scheduler. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	SKU of the durable task scheduler. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_private_link	select	resource_group_name, scheduler_name, private_link_resource_name, subscription_id		Get a private link resource for the durable task scheduler.
get_private_endpoint_connection	select	resource_group_name, scheduler_name, private_endpoint_connection_name, subscription_id		Get a private endpoint connection for the durable task scheduler.
get	select	resource_group_name, scheduler_name, subscription_id		Get a Scheduler.
list_by_resource_group	select	resource_group_name, subscription_id		List Schedulers by resource group.
list_by_subscription	select	subscription_id		List Schedulers by subscription.
create_or_update	insert	resource_group_name, scheduler_name, subscription_id, location		Create or update a Scheduler.
update	update	resource_group_name, scheduler_name, subscription_id		Update a Scheduler.
create_or_update	replace	resource_group_name, scheduler_name, subscription_id, location		Create or update a Scheduler.
delete	delete	resource_group_name, scheduler_name, subscription_id		Delete a Scheduler.
list_private_links	exec	resource_group_name, scheduler_name, subscription_id		List private link resources for the durable task scheduler.
list_private_endpoint_connections	exec	resource_group_name, scheduler_name, subscription_id		List private endpoint connections for the durable task scheduler.
create_or_update_private_endpoint_connection	exec	resource_group_name, scheduler_name, private_endpoint_connection_name, subscription_id		Create or update a private endpoint connection for the durable task scheduler.
update_private_endpoint_connection	exec	resource_group_name, scheduler_name, private_endpoint_connection_name, subscription_id		Update a private endpoint connection for the durable task scheduler.
delete_private_endpoint_connection	exec	resource_group_name, scheduler_name, private_endpoint_connection_name, subscription_id		Delete a private endpoint connection for the durable task scheduler.

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
private_endpoint_connection_name	string	The name of the private endpoint connection associated with the Azure resource. Required.
private_link_resource_name	string	The name of the private link associated with the Azure resource. Required.
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

SELECT examples

get_private_link

Get a private link resource for the durable task scheduler.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.durable_task.schedulers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_private_endpoint_connection

Get a private endpoint connection for the durable task scheduler.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.durable_task.schedulers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a Scheduler.

SELECT
id,
name,
endpoint,
ipAllowlist,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.durable_task.schedulers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Schedulers by resource group.

SELECT
id,
name,
endpoint,
ipAllowlist,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.durable_task.schedulers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Schedulers by subscription.

SELECT
id,
name,
endpoint,
ipAllowlist,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.durable_task.schedulers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Scheduler.

INSERT INTO azure.durable_task.schedulers (
tags,
location,
properties,
resource_group_name,
scheduler_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scheduler_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: schedulers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the schedulers resource.
  - name: scheduler_name
    value: "{{ scheduler_name }}"
    description: Required parameter for the schedulers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the schedulers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      endpoint: "{{ endpoint }}"
      ipAllowlist:
        - "{{ ipAllowlist }}"
      sku:
        name: "{{ name }}"
        capacity: {{ capacity }}
        redundancyState: "{{ redundancyState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a Scheduler.

UPDATE azure.durable_task.schedulers
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Scheduler.

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

DELETE examples

delete

Delete a Scheduler.

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

Lifecycle Methods

list_private_links

List private link resources for the durable task scheduler.

EXEC azure.durable_task.schedulers.list_private_links 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_private_endpoint_connections

List private endpoint connections for the durable task scheduler.

EXEC azure.durable_task.schedulers.list_private_endpoint_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_private_endpoint_connection

Create or update a private endpoint connection for the durable task scheduler.

EXEC azure.durable_task.schedulers.create_or_update_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_private_endpoint_connection

Update a private endpoint connection for the durable task scheduler.

EXEC azure.durable_task.schedulers.update_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_private_endpoint_connection

Delete a private endpoint connection for the durable task scheduler.

EXEC azure.durable_task.schedulers.delete_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;