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 參數

名稱	位於	必要	類型	Description
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	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
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"
      }
    }
  ]
}

定義

名稱	Description
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

通話速率限制認知服務帳戶。

名稱	類型	Description
count	number	通話速率限制的計數值。
renewalPeriod	number	通話速率限制秒數的更新期間。
rules	ThrottlingRule[]

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

Deployment

Object

認知服務帳戶部署。

名稱	類型	Description
etag	string	資源 Etag。
id	string	資源的完整資源標識碼。 例如 - /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

僅限內部使用。

名稱	類型	Description
designatedCapacity	integer (int32) minimum: 0	指定的容量。
priority	integer (int32) minimum: 0	此容量設定的優先順序。

DeploymentListResult

Object

認知服務帳戶作業回應的清單。

名稱	類型	Description
nextLink	string	用來取得部署下一頁的連結。
value	Deployment[]	取得認知服務帳戶部署及其屬性的清單。

DeploymentModel

Object

認知服務帳戶部署模型的屬性。

名稱	類型	Description
callRateLimit	CallRateLimit	通話速率限制認知服務帳戶。
format	string	部署模型格式。
name	string	部署模型名稱。
publisher	string	部署模型發行者。
source	string	自選。 部署模型來源 ARM 資源識別碼。
sourceAccount	string (arm-id)	自選。 模型的來源，另一個 Microsoft.CognitiveServices 帳戶 ARM 資源標識符。
version	string	自選。 部署模型版本。 如果未指定版本，則會指派預設版本。 不同模型的預設版本不同，而且當有新版本可供模型使用時，可能會變更。 您可以從清單模型 API 找到模型的預設版本。

DeploymentModelVersionUpgradeOption

列舉型別

部署模型版本升級選項。

值	Description
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

認知服務帳戶部署的屬性。

名稱	類型	Description
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

列舉型別

取得呼叫作業時的資源狀態。

值	Description
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

認知服務帳戶部署模型的屬性。 （已被取代，請改用 Deployment.sku。）

名稱	類型	Description
activeCapacity	integer (int32)	部署作用中容量。 如果客戶最近更新 capacity，這個值可能與 capacity 不同。
capacity	integer (int32)	部署容量。
scaleType	DeploymentScaleType	部署調整類型。

DeploymentScaleType

列舉型別

部署調整類型。

值	Description
Manual
Standard

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

RequestMatchPattern

Object

名稱	類型	Description
method	string
path	string

Sku

Object

代表 SKU 的資源模型定義

名稱	類型	Description
capacity	integer (int32)	如果 SKU 支援相應放大/縮小，則應該包含容量整數。 如果資源無法相應放大/縮小，可能會省略此專案。
family	string	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱。 例如 - P3。 通常是字母+數位碼
size	string	SKU 大小。 當名稱欄位是階層和其他一些值的組合時，這會是獨立程序代碼。
tier	SkuTier	如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

SkuTier

列舉型別

如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

值	Description
Basic
Enterprise
Free
Premium
Standard

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

ThrottlingRule

Object

名稱	類型	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number