Microsoft.DurableTask (preview:2024-10-01)

2025/03/18 • 1 updated methods

Schedulers_Update (updated)
Description :  Update a Scheduler
Reference :  Link ¶

⚶ Changes

{
  "#id": "Schedulers_Update",
  "$parameters": {
    "properties": {
      "Description": {
        "new": "The update request model for the Scheduler resource",
        "old": "A Durable Task Scheduler resource"
      },
      "$properties": {
        "properties": [
          {
            "@added_fb97eef8f32a434d8231e920640345a8": {
              "#name": "provisioningState",
              "Description": "The status of the last operation",
              "Enum": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_b63a516d2cab4474b739abf11ae0faf1": {
              "#name": "endpoint",
              "Description": "URL of the durable task scheduler",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "sku": [
              {
                "@added_28113fc23cd7425aa9535213848b0cb1": {
                  "#name": "redundancyState",
                  "Description": "Indicates whether the current SKU configuration is zone redundant",
                  "Enum": [
                    [
                      "None",
                      "The resource is not redundant"
                    ],
                    [
                      "Zone",
                      "The resource is zone redundant"
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        ],
        "@added_73c932ec54dc47f4ab25d96adc928fd8": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schedulerName:
{
Description: The name of the Scheduler ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: URL of the durable task scheduler ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: SKU of the durable task scheduler ,
Required: False ,
}
{
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy ,
Format: int32 ,
Required: False ,
}
integer ,
redundancyState:
{
Description: Indicates whether the current SKU configuration is zone redundant ,
Enum:
{
None: The resource is not redundant ,
Zone: The resource is zone redundant ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: URL of the durable task scheduler ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR ,
Required: True ,
}
[
string ,
]
,
sku:
{
Description: SKU of the durable task scheduler ,
Required: True ,
}
{
name:
{
Description: The name of the SKU ,
Required: True ,
}
string ,
capacity:
{
Description: The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy ,
Format: int32 ,
Required: False ,
}
integer ,
redundancyState:
{
Description: Indicates whether the current SKU configuration is zone redundant ,
Enum:
{
None: The resource is not redundant ,
Zone: The resource is zone redundant ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}