Schedulers - List By Subscription

Servicio:

Durable Task Scheduler

Versión de la API:

2025-04-01-preview

Enumerar programadores por suscripción

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DurableTask/schedulers?api-version=2025-04-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	SchedulerListResult	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Schedulers_ListBySubscription

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/providers/Microsoft.DurableTask/schedulers?api-version=2025-04-01-preview

Java

/**
 * Samples for Schedulers List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-04-01-preview/Schedulers_ListBySubscription.json
     */
    /**
     * Sample code: Schedulers_ListBySubscription.
     * 
     * @param manager Entry point to DurableTaskManager.
     */
    public static void schedulersListBySubscription(com.azure.resourcemanager.durabletask.DurableTaskManager manager) {
        manager.schedulers().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.durabletask import DurableTaskMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-durabletask
# USAGE
    python schedulers_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DurableTaskMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.schedulers.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: 2025-04-01-preview/Schedulers_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdurabletask_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/durabletask/armdurabletask"
)

// Generated from example definition: 2025-04-01-preview/Schedulers_ListBySubscription.json
func ExampleSchedulersClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdurabletask.NewClientFactory("EE9BD735-67CE-4A90-89C4-439D3F6A4C93", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSchedulersClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armdurabletask.SchedulersClientListBySubscriptionResponse{
		// 	SchedulerListResult: armdurabletask.SchedulerListResult{
		// 		Value: []*armdurabletask.Scheduler{
		// 			{
		// 				ID: to.Ptr("/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler"),
		// 				Location: to.Ptr("northcentralus"),
		// 				Properties: &armdurabletask.SchedulerProperties{
		// 					ProvisioningState: to.Ptr(armdurabletask.ProvisioningStateSucceeded),
		// 					Endpoint: to.Ptr("https://test.northcentralus.1.durabletask.io"),
		// 					IPAllowlist: []*string{
		// 						to.Ptr("10.0.0.0/8"),
		// 					},
		// 					SKU: &armdurabletask.SchedulerSKU{
		// 						Name: to.Ptr("Dedicated"),
		// 						Capacity: to.Ptr[int32](3),
		// 						RedundancyState: to.Ptr(armdurabletask.RedundancyStateZone),
		// 					},
		// 				},
		// 				Tags: map[string]*string{
		// 					"department": to.Ptr("research"),
		// 					"development": to.Ptr("true"),
		// 				},
		// 				Name: to.Ptr("testscheduler"),
		// 				Type: to.Ptr("Microsoft.DurableTask/schedulers"),
		// 				SystemData: &armdurabletask.SystemData{
		// 					CreatedBy: to.Ptr("tenmbevaunjzikxowqexrsx"),
		// 					CreatedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-17T15:34:17.365Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("xfvdcegtj"),
		// 					LastModifiedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-17T15:34:17.366Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DurableTaskClient } = require("@azure/arm-durabletask");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list Schedulers by subscription
 *
 * @summary list Schedulers by subscription
 * x-ms-original-file: 2025-04-01-preview/Schedulers_ListBySubscription.json
 */
async function schedulersListBySubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "EE9BD735-67CE-4A90-89C4-439D3F6A4C93";
  const client = new DurableTaskClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.schedulers.listBySubscription()) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DurableTask;

// Generated from example definition: 2025-04-01-preview/Schedulers_ListBySubscription.json
// this example is just showing the usage of "Scheduler_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "EE9BD735-67CE-4A90-89C4-439D3F6A4C93";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (DurableTaskSchedulerResource item in subscriptionResource.GetDurableTaskSchedulersAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DurableTaskSchedulerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler",
      "location": "northcentralus",
      "properties": {
        "provisioningState": "Succeeded",
        "endpoint": "https://test.northcentralus.1.durabletask.io",
        "ipAllowlist": [
          "10.0.0.0/8"
        ],
        "sku": {
          "name": "Dedicated",
          "capacity": 3,
          "redundancyState": "Zone"
        }
      },
      "tags": {
        "department": "research",
        "development": "true"
      },
      "name": "testscheduler",
      "type": "Microsoft.DurableTask/schedulers",
      "systemData": {
        "createdBy": "tenmbevaunjzikxowqexrsx",
        "createdByType": "User",
        "createdAt": "2024-04-17T15:34:17.365Z",
        "lastModifiedBy": "xfvdcegtj",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-04-17T15:34:17.366Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado de la operación actual
RedundancyState	Estado de la redundancia del recurso
Scheduler	Un recurso del Programador de tareas duradera
SchedulerListResult	Respuesta de una operación de lista scheduler.
SchedulerProperties	Detalles del programador
SchedulerSku	La SKU (unidad de mantenimiento de existencias) asignada a este programador de tareas duradero
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Enumeración

Estado de la operación actual

Valor	Description
Accepted	Se ha aceptado la solicitud de creación de recursos.
Canceled	Se canceló la creación de recursos.
Deleting	El recurso se está eliminando.
Failed	Error en la creación de recursos.
Provisioning	El recurso se está aprovisionando.
Succeeded	Se ha creado el recurso.
Updating	El recurso se está actualizando

RedundancyState

Enumeración

Estado de la redundancia del recurso

Valor	Description
None	El recurso no es redundante
Zone	El recurso es redundante de zona

Scheduler

Object

Un recurso del Programador de tareas duradera

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties	SchedulerProperties	Propiedades específicas del recurso para este recurso.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SchedulerListResult

Object

Respuesta de una operación de lista scheduler.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Scheduler[]	Elementos de Scheduler de esta página

SchedulerProperties

Object

Detalles del programador

Nombre	Tipo	Description
endpoint	string	Dirección URL del programador de tareas durable
ipAllowlist	string[]	Lista de direcciones IP permitidas para el programador de tareas duradero. Los valores pueden ser IPv4, IPv6 o CIDR
provisioningState	ProvisioningState	Estado de la última operación
sku	SchedulerSku	SKU del programador de tareas durable

SchedulerSku

Object

La SKU (unidad de mantenimiento de existencias) asignada a este programador de tareas duradero

Nombre	Tipo	Description
capacity	integer (int32)	Capacidad de SKU. Esto permite el escalado horizontal o horizontal para el recurso y afecta a la redundancia de zona.
name	string	Nombre de la SKU
redundancyState	RedundancyState	Indica si la configuración actual de la SKU es redundante de zona.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.