{ "swagger": "2.0", "info": { "title": "Microsoft.DurableTask", "version": "2026-02-01", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Schedulers" }, { "name": "TaskHubs" }, { "name": "RetentionPolicies" } ], "paths": { "/providers/Microsoft.DurableTask/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DurableTask/schedulers": { "get": { "operationId": "Schedulers_ListBySubscription", "tags": [ "Schedulers" ], "description": "List Schedulers by subscription", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SchedulerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_ListBySubscription": { "$ref": "./examples/Schedulers_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers": { "get": { "operationId": "Schedulers_ListByResourceGroup", "tags": [ "Schedulers" ], "description": "List Schedulers by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SchedulerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_ListByResourceGroup": { "$ref": "./examples/Schedulers_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}": { "get": { "operationId": "Schedulers_Get", "tags": [ "Schedulers" ], "description": "Get a Scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Scheduler" } }, "default": { "description": "Not found error: resource does not exist", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_Get": { "$ref": "./examples/Schedulers_Get.json" } } }, "put": { "operationId": "Schedulers_CreateOrUpdate", "tags": [ "Schedulers" ], "description": "Create or update a Scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Scheduler" } } ], "responses": { "200": { "description": "Resource 'Scheduler' update operation succeeded", "schema": { "$ref": "#/definitions/Scheduler" } }, "201": { "description": "Resource 'Scheduler' create operation succeeded", "schema": { "$ref": "#/definitions/Scheduler" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "Validation error: required parameters are missing", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_CreateOrUpdate": { "$ref": "./examples/Schedulers_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Schedulers_Update", "tags": [ "Schedulers" ], "description": "Update a Scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/SchedulerUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Scheduler" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "Validation error: required parameters are missing", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_Update": { "$ref": "./examples/Schedulers_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Schedulers_Delete", "tags": [ "Schedulers" ], "description": "Delete a Scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Schedulers_Delete": { "$ref": "./examples/Schedulers_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateEndpointConnections": { "get": { "operationId": "Schedulers_ListPrivateEndpointConnections", "tags": [ "Schedulers" ], "description": "List private endpoint connections for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_List_MaximumSet": { "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "Schedulers_GetPrivateEndpointConnection", "tags": [ "Schedulers" ], "description": "Get a private endpoint connection for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Get_MaximumSet": { "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "Schedulers_CreateOrUpdatePrivateEndpointConnection", "tags": [ "Schedulers" ], "description": "Create or update a private endpoint connection for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Create_MaximumSet": { "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Schedulers_UpdatePrivateEndpointConnection", "tags": [ "Schedulers" ], "description": "Update a private endpoint connection for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/Azure.ResourceManager.PrivateEndpointConnectionUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Update": { "$ref": "./examples/PrivateEndpointConnections_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Schedulers_DeletePrivateEndpointConnection", "tags": [ "Schedulers" ], "description": "Delete a private endpoint connection for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Delete_MaximumSet": { "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources": { "get": { "operationId": "Schedulers_ListPrivateLinks", "tags": [ "Schedulers" ], "description": "List private link resources for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SchedulerPrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkResources_List_MaximumSet": { "$ref": "./examples/PrivateLinkResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources/{privateLinkResourceName}": { "get": { "operationId": "Schedulers_GetPrivateLink", "tags": [ "Schedulers" ], "description": "Get a private link resource for the durable task scheduler", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "privateLinkResourceName", "in": "path", "description": "The name of the private link associated with the Azure resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkResources_Get_MaximumSet": { "$ref": "./examples/PrivateLinkResources_Get_MaximumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies": { "get": { "operationId": "RetentionPolicies_ListByScheduler", "tags": [ "RetentionPolicies" ], "description": "List Retention Policies", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RetentionPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RetentionPolicies_ListByScheduler_MaximumSet": { "$ref": "./examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default": { "get": { "operationId": "RetentionPolicies_Get", "tags": [ "RetentionPolicies" ], "description": "Get a Retention Policy", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RetentionPolicy" } }, "default": { "description": "Not found error: resource does not exist", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RetentionPolicies_Get_MaximumSet": { "$ref": "./examples/RetentionPolicies_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "RetentionPolicies_CreateOrReplace", "tags": [ "RetentionPolicies" ], "description": "Create or Update a Retention Policy", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/RetentionPolicy" } } ], "responses": { "200": { "description": "Resource 'RetentionPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/RetentionPolicy" } }, "201": { "description": "Resource 'RetentionPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/RetentionPolicy" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "Validation error: required parameters are missing", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RetentionPolicies_CreateOrReplace_MaximumSet": { "$ref": "./examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "RetentionPolicies_Update", "tags": [ "RetentionPolicies" ], "description": "Update a Retention Policy", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/RetentionPolicyUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RetentionPolicy" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "Validation error: required parameters are missing", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RetentionPolicies_Update_MaximumSet": { "$ref": "./examples/RetentionPolicies_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RetentionPolicies_Delete", "tags": [ "RetentionPolicies" ], "description": "Delete a Retention Policy", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RetentionPolicies_Delete_MaximumSet": { "$ref": "./examples/RetentionPolicies_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs": { "get": { "operationId": "TaskHubs_ListByScheduler", "tags": [ "TaskHubs" ], "description": "List Task Hubs", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TaskHubListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TaskHubs_ListByScheduler": { "$ref": "./examples/TaskHubs_ListByScheduler.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs/{taskHubName}": { "get": { "operationId": "TaskHubs_Get", "tags": [ "TaskHubs" ], "description": "Get a Task Hub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "taskHubName", "in": "path", "description": "The name of the TaskHub", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TaskHub" } }, "default": { "description": "Not found error: resource does not exist", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TaskHubs_Get": { "$ref": "./examples/TaskHubs_Get.json" } } }, "put": { "operationId": "TaskHubs_CreateOrUpdate", "tags": [ "TaskHubs" ], "description": "Create or Update a Task Hub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "taskHubName", "in": "path", "description": "The name of the TaskHub", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/TaskHub" } } ], "responses": { "200": { "description": "Resource 'TaskHub' update operation succeeded", "schema": { "$ref": "#/definitions/TaskHub" } }, "201": { "description": "Resource 'TaskHub' create operation succeeded", "schema": { "$ref": "#/definitions/TaskHub" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "Validation error: required parameters are missing", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TaskHubs_CreateOrUpdate": { "$ref": "./examples/TaskHubs_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "TaskHubs_Delete", "tags": [ "TaskHubs" ], "description": "Delete a Task Hub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "schedulerName", "in": "path", "description": "The name of the Scheduler", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "taskHubName", "in": "path", "description": "The name of the TaskHub", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TaskHubs_Delete": { "$ref": "./examples/TaskHubs_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "Azure.ResourceManager.PrivateEndpointConnectionUpdate": { "type": "object", "description": "PATCH model for private endpoint connections", "properties": { "properties": { "type": "object", "description": "The private endpoint connection properties", "properties": { "privateEndpoint": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpoint", "description": "The private endpoint resource." }, "privateLinkServiceConnectionState": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." } } } } }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a PrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProvisioningState": { "type": "string", "description": "The status of the current operation", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "PublicNetworkAccess": { "type": "string", "description": "State of the public network access.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "The public network access is enabled" }, { "name": "Disabled", "value": "Disabled", "description": "The public network access is disabled" } ] } }, "PurgeableOrchestrationState": { "type": "string", "description": "Purgeable orchestration state to be used in retention policies", "enum": [ "Completed", "Failed", "Terminated", "Canceled" ], "x-ms-enum": { "name": "PurgeableOrchestrationState", "modelAsString": true, "values": [ { "name": "Completed", "value": "Completed", "description": "The orchestration is completed" }, { "name": "Failed", "value": "Failed", "description": "The orchestration is failed" }, { "name": "Terminated", "value": "Terminated", "description": "The orchestration is terminated" }, { "name": "Canceled", "value": "Canceled", "description": "The orchestration is canceled" } ] } }, "RedundancyState": { "type": "string", "description": "The state of the resource redundancy", "enum": [ "None", "Zone" ], "x-ms-enum": { "name": "RedundancyState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "The resource is not redundant" }, { "name": "Zone", "value": "Zone", "description": "The resource is zone redundant" } ] } }, "RetentionPolicy": { "type": "object", "description": "A retention policy resource belonging to the scheduler", "properties": { "properties": { "$ref": "#/definitions/RetentionPolicyProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RetentionPolicyDetails": { "type": "object", "description": "The properties of a retention policy", "properties": { "retentionPeriodInDays": { "type": "integer", "format": "int32", "description": "The retention period in days after which the orchestration will be purged automatically" }, "orchestrationState": { "$ref": "#/definitions/PurgeableOrchestrationState", "description": "The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states." } }, "required": [ "retentionPeriodInDays" ] }, "RetentionPolicyListResult": { "type": "object", "description": "The response of a RetentionPolicy list operation.", "properties": { "value": { "type": "array", "description": "The RetentionPolicy items on this page", "items": { "$ref": "#/definitions/RetentionPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RetentionPolicyProperties": { "type": "object", "description": "The retention policy settings for the resource", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation", "readOnly": true }, "retentionPolicies": { "type": "array", "description": "The orchestration retention policies", "items": { "$ref": "#/definitions/RetentionPolicyDetails" }, "x-ms-identifiers": [ "retentionPeriodInDays", "orchestrationState" ] } } }, "RetentionPolicyUpdate": { "type": "object", "description": "A retention policy resource belonging to the scheduler", "properties": { "properties": { "$ref": "#/definitions/RetentionPolicyProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "Scheduler": { "type": "object", "description": "A Durable Task Scheduler resource", "properties": { "properties": { "$ref": "#/definitions/SchedulerProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "SchedulerListResult": { "type": "object", "description": "The response of a Scheduler list operation.", "properties": { "value": { "type": "array", "description": "The Scheduler items on this page", "items": { "$ref": "#/definitions/Scheduler" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SchedulerPrivateLinkResourceListResult": { "type": "object", "description": "The response of a SchedulerPrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The SchedulerPrivateLinkResource items on this page", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SchedulerProperties": { "type": "object", "description": "Details of the Scheduler", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation", "readOnly": true }, "endpoint": { "type": "string", "description": "URL of the durable task scheduler", "readOnly": true }, "ipAllowlist": { "type": "array", "description": "IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR", "items": { "type": "string" } }, "sku": { "$ref": "#/definitions/SchedulerSku", "description": "SKU of the durable task scheduler" }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Allow or disallow public network access to durable task scheduler" }, "privateEndpointConnections": { "type": "array", "description": "The private endpoints exposed by this resource", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true } }, "required": [ "ipAllowlist", "sku" ] }, "SchedulerPropertiesUpdate": { "type": "object", "description": "The Scheduler resource properties to be updated", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation", "readOnly": true }, "endpoint": { "type": "string", "description": "URL of the durable task scheduler", "readOnly": true }, "ipAllowlist": { "type": "array", "description": "IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR", "items": { "type": "string" } }, "sku": { "$ref": "#/definitions/SchedulerSkuUpdate", "description": "SKU of the durable task scheduler" }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Allow or disallow public network access to durable task scheduler" } } }, "SchedulerSku": { "type": "object", "description": "The SKU (Stock Keeping Unit) assigned to this durable task scheduler", "properties": { "name": { "$ref": "#/definitions/SchedulerSkuName", "description": "The name of the SKU" }, "capacity": { "type": "integer", "format": "int32", "description": "The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy" }, "redundancyState": { "$ref": "#/definitions/RedundancyState", "description": "Indicates whether the current SKU configuration is zone redundant", "readOnly": true } }, "required": [ "name" ] }, "SchedulerSkuName": { "type": "string", "description": "The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler", "enum": [ "Dedicated", "Consumption" ], "x-ms-enum": { "name": "SchedulerSkuName", "modelAsString": true, "values": [ { "name": "Dedicated", "value": "Dedicated", "description": "Dedicated SKU" }, { "name": "Consumption", "value": "Consumption", "description": "Consumption SKU" } ] } }, "SchedulerSkuUpdate": { "type": "object", "description": "The SKU (Stock Keeping Unit) properties to be updated", "properties": { "name": { "$ref": "#/definitions/SchedulerSkuName", "description": "The name of the SKU" }, "capacity": { "type": "integer", "format": "int32", "description": "The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy" }, "redundancyState": { "$ref": "#/definitions/RedundancyState", "description": "Indicates whether the current SKU configuration is zone redundant", "readOnly": true } } }, "SchedulerUpdate": { "type": "object", "description": "The update request model for the Scheduler resource", "properties": { "properties": { "$ref": "#/definitions/SchedulerPropertiesUpdate", "description": "The resource-specific properties for this resource." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "TaskHub": { "type": "object", "description": "A Task Hub resource belonging to the scheduler", "properties": { "properties": { "$ref": "#/definitions/TaskHubProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "TaskHubListResult": { "type": "object", "description": "The response of a TaskHub list operation.", "properties": { "value": { "type": "array", "description": "The TaskHub items on this page", "items": { "$ref": "#/definitions/TaskHub" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TaskHubProperties": { "type": "object", "description": "The properties of Task Hub", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation", "readOnly": true }, "dashboardUrl": { "type": "string", "format": "uri", "description": "URL of the durable task scheduler dashboard", "readOnly": true } } } }, "parameters": {} }