Commitment Plans - List

Service:

Azure AI Services

API Version:

2024-10-01

Gets the commitmentPlans associated with the Cognitive Services account.

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	The name of Cognitive Services account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CommitmentPlanListResult	Successfully retrieved commitmentPlans.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ListCommitmentPlans

Sample request

HTTP

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

Java

/**
 * Samples for CommitmentPlans List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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

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_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="subscriptionId",
    )

    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/2024-10-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

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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

JavaScript

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

/**
 * 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/2024-10-01/examples/ListCommitmentPlans.json
 */
async function listCommitmentPlans() {
  const subscriptionId = process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "subscriptionId";
  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 (let 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

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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 = "subscriptionId";
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

Sample response

Status code:

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

Definitions

Name	Description
CommitmentPeriod	Cognitive Services account commitment period.
CommitmentPlan	Cognitive Services account commitment plan.
CommitmentPlanListResult	The list of cognitive services accounts operation response.
CommitmentPlanProperties	Properties of Cognitive Services account commitment plan.
CommitmentPlanProvisioningState	Gets the status of the resource at the time the operation was called.
CommitmentQuota	Cognitive Services account commitment quota.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HostingModel	Account hosting model.
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.

CommitmentPeriod

Object

Cognitive Services account commitment period.

Name	Type	Description
count	integer (int32)	Commitment period commitment count.
endDate	string	Commitment period end date.
quota	CommitmentQuota	Cognitive Services account commitment quota.
startDate	string	Commitment period start date.
tier	string	Commitment period commitment tier.

CommitmentPlan

Object

Cognitive Services account commitment plan.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	The Kind of the resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	CommitmentPlanProperties	Properties of Cognitive Services account commitment plan.
sku	Sku	The resource model definition representing SKU
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CommitmentPlanListResult

Object

The list of cognitive services accounts operation response.

Name	Type	Description
nextLink	string	The link used to get the next page of CommitmentPlan.
value	CommitmentPlan[]	Gets the list of Cognitive Services accounts CommitmentPlan and their properties.

CommitmentPlanProperties

Object

Properties of Cognitive Services account commitment plan.

Name	Type	Description
autoRenew	boolean	AutoRenew commitment plan.
commitmentPlanGuid	string	Commitment plan guid.
current	CommitmentPeriod	Cognitive Services account commitment period.
hostingModel	HostingModel	Account hosting model.
last	CommitmentPeriod	Cognitive Services account commitment period.
next	CommitmentPeriod	Cognitive Services account commitment period.
planType	string	Commitment plan type.
provisioningIssues	string[]	The list of ProvisioningIssue.
provisioningState	CommitmentPlanProvisioningState	Gets the status of the resource at the time the operation was called.

CommitmentPlanProvisioningState

Enumeration

Gets the status of the resource at the time the operation was called.

Value	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Object

Cognitive Services account commitment quota.

Name	Type	Description
quantity	integer (int64)	Commitment quota quantity.
unit	string	Commitment quota unit.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HostingModel

Enumeration

Account hosting model.

Value	Description
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.