Models - List

服務:

AI Foundry

API 版本:

2025-06-01

列出模型。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models?api-version=2025-06-01

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string	資源位置。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ModelListResult	OK.
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

範例

ListLocationModels

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models?api-version=2025-06-01

Java

/**
 * Samples for Models List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * ListLocationModels.json
     */
    /**
     * Sample code: ListLocationModels.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listLocationModels(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.models().list("WestUS", 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_location_models.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.models.list(
        location="WestUS",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListLocationModels.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1004eed4202d64b48157c084fe2830760f8190f4/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListLocationModels.json
func ExampleModelsClient_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.NewModelsClient().NewListPager("WestUS", 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.ModelListResult = armcognitiveservices.ModelListResult{
		// 	Value: []*armcognitiveservices.Model{
		// 		{
		// 			Kind: to.Ptr("OpenAI"),
		// 			Model: &armcognitiveservices.AccountModel{
		// 				Name: to.Ptr("ada"),
		// 				Format: to.Ptr("OpenAI"),
		// 				Version: to.Ptr("1"),
		// 				Capabilities: map[string]*string{
		// 					"FineTuneTokensMaxValue": to.Ptr("37500000"),
		// 					"completion": to.Ptr("true"),
		// 					"fineTune": to.Ptr("true"),
		// 					"inference": to.Ptr("false"),
		// 					"scaleType": to.Ptr("Manual"),
		// 					"search": to.Ptr("true"),
		// 				},
		// 				Deprecation: &armcognitiveservices.ModelDeprecationInfo{
		// 					FineTune: to.Ptr("2024-01-01T00:00:00Z"),
		// 					Inference: to.Ptr("2024-01-01T00:00:00Z"),
		// 				},
		// 				FinetuneCapabilities: map[string]*string{
		// 					"FineTuneTokensMaxValue": to.Ptr("37500000"),
		// 					"completion": to.Ptr("true"),
		// 					"fineTune": to.Ptr("true"),
		// 					"inference": to.Ptr("false"),
		// 					"scaleType": to.Ptr("Manual,Standard"),
		// 					"search": to.Ptr("true"),
		// 				},
		// 				LifecycleStatus: to.Ptr(armcognitiveservices.ModelLifecycleStatusPreview),
		// 				MaxCapacity: to.Ptr[int32](3),
		// 				SKUs: []*armcognitiveservices.ModelSKU{
		// 					{
		// 						Name: to.Ptr("provisioned"),
		// 						Capacity: &armcognitiveservices.CapacityConfig{
		// 							Default: to.Ptr[int32](100),
		// 							Maximum: to.Ptr[int32](1000),
		// 							Minimum: to.Ptr[int32](100),
		// 							Step: to.Ptr[int32](100),
		// 						},
		// 						UsageName: to.Ptr("OpenAI.Provisioned.Class1"),
		// 				}},
		// 				SystemData: &armcognitiveservices.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-07T00:00:00.000Z"); return t}()),
		// 					CreatedBy: to.Ptr("Microsoft"),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-07T00:00:00.000Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("Microsoft"),
		// 				},
		// 			},
		// 			SKUName: 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");
require("dotenv/config");

/**
 * This sample demonstrates how to List Models.
 *
 * @summary List Models.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListLocationModels.json
 */
async function listLocationModels() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "WestUS";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.models.list(location)) {
    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/2025-06-01/examples/ListLocationModels.json
// this example is just showing the usage of "Models_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("WestUS");
await foreach (CognitiveServicesModel item in subscriptionResource.GetModelsAsync(location))
{
    Console.WriteLine($"Succeeded: {item}");
}

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": [
    {
      "kind": "OpenAI",
      "skuName": "S0",
      "model": {
        "format": "OpenAI",
        "name": "ada",
        "version": "1",
        "maxCapacity": 3,
        "capabilities": {
          "fineTune": "true",
          "inference": "false",
          "scaleType": "Manual",
          "completion": "true",
          "search": "true",
          "FineTuneTokensMaxValue": "37500000"
        },
        "finetuneCapabilities": {
          "fineTune": "true",
          "inference": "false",
          "scaleType": "Manual,Standard",
          "completion": "true",
          "search": "true",
          "FineTuneTokensMaxValue": "37500000"
        },
        "deprecation": {
          "fineTune": "2024-01-01T00:00:00Z",
          "inference": "2024-01-01T00:00:00Z"
        },
        "lifecycleStatus": "Preview",
        "systemData": {
          "createdBy": "Microsoft",
          "createdAt": "2021-10-07T00:00:00Z",
          "lastModifiedBy": "Microsoft",
          "lastModifiedAt": "2021-10-07T00:00:00Z"
        },
        "skus": [
          {
            "name": "provisioned",
            "usageName": "OpenAI.Provisioned.Class1",
            "capacity": {
              "minimum": 100,
              "maximum": 1000,
              "step": 100,
              "default": 100
            }
          }
        ]
      }
    }
  ]
}

定義

名稱	Description
AccountModel	認知服務帳戶模型。
BillingMeterInfo
CallRateLimit	呼叫速率限制認知服務帳戶。
CapacityConfig	容量組態。
createdByType	建立資源的身分類型。
DeploymentModel	認知服務帳戶部署模型的屬性。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Model	認知服務模型。
ModelDeprecationInfo	認知服務帳戶 ModelDeprecationInfo。
ModelLifecycleStatus	模型生命週期狀態。
ModelListResult	認知服務模型的清單。
ModelSku	描述可用的認知服務模型 SKU。
RequestMatchPattern
systemData	與建立和上次修改資源相關的元數據。
ThrottlingRule

AccountModel

Object

認知服務帳戶模型。

名稱	類型	Description
baseModel	DeploymentModel	認知服務帳戶部署模型的屬性。
callRateLimit	CallRateLimit	呼叫速率限制認知服務帳戶。
capabilities	object	能力。
deprecation	ModelDeprecationInfo	認知服務帳戶 ModelDeprecationInfo。
finetuneCapabilities	object	微調模型的功能。
format	string	部署模型格式。
isDefaultVersion	boolean	如果模型是預設版本。
lifecycleStatus	ModelLifecycleStatus	模型生命週期狀態。
maxCapacity	integer (int32)	最大容量。
name	string	部署模型名稱。
publisher	string	部署模型發行者。
skus	ModelSku[]	型號 SKU 的列表。
source	string	選擇性。 部署模型來源 ARM 資源識別碼。
sourceAccount	string (arm-id)	選擇性。 模型的來源，另一個 Microsoft.CognitiveServices 帳戶 ARM 資源識別碼。
systemData	systemData	與建立和上次修改資源相關的元數據。
version	string	選擇性。 部署模型版本。 如果未指定版本，則會指派預設版本。 不同型號的預設版本不同，當模型有可用的新版本時，可能會變更。 您可以從清單模型 API 找到模型的預設版本。

BillingMeterInfo

Object

名稱	類型	Description
meterId	string
name	string
unit	string

CallRateLimit

Object

呼叫速率限制認知服務帳戶。

名稱	類型	Description
count	number	呼叫速率限制的計數值。
renewalPeriod	number	通話速率限制的續約週期（以秒為單位）。
rules	ThrottlingRule[]

CapacityConfig

Object

容量組態。

名稱	類型	Description
allowedValues	integer[] (int32)	容量允許的值陣列。
default	integer (int32)	預設容量。
maximum	integer (int32)	最大容量。
minimum	integer (int32)	最小容量。
step	integer (int32)	容量允許值之間的最小增量。

createdByType

列舉型別

建立資源的身分類型。

值	Description
User
Application
ManagedIdentity
Key

DeploymentModel

Object

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

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

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 物件。

Model

Object

認知服務模型。

名稱	類型	Description
description	string	模型的描述。
kind	string	認知服務帳戶的種類 （類型）。
model	AccountModel	認知服務帳戶模型。
skuName	string	SKU 的名稱。

ModelDeprecationInfo

Object

認知服務帳戶 ModelDeprecationInfo。

名稱	類型	Description
fineTune	string	fineTune 模型淘汰的日期時間。
inference	string	推論模型取代的日期時間。

ModelLifecycleStatus

列舉型別

模型生命週期狀態。

值	Description
Stable
Preview
GenerallyAvailable
Deprecating
Deprecated

ModelListResult

Object

認知服務模型的清單。

名稱	類型	Description
nextLink	string	用於獲取模型下一頁的鏈接。
value	Model[]	取得認知服務帳戶模型及其屬性的清單。

ModelSku

Object

描述可用的認知服務模型 SKU。

名稱	類型	Description
capacity	CapacityConfig	容量組態。
cost	BillingMeterInfo[]	計費計量資訊清單。
deprecationDate	string (date-time)	模型 SKU 淘汰的日期時間。
name	string	模型 SKU 的名稱。
rateLimits	CallRateLimit[]	rateLimit 的清單。
usageName	string	模型 SKU 的使用名稱。

RequestMatchPattern

Object

名稱	類型	Description
method	string
path	string

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