Commitment Plans - List

Szolgáltatás:: Microsoft Foundry

API-verzió:: 2025-06-01

Lekéri a Cognitive Services-fiókhoz társított commitmentPlans-t.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	A Cognitive Services-fiók neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	CommitmentPlanListResult	Sikeresen lekérte a commitmentPlans-t.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

ListCommitmentPlans

Mintakérelem

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


/**
 * Samples for CommitmentPlans List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * ListCommitmentPlans.json
     */
    /**
     * Sample code: ListCommitmentPlans.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listCommitmentPlans(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.commitmentPlans().list("resourceGroupName", "accountName", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_commitment_plans.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(
        resource_group_name="resourceGroupName",
        account_name="accountName",
    )
    for item in response:
        print(item)


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

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/ListCommitmentPlans.json
func ExampleCommitmentPlansClient_NewListPager() {
	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().NewListPager("resourceGroupName", "accountName", 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/accounts/commitmentPlans"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName"),
		// 			Properties: &armcognitiveservices.CommitmentPlanProperties{
		// 				AutoRenew: to.Ptr(true),
		// 				Current: &armcognitiveservices.CommitmentPeriod{
		// 					Tier: to.Ptr("T1"),
		// 				},
		// 				HostingModel: to.Ptr(armcognitiveservices.HostingModelWeb),
		// 				PlanType: to.Ptr("Speech2Text"),
		// 			},
		// 	}},
		// }
	}
}

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

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the commitmentPlans associated with the Cognitive Services account.
 *
 * @summary Gets the commitmentPlans associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListCommitmentPlans.json
 */
async function listCommitmentPlans() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.commitmentPlans.list(resourceGroupName, accountName)) {
    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

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.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListCommitmentPlans.json
// this example is just showing the usage of "CommitmentPlans_List" 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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// get the collection of this CommitmentPlanResource
CommitmentPlanCollection collection = cognitiveServicesAccount.GetCommitmentPlans();

// invoke the operation and iterate over the result
await foreach (CommitmentPlanResource item in collection.GetAllAsync())
{
    // 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

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName",
      "name": "commitmentPlanName",
      "type": "Microsoft.CognitiveServices/accounts/commitmentPlans",
      "properties": {
        "hostingModel": "Web",
        "planType": "Speech2Text",
        "autoRenew": true,
        "current": {
          "tier": "T1"
        }
      }
    }
  ]
}

Definíciók

Name	Description
CommitmentPeriod	A Cognitive Services-fiók kötelezettségvállalási időszaka.
CommitmentPlan	Cognitive Services-fiókra vonatkozó kötelezettségvállalási terv.
CommitmentPlanListResult	A Cognitive Services-fiókok műveleti válaszainak listája.
CommitmentPlanProperties	A Cognitive Services-fiók kötelezettségvállalási tervének tulajdonságai.
CommitmentPlanProvisioningState	Lekéri az erőforrás állapotát a művelet meghívásakor.
CommitmentQuota	Cognitive Services-fiókra vonatkozó kötelezettségvállalási kvóta.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
HostingModel	Fiók üzemeltetési modellje.
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

CommitmentPeriod

Tárgy

A Cognitive Services-fiók kötelezettségvállalási időszaka.

Name	Típus	Description
count	integer (int32)	A kötelezettségvállalási időszak kötelezettségvállalásainak száma.
endDate	string	A kötelezettségvállalási időszak záró dátuma.
quota	CommitmentQuota	Cognitive Services-fiókra vonatkozó kötelezettségvállalási kvóta.
startDate	string	A kötelezettségvállalási időszak kezdő dátuma.
tier	string	A kötelezettségvállalási időszak kötelezettségvállalási szintje.

CommitmentPlan

Tárgy

Cognitive Services-fiókra vonatkozó kötelezettségvállalási terv.

Name	Típus	Description
etag	string	Erőforráscímke.
id	string	Az erőforrás teljesen minősített azonosítója. Example - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Az erőforrás típusa.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties	CommitmentPlanProperties	A Cognitive Services-fiók kötelezettségvállalási tervének tulajdonságai.
sku	Sku	A termékváltozatot képviselő erőforrásmodell-definíció
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például: "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

CommitmentPlanListResult

Tárgy

A Cognitive Services-fiókok műveleti válaszainak listája.

Name	Típus	Description
nextLink	string	A link a CommitmentPlan következő oldalának eléréséhez használt.
value	CommitmentPlan[]	Lekéri a Cognitive Services-fiókok listáját CommitmentPlan és azok tulajdonságait.

CommitmentPlanProperties

Tárgy

A Cognitive Services-fiók kötelezettségvállalási tervének tulajdonságai.

Name	Típus	Description
autoRenew	boolean	Automatikus kötelezettségvállalási terv.
commitmentPlanGuid	string	A kötelezettségvállalási terv guid azonosítója.
current	CommitmentPeriod	A Cognitive Services-fiók kötelezettségvállalási időszaka.
hostingModel	HostingModel	Fiók üzemeltetési modellje.
last	CommitmentPeriod	A Cognitive Services-fiók kötelezettségvállalási időszaka.
next	CommitmentPeriod	A Cognitive Services-fiók kötelezettségvállalási időszaka.
planType	string	Kötelezettségvállalási terv típusa.
provisioningIssues	string[]	A ProvisioningIssue listája.
provisioningState	CommitmentPlanProvisioningState	Lekéri az erőforrás állapotát a művelet meghívásakor.

CommitmentPlanProvisioningState

Felsorolás

Lekéri az erőforrás állapotát a művelet meghívásakor.

Érték	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Tárgy

Cognitive Services-fiókra vonatkozó kötelezettségvállalási kvóta.

Name	Típus	Description
quantity	integer (int64)	Kötelezettségvállalási kvóta mennyisége.
unit	string	Kötelezettségvállalási kvóta egysége.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

HostingModel

Felsorolás

Fiók üzemeltetési modellje.

Érték	Description
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Tárgy

A termékváltozatot képviselő erőforrásmodell-definíció

Name	Típus	Description
capacity	integer (int32)	Ha az SKU támogatja a vertikális felskálázást/azt, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforrás esetében nem lehetséges a vertikális felskálázás/beskálázás, akkor ez kihagyható.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, akkor ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuTier

Felsorolás

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Érték	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.