Commitment Plans - List Plans By Resource Group

服务:

Azure AI Services

API 版本:

2024-10-01

返回属于资源组的特定类型的所有资源

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	CommitmentPlanListResult	已成功检索承诺计划资源。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。 如果资源组不存在，将返回 404 （NotFound）。

示例

List Commitment Plans by Resource Group

示例请求

HTTP

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans?api-version=2024-10-01

Java

/**
 * Samples for CommitmentPlans ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListSharedCommitmentPlansByResourceGroup.json
     */
    /**
     * Sample code: List Commitment Plans by Resource Group.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void listCommitmentPlansByResourceGroup(
        com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.commitmentPlans().listByResourceGroup("resourceGroupName", 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_resource_group.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="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.commitment_plans.list_plans_by_resource_group(
        resource_group_name="resourceGroupName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.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/ListSharedCommitmentPlansByResourceGroup.json
func ExampleCommitmentPlansClient_NewListPlansByResourceGroupPager() {
	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().NewListPlansByResourceGroupPager("resourceGroupName", 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/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");

/**
 * This sample demonstrates how to Returns all the resources of a particular type belonging to a resource group
 *
 * @summary Returns all the resources of a particular type belonging to a resource group
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json
 */
async function listCommitmentPlansByResourceGroup() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.commitmentPlans.listPlansByResourceGroup(resourceGroupName)) {
    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/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json
// this example is just showing the usage of "CommitmentPlans_ListPlansByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "resourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this CognitiveServicesCommitmentPlanResource
CognitiveServicesCommitmentPlanCollection collection = resourceGroupResource.GetCognitiveServicesCommitmentPlans();

// invoke the operation and iterate over the result
await foreach (CognitiveServicesCommitmentPlanResource 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

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/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"
        }
      }
    }
  ]
}

定义

名称	说明
CommitmentPeriod	认知服务帐户承诺期。
CommitmentPlan	认知服务帐户承诺计划。
CommitmentPlanListResult	认知服务帐户作响应的列表。
CommitmentPlanProperties	认知服务帐户承诺计划的属性。
CommitmentPlanProvisioningState	获取调用作时资源的状态。
CommitmentQuota	认知服务帐户承诺配额。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HostingModel	帐户托管模型。
Sku	表示 SKU 的资源模型定义
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
systemData	与创建和上次修改资源相关的元数据。

CommitmentPeriod

Object

认知服务帐户承诺期。

名称	类型	说明
count	integer (int32)	承诺期承诺计数。
endDate	string	承诺期结束日期。
quota	CommitmentQuota	认知服务帐户承诺配额。
startDate	string	承诺期开始日期。
tier	string	承诺期承诺层。

CommitmentPlan

Object

认知服务帐户承诺计划。

名称	类型	说明
etag	string	资源 Etag。
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	资源的种类。
location	string	资源所在的地理位置
name	string	资源的名称
properties	CommitmentPlanProperties	认知服务帐户承诺计划的属性。
sku	Sku	表示 SKU 的资源模型定义
systemData	systemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

CommitmentPlanListResult

Object

认知服务帐户作响应的列表。

名称	类型	说明
nextLink	string	用于获取 CommitmentPlan 下一页的链接。
value	CommitmentPlan[]	获取认知服务帐户 CommitmentPlan 及其属性的列表。

CommitmentPlanProperties

Object

认知服务帐户承诺计划的属性。

名称	类型	说明
autoRenew	boolean	AutoRenew 承诺计划。
commitmentPlanGuid	string	承诺计划 guid。
current	CommitmentPeriod	认知服务帐户承诺期。
hostingModel	HostingModel	帐户托管模型。
last	CommitmentPeriod	认知服务帐户承诺期。
next	CommitmentPeriod	认知服务帐户承诺期。
planType	string	承诺计划类型。
provisioningIssues	string[]	ProvisioningIssue 的列表。
provisioningState	CommitmentPlanProvisioningState	获取调用作时资源的状态。

CommitmentPlanProvisioningState

枚举

获取调用作时资源的状态。

值	说明
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

CommitmentQuota

Object

认知服务帐户承诺配额。

名称	类型	说明
quantity	integer (int64)	承诺配额数量。
unit	string	承诺配额单位。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

HostingModel

枚举

帐户托管模型。

值	说明
Web
ConnectedContainer
DisconnectedContainer
ProvisionedWeb

Sku

Object

表示 SKU 的资源模型定义

名称	类型	说明
capacity	integer (int32)	如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果资源无法横向扩展/缩小，则可能会省略此范围。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称。 例 - P3。 它通常是字母+数字代码
size	string	SKU 大小。 当名称字段是层和其他一些值的组合时，这将是独立的代码。
tier	SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

SkuTier

枚举

如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

值	说明
Free
Basic
Standard
Premium
Enterprise

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。