你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Deployments - List

服务:

Azure AI Services

API 版本:

2024-10-01

获取与认知服务帐户关联的部署。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	认知服务帐户的名称。
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	DeploymentListResult	已成功检索部署。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

示例

ListDeployments

示例请求

HTTP

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

Java

/**
 * Samples for Deployments List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListDeployments.json
     */
    /**
     * Sample code: ListDeployments.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void listDeployments(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.deployments().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_deployments.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.deployments.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/ListDeployments.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/ListDeployments.json
func ExampleDeploymentsClient_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.NewDeploymentsClient().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.DeploymentListResult = armcognitiveservices.DeploymentListResult{
		// 	Value: []*armcognitiveservices.Deployment{
		// 		{
		// 			Name: to.Ptr("deploymentName"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts/deployments"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName"),
		// 			Properties: &armcognitiveservices.DeploymentProperties{
		// 				Model: &armcognitiveservices.DeploymentModel{
		// 					Name: to.Ptr("ada"),
		// 					Format: to.Ptr("OpenAI"),
		// 					Version: to.Ptr("1"),
		// 				},
		// 				ProvisioningState: to.Ptr(armcognitiveservices.DeploymentProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("Standard"),
		// 				Capacity: to.Ptr[int32](1),
		// 			},
		// 	}},
		// }
	}
}

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 deployments associated with the Cognitive Services account.
 *
 * @summary Gets the deployments associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json
 */
async function listDeployments() {
  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.deployments.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/ListDeployments.json
// this example is just showing the usage of "Deployments_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 CognitiveServicesAccountDeploymentResource
CognitiveServicesAccountDeploymentCollection collection = cognitiveServicesAccount.GetCognitiveServicesAccountDeployments();

// invoke the operation and iterate over the result
await foreach (CognitiveServicesAccountDeploymentResource 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
    CognitiveServicesAccountDeploymentData 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/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
      "name": "deploymentName",
      "type": "Microsoft.CognitiveServices/accounts/deployments",
      "sku": {
        "name": "Standard",
        "capacity": 1
      },
      "properties": {
        "model": {
          "format": "OpenAI",
          "name": "ada",
          "version": "1"
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定义

名称	说明
CallRateLimit	调用速率限制认知服务帐户。
createdByType	创建资源的标识的类型。
Deployment	认知服务帐户部署。
DeploymentCapacitySettings	仅供内部使用。
DeploymentListResult	认知服务帐户作响应的列表。
DeploymentModel	认知服务帐户部署模型的属性。
DeploymentModelVersionUpgradeOption	部署模型版本升级选项。
DeploymentProperties	认知服务帐户部署的属性。
DeploymentProvisioningState	获取调用作时资源的状态。
DeploymentScaleSettings	认知服务帐户部署模型的属性。 （已弃用，请改用 Deployment.sku。
DeploymentScaleType	部署缩放类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
RequestMatchPattern
Sku	表示 SKU 的资源模型定义
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
systemData	与创建和上次修改资源相关的元数据。
ThrottlingRule

CallRateLimit

Object

调用速率限制认知服务帐户。

名称	类型	说明
count	number	呼叫速率限制的计数值。
renewalPeriod	number	呼叫速率限制的续订期（以秒为单位）。
rules	ThrottlingRule[]

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

Deployment

Object

认知服务帐户部署。

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

DeploymentCapacitySettings

Object

仅供内部使用。

名称	类型	说明
designatedCapacity	integer (int32) minimum: 0	指定的容量。
priority	integer (int32) minimum: 0	此容量设置的优先级。

DeploymentListResult

Object

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

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

DeploymentModel

Object

认知服务帐户部署模型的属性。

名称	类型	说明
callRateLimit	CallRateLimit	调用速率限制认知服务帐户。
format	string	部署模型格式。
name	string	部署模型名称。
publisher	string	部署模型发布者。
source	string	自选。 部署模型源 ARM 资源 ID。
sourceAccount	string (arm-id)	自选。 模型的源，另一个 Microsoft.CognitiveServices 帐户 ARM 资源 ID。
version	string	自选。 部署模型版本。 如果未指定版本，则会分配默认版本。 对于不同的模型，默认版本不同，当有可用于模型的新版本时，可能会更改。 可以从列表模型 API 找到模型的默认版本。

DeploymentModelVersionUpgradeOption

枚举

部署模型版本升级选项。

值	说明
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

认知服务帐户部署的属性。

名称	类型	说明
callRateLimit	CallRateLimit	调用速率限制认知服务帐户。
capabilities	object	功能。
capacitySettings	DeploymentCapacitySettings	仅供内部使用。
currentCapacity	integer (int32)	当前容量。
dynamicThrottlingEnabled	boolean	如果启用了动态限制。
model	DeploymentModel	认知服务帐户部署模型的属性。
parentDeploymentName	string	父部署的名称。
provisioningState	DeploymentProvisioningState	获取调用作时资源的状态。
raiPolicyName	string	RAI 策略的名称。
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	认知服务帐户部署模型的属性。 （已弃用，请改用 Deployment.sku。
versionUpgradeOption	DeploymentModelVersionUpgradeOption	部署模型版本升级选项。

DeploymentProvisioningState

枚举

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

值	说明
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

认知服务帐户部署模型的属性。 （已弃用，请改用 Deployment.sku。

名称	类型	说明
activeCapacity	integer (int32)	部署活动容量。 如果客户最近更新 capacity，此值可能与 capacity 不同。
capacity	integer (int32)	部署容量。
scaleType	DeploymentScaleType	部署缩放类型。

DeploymentScaleType

枚举

部署缩放类型。

值	说明
Manual
Standard

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

RequestMatchPattern

Object

名称	类型	说明
method	string
path	string

Sku

Object

表示 SKU 的资源模型定义

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

SkuTier

枚举

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

值	说明
Basic
Enterprise
Free
Premium
Standard

systemData

Object

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

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

ThrottlingRule

Object

名称	类型	说明
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number