Commitment Plans - List Plans By Subscription

서비스:

AI Foundry

API 버전:

2025-06-01

구독에 속하는 특정 형식의 모든 리소스를 반환합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	CommitmentPlanListResult	확정 계획 자원을 검색했습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답

예제

List Accounts by Subscription

샘플 요청

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

샘플 응답

상태 코드:

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

정의

Name	Description
CommitmentPeriod	Cognitive Services 계정 약정 기간입니다.
CommitmentPlan	Cognitive Services 계정 약정 계획입니다.
CommitmentPlanListResult	Cognitive Services 계정 작업 응답 목록입니다.
CommitmentPlanProperties	Cognitive Services 계정 약정 계획의 속성입니다.
CommitmentPlanProvisioningState	작업이 호출된 시점의 리소스 상태를 가져옵니다.
CommitmentQuota	Cognitive Services 계정 약정 할당량입니다.
createdByType	리소스를 만든 ID 유형입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
HostingModel	계정 호스팅 모델.
Sku	SKU를 나타내는 리소스 모델 정의
SkuTier	이 필드는 서비스에 둘 이상의 계층이 있지만 PUT에는 필요하지 않은 경우 리소스 공급자가 구현해야 합니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CommitmentPeriod

Object

Cognitive Services 계정 약정 기간입니다.

Name	형식	Description
count	integer (int32)	약정 기간 약정 횟수입니다.
endDate	string	약정 기간 종료 날짜입니다.
quota	CommitmentQuota	Cognitive Services 계정 약정 할당량입니다.
startDate	string	약정 기간 시작일.
tier	string	약정 기간 약정 계층입니다.

CommitmentPlan

Object

Cognitive Services 계정 약정 계획입니다.

Name	형식	Description
etag	string	리소스 Etag.
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	리소스의 종류입니다.
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties	CommitmentPlanProperties	Cognitive Services 계정 약정 계획의 속성입니다.
sku	Sku	SKU를 나타내는 리소스 모델 정의
systemData	systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

CommitmentPlanListResult

Object

Cognitive Services 계정 작업 응답 목록입니다.

Name	형식	Description
nextLink	string	CommitmentPlan의 다음 페이지를 가져오는 데 사용되는 링크입니다.
value	CommitmentPlan[]	Cognitive Services 계정 CommitmentPlan 및 해당 속성 목록을 가져옵니다.

CommitmentPlanProperties

Object

Cognitive Services 계정 약정 계획의 속성입니다.

Name	형식	Description
autoRenew	boolean	자동 갱신 약정 계획.
commitmentPlanGuid	string	약정 계획 안내.
current	CommitmentPeriod	Cognitive Services 계정 약정 기간입니다.
hostingModel	HostingModel	계정 호스팅 모델.
last	CommitmentPeriod	Cognitive Services 계정 약정 기간입니다.
next	CommitmentPeriod	Cognitive Services 계정 약정 기간입니다.
planType	string	약정 계획 유형입니다.
provisioningIssues	string[]	ProvisioningIssue의 목록입니다.
provisioningState	CommitmentPlanProvisioningState	작업이 호출된 시점의 리소스 상태를 가져옵니다.

CommitmentPlanProvisioningState

열거형

작업이 호출된 시점의 리소스 상태를 가져옵니다.

값	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Object

Cognitive Services 계정 약정 할당량입니다.

Name	형식	Description
quantity	integer (int64)	약정 할당량 수량입니다.
unit	string	약정 할당량 단위입니다.

createdByType

열거형

리소스를 만든 ID 유형입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

HostingModel

열거형

계정 호스팅 모델.

값	Description
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Object

SKU를 나타내는 리소스 모델 정의

Name	형식	Description
capacity	integer (int32)	SKU가 스케일 아웃/인을 지원하는 경우 용량 정수가 포함되어야 합니다. 리소스에 대해 스케일 아웃/인이 불가능한 경우 생략할 수 있습니다.
family	string	서비스에 여러 세대의 하드웨어가 있는 경우 동일한 SKU에 대해 여기에서 캡처할 수 있습니다.
name	string	SKU의 이름입니다. 예 - P3. 일반적으로 letter+number 코드입니다.
size	string	SKU 크기입니다. 이름 필드가 계층과 다른 값의 조합인 경우 독립 실행형 코드입니다.
tier	SkuTier	이 필드는 서비스에 둘 이상의 계층이 있지만 PUT에는 필요하지 않은 경우 리소스 공급자가 구현해야 합니다.

SkuTier

열거형

이 필드는 서비스에 둘 이상의 계층이 있지만 PUT에는 필요하지 않은 경우 리소스 공급자가 구현해야 합니다.

값	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 생성 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.