Commitment Plans - List Plans By Subscription

Servicio:

AI Foundry

Versión de la API:

2025-06-01

Devuelve todos los recursos de un tipo determinado que pertenecen a una suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans?api-version=2025-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
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	CommitmentPlanListResult	Recuperación correcta de los recursos del plan de compromisos.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué falló la operación

Ejemplos

List Accounts by Subscription

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/commitmentPlans?api-version=2025-06-01

Java

/**
 * Samples for CommitmentPlans ListPlansBySubscription.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * ListSharedCommitmentPlansBySubscription.json
     */
    /**
     * Sample code: List Accounts by Subscription.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listAccountsBySubscription(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.commitmentPlans().listPlansBySubscription(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.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_shared_commitment_plans_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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.commitment_plans.list_plans_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListSharedCommitmentPlansBySubscription.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 armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1004eed4202d64b48157c084fe2830760f8190f4/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListSharedCommitmentPlansBySubscription.json
func ExampleCommitmentPlansClient_NewListPlansBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCommitmentPlansClient().NewListPlansBySubscriptionPager(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.CommitmentPlanListResult = armcognitiveservices.CommitmentPlanListResult{
		// 	Value: []*armcognitiveservices.CommitmentPlan{
		// 		{
		// 			Name: to.Ptr("commitmentPlanName"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/commitmentPlans"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName"),
		// 			Kind: to.Ptr("SpeechServices"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armcognitiveservices.CommitmentPlanProperties{
		// 				AutoRenew: to.Ptr(true),
		// 				Current: &armcognitiveservices.CommitmentPeriod{
		// 					Tier: to.Ptr("T1"),
		// 				},
		// 				HostingModel: to.Ptr(armcognitiveservices.HostingModelWeb),
		// 				PlanType: to.Ptr("STT"),
		// 				ProvisioningState: to.Ptr(armcognitiveservices.CommitmentPlanProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("S0"),
		// 			},
		// 	}},
		// }
	}
}

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 { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Returns all the resources of a particular type belonging to a subscription.
 *
 * @summary Returns all the resources of a particular type belonging to a subscription.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListSharedCommitmentPlansBySubscription.json
 */
async function listAccountsBySubscription() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.commitmentPlans.listPlansBySubscription()) {
    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.CognitiveServices.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListSharedCommitmentPlansBySubscription.json
// this example is just showing the usage of "CommitmentPlans_ListPlansBySubscription" 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 = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (CognitiveServicesCommitmentPlanResource item in subscriptionResource.GetCognitiveServicesCommitmentPlansAsync())
{
    // 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
    CommitmentPlanData 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/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName",
      "name": "commitmentPlanName",
      "type": "Microsoft.CognitiveServices/commitmentPlans",
      "location": "West US",
      "sku": {
        "name": "S0"
      },
      "kind": "SpeechServices",
      "properties": {
        "provisioningState": "Succeeded",
        "hostingModel": "Web",
        "planType": "STT",
        "autoRenew": true,
        "current": {
          "tier": "T1"
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
CommitmentPeriod	Período de compromiso de la cuenta de Cognitive Services.
CommitmentPlan	Plan de compromiso de cuenta de Cognitive Services.
CommitmentPlanListResult	La lista de respuestas de operación de cuentas de servicios cognitivos.
CommitmentPlanProperties	Propiedades del plan de compromiso de cuenta de Cognitive Services.
CommitmentPlanProvisioningState	Obtiene el estado del recurso en el momento en que se llamó a la operación.
CommitmentQuota	Cuota de compromiso de cuenta de Cognitive Services.
createdByType	El 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
HostingModel	Modelo de alojamiento de cuentas.
Sku	La definición del modelo de recursos que representa SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CommitmentPeriod

Objeto

Período de compromiso de la cuenta de Cognitive Services.

Nombre	Tipo	Description
count	integer (int32)	Recuento de compromisos del período de compromiso.
endDate	string	Fecha de finalización del período de compromiso.
quota	CommitmentQuota	Cuota de compromiso de cuenta de Cognitive Services.
startDate	string	Fecha de inicio del período de compromiso.
tier	string	Nivel de compromiso del período de compromiso.

CommitmentPlan

Objeto

Plan de compromiso de cuenta de Cognitive Services.

Nombre	Tipo	Description
etag	string	Etag de recursos.
id	string	Identificador de recurso completo para el recurso. Ej: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	El tipo de recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties	CommitmentPlanProperties	Propiedades del plan de compromiso de cuenta de Cognitive Services.
sku	Sku	La definición del modelo de recursos que representa SKU
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

CommitmentPlanListResult

Objeto

La lista de respuestas de operación de cuentas de servicios cognitivos.

Nombre	Tipo	Description
nextLink	string	El enlace utilizado para obtener la siguiente página de CommitmentPlan.
value	CommitmentPlan[]	Obtiene la lista de cuentas de Cognitive Services CommitmentPlan y sus propiedades.

CommitmentPlanProperties

Objeto

Propiedades del plan de compromiso de cuenta de Cognitive Services.

Nombre	Tipo	Description
autoRenew	boolean	Plan de compromiso de renovación automática.
commitmentPlanGuid	string	Guid del plan de compromiso.
current	CommitmentPeriod	Período de compromiso de la cuenta de Cognitive Services.
hostingModel	HostingModel	Modelo de alojamiento de cuentas.
last	CommitmentPeriod	Período de compromiso de la cuenta de Cognitive Services.
next	CommitmentPeriod	Período de compromiso de la cuenta de Cognitive Services.
planType	string	Tipo de plan de compromiso.
provisioningIssues	string[]	La lista de ProvisioningIssue.
provisioningState	CommitmentPlanProvisioningState	Obtiene el estado del recurso en el momento en que se llamó a la operación.

CommitmentPlanProvisioningState

Enumeración

Obtiene el estado del recurso en el momento en que se llamó a la operación.

Valor	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Objeto

Cuota de compromiso de cuenta de Cognitive Services.

Nombre	Tipo	Description
quantity	integer (int64)	Cantidad de cuota comprometida.
unit	string	Unidad de cuota comprometida.

createdByType

Enumeración

El tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HostingModel

Enumeración

Modelo de alojamiento de cuentas.

Valor	Description
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Objeto

La definición del modelo de recursos que representa SKU

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Objeto

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

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