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

Deployments - List

Service:

Azure AI Services

API Version:

2023-05-01

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

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	认知服务帐户的名称。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	DeploymentListResult	已成功检索部署。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

示例

ListDeployments

Sample Request

HTTP

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

Java

/** Samples for Deployments List. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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/2023-05-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/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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),
		// 				ScaleSettings: &armcognitiveservices.DeploymentScaleSettings{
		// 					Capacity: to.Ptr[int32](1),
		// 					ScaleType: to.Ptr(armcognitiveservices.DeploymentScaleTypeManual),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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/2023-05-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CognitiveServices;
using Azure.ResourceManager.CognitiveServices.Models;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
      "name": "deploymentName",
      "type": "Microsoft.CognitiveServices/accounts/deployments",
      "properties": {
        "model": {
          "format": "OpenAI",
          "name": "ada",
          "version": "1"
        },
        "scaleSettings": {
          "scaleType": "Manual",
          "capacity": 1
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定义

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

CallRateLimit

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

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

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

认知服务帐户部署。

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

DeploymentListResult

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

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

DeploymentModel

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

名称	类型	说明
callRateLimit	CallRateLimit	调用速率限制认知服务帐户。
format	string	部署模型格式。
name	string	部署模型名称。
source	string	可选。 部署模型源 ARM 资源 ID。
version	string	可选。 部署模型版本。 如果未指定版本，则将分配默认版本。 默认版本对于不同的模型是不同的，并且当模型有新版本可用时，可能会更改。 可以从列表模型 API 找到模型的默认版本。

DeploymentModelVersionUpgradeOption

部署模型版本升级选项。

名称	类型	说明
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

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

名称	类型	说明
callRateLimit	CallRateLimit	调用速率限制认知服务帐户。
capabilities	object	功能。
model	DeploymentModel	认知服务帐户部署模型的属性。
provisioningState	DeploymentProvisioningState	获取调用操作时资源的状态。
raiPolicyName	string	RAI 策略的名称。
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	认知服务帐户部署模型的属性。
versionUpgradeOption	DeploymentModelVersionUpgradeOption	部署模型版本升级选项。

DeploymentProvisioningState

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

名称	类型	说明
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

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

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

DeploymentScaleType

部署缩放类型。

名称	类型	说明
Manual	string
Standard	string

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

RequestMatchPattern

名称	类型	说明
method	string
path	string

Sku

表示 SKU 的资源模型定义

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

SkuTier

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

名称	类型	说明
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

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

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

ThrottlingRule

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