Commitment Plans - List Plans By Subscription

Hizmet:

AI Foundry

API Sürümü:

2025-06-01

Bir aboneliğe ait belirli bir türdeki tüm kaynakları döndürür.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	CommitmentPlanListResult	Taahhüt planı kaynakları başarıyla alındı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı

Örnekler

List Accounts by Subscription

Örnek isteği

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

Örnek yanıt

Durum kodu:

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"
        }
      }
    }
  ]
}

Tanımlar

Name	Description
CommitmentPeriod	Bilişsel Hizmetler hesap taahhüt süresi.
CommitmentPlan	Bilişsel Hizmetler hesap taahhüt planı.
CommitmentPlanListResult	Bilişsel hizmetler hesapları işlem yanıtının listesi.
CommitmentPlanProperties	Bilişsel Hizmetler hesap taahhüt planının özellikleri.
CommitmentPlanProvisioningState	İşlemin çağrıldığı sırada kaynağın durumunu alır.
CommitmentQuota	Bilişsel Hizmetler hesap taahhüdü kotası.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
HostingModel	Hesap barındırma modeli.
Sku	SKU'yu temsil eden kaynak modeli tanımı
SkuTier	Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CommitmentPeriod

Nesne

Bilişsel Hizmetler hesap taahhüt süresi.

Name	Tür	Description
count	integer (int32)	Taahhüt süresi taahhüt sayısı.
endDate	string	Taahhüt süresi bitiş tarihi.
quota	CommitmentQuota	Bilişsel Hizmetler hesap taahhüdü kotası.
startDate	string	Taahhüt dönemi başlangıç tarihi.
tier	string	Taahhüt dönemi taahhüt katmanı.

CommitmentPlan

Nesne

Bilişsel Hizmetler hesap taahhüt planı.

Name	Tür	Description
etag	string	Kaynak Etag'i.
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Kaynağın türü.
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties	CommitmentPlanProperties	Bilişsel Hizmetler hesap taahhüt planının özellikleri.
sku	Sku	SKU'yu temsil eden kaynak modeli tanımı
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

CommitmentPlanListResult

Nesne

Bilişsel hizmetler hesapları işlem yanıtının listesi.

Name	Tür	Description
nextLink	string	CommitmentPlan'in bir sonraki sayfasını almak için kullanılan bağlantı.
value	CommitmentPlan[]	Bilişsel Hizmetler hesaplarının, CommitmentPlan'ın ve özelliklerinin listesini alır.

CommitmentPlanProperties

Nesne

Bilişsel Hizmetler hesap taahhüt planının özellikleri.

Name	Tür	Description
autoRenew	boolean	Otomatik Yenileme taahhüt planı.
commitmentPlanGuid	string	Taahhüt planı kılavuzu.
current	CommitmentPeriod	Bilişsel Hizmetler hesap taahhüt süresi.
hostingModel	HostingModel	Hesap barındırma modeli.
last	CommitmentPeriod	Bilişsel Hizmetler hesap taahhüt süresi.
next	CommitmentPeriod	Bilişsel Hizmetler hesap taahhüt süresi.
planType	string	Taahhüt planı türü.
provisioningIssues	string[]	ProvisioningIssue listesi.
provisioningState	CommitmentPlanProvisioningState	İşlemin çağrıldığı sırada kaynağın durumunu alır.

CommitmentPlanProvisioningState

Numaralandırma

İşlemin çağrıldığı sırada kaynağın durumunu alır.

Değer	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Nesne

Bilişsel Hizmetler hesap taahhüdü kotası.

Name	Tür	Description
quantity	integer (int64)	Taahhüt kotası miktarı.
unit	string	Taahhüt kotası birimi.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgi.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

HostingModel

Numaralandırma

Hesap barındırma modeli.

Değer	Description
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Nesne

SKU'yu temsil eden kaynak modeli tanımı

Name	Tür	Description
capacity	integer (int32)	SKU ölçeği genişletmeyi/genişletmeyi destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir.
family	string	Hizmetin aynı SKU için farklı donanım nesilleri varsa, bu burada yakalanabilir.
name	string	SKU'nun adı. Eski - P3. Bu genellikle bir harf+sayı kodudur
size	string	SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olacaktır.
tier	SkuTier	Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

SkuTier

Numaralandırma

Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

Değer	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma zaman damgası (UTC).
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynak son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.