Location Based Model Capacities - List

Hizmet:

AI Foundry

API Sürümü:

2025-06-01

Konum tabanlı ModelCapacitys'i listeleyin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
location	path	True	string	Kaynak konumu.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
modelFormat	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Modelin biçimi
modelName	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Modelin adı
modelVersion	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Modelin sürümü

Yanıtlar

Name	Tür	Description
200 OK	ModelCapacityListResult	OK. Konuma göre modelCapacity'ler başarıyla alındı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

ListLocationBasedModelCapacities

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/modelCapacities?api-version=2025-06-01&modelFormat=OpenAI&modelName=ada&modelVersion=1

Java

/**
 * Samples for LocationBasedModelCapacities List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * ListLocationBasedModelCapacities.json
     */
    /**
     * Sample code: ListLocationBasedModelCapacities.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listLocationBasedModelCapacities(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.locationBasedModelCapacities().list("WestUS", "OpenAI", "ada", "1", 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_based_model_capacities.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.location_based_model_capacities.list(
        location="WestUS",
        model_format="OpenAI",
        model_name="ada",
        model_version="1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListLocationBasedModelCapacities.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/ListLocationBasedModelCapacities.json
func ExampleLocationBasedModelCapacitiesClient_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.NewLocationBasedModelCapacitiesClient().NewListPager("WestUS", "OpenAI", "ada", "1", 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.ModelCapacityListResult = armcognitiveservices.ModelCapacityListResult{
		// 	Value: []*armcognitiveservices.ModelCapacityListResultValueItem{
		// 		{
		// 			Name: to.Ptr("Standard"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/locations/models/skuCapacities"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard"),
		// 			Location: to.Ptr("WestUS"),
		// 			Properties: &armcognitiveservices.ModelSKUCapacityProperties{
		// 				AvailableCapacity: to.Ptr[float32](300),
		// 				AvailableFinetuneCapacity: to.Ptr[float32](20),
		// 				Model: &armcognitiveservices.DeploymentModel{
		// 					Name: to.Ptr("ada"),
		// 					Format: to.Ptr("OpenAI"),
		// 					Version: to.Ptr("1"),
		// 				},
		// 				SKUName: to.Ptr("Standard"),
		// 			},
		// 	}},
		// }
	}
}

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 Location Based ModelCapacities.
 *
 * @summary List Location Based ModelCapacities.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ListLocationBasedModelCapacities.json
 */
async function listLocationBasedModelCapacities() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "WestUS";
  const modelFormat = "OpenAI";
  const modelName = "ada";
  const modelVersion = "1";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.locationBasedModelCapacities.list(
    location,
    modelFormat,
    modelName,
    modelVersion,
  )) {
    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/ListLocationBasedModelCapacities.json
// this example is just showing the usage of "LocationBasedModelCapacities_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");
string modelFormat = "OpenAI";
string modelName = "ada";
string modelVersion = "1";
await foreach (ModelCapacityListResultValueItem item in subscriptionResource.GetLocationBasedModelCapacitiesAsync(location, modelFormat, modelName, modelVersion))
{
    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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard",
      "type": "Microsoft.CognitiveServices/locations/models/skuCapacities",
      "name": "Standard",
      "location": "WestUS",
      "properties": {
        "model": {
          "format": "OpenAI",
          "name": "ada",
          "version": "1"
        },
        "skuName": "Standard",
        "availableCapacity": 300,
        "availableFinetuneCapacity": 20
      }
    }
  ]
}

Tanımlar

Name	Description
CallRateLimit	Çağrı hızı sınırı Bilişsel Hizmetler hesabı.
DeploymentModel	Bilişsel Hizmetler hesap dağıtım modelinin özellikleri.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ModelCapacityListResult	Bilişsel hizmetler hesapları işlem yanıtının listesi.
ModelSkuCapacityProperties	Bilişsel Hizmetler hesabı ModelSkuCapacity.
RequestMatchPattern
ThrottlingRule
Value	Bilişsel Hizmetler hesaplarının listesini alır ModelSkuCapacity.

CallRateLimit

Nesne

Çağrı hızı sınırı Bilişsel Hizmetler hesabı.

Name	Tür	Description
count	number	Çağrı Hızı Sınırı'nın sayı değeri.
renewalPeriod	number	Çağrı Hızı Sınırının saniye cinsinden yenileme süresi.
rules	ThrottlingRule[]

DeploymentModel

Nesne

Bilişsel Hizmetler hesap dağıtım modelinin özellikleri.

Name	Tür	Description
callRateLimit	CallRateLimit	Çağrı hızı sınırı Bilişsel Hizmetler hesabı.
format	string	Dağıtım modeli biçimi.
name	string	Dağıtım modeli adı.
publisher	string	Dağıtım modeli yayımcısı.
source	string	Optional. Dağıtım modeli kaynağı ARM kaynak kimliği.
sourceAccount	string (arm-id)	Optional. Modelin kaynağı, başka bir Microsoft.CognitiveServices hesapları ARM kaynak kimliği.
version	string	Optional. Dağıtım modeli sürümü. Sürüm belirtilmezse, varsayılan bir sürüm atanır. Varsayılan sürüm, farklı modeller için farklıdır ve bir model için yeni sürüm mevcut olduğunda değişebilir. Bir model için varsayılan sürüm, liste modelleri API'sinden bulunabilir.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgi.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ModelCapacityListResult

Nesne

Bilişsel hizmetler hesapları işlem yanıtının listesi.

Name	Tür	Description
nextLink	string	ModelSkuCapacity'nin sonraki sayfasını almak için kullanılan bağlantı.
value	Value[]	Bilişsel Hizmetler hesaplarının listesini alır ModelSkuCapacity.

ModelSkuCapacityProperties

Nesne

Bilişsel Hizmetler hesabı ModelSkuCapacity.

Name	Tür	Description
availableCapacity	number	Bu model ve SKU ile dağıtım için kullanılabilir kapasite.
availableFinetuneCapacity	number	Bu modelin ve SKU'nun ince ayar sürümüyle dağıtım için kullanılabilir kapasite.
model	DeploymentModel	Bilişsel Hizmetler hesap dağıtım modelinin özellikleri.
skuName	string

RequestMatchPattern

Nesne

Name	Tür	Description
method	string
path	string

ThrottlingRule

Nesne

Name	Tür	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

Value

Nesne

Bilişsel Hizmetler hesaplarının listesini alır ModelSkuCapacity.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Model Sku Kapasitesinin konumu.
name	string	Kaynağın adı
properties	ModelSkuCapacityProperties	Bilişsel Hizmetler hesabı ModelSkuCapacity.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"