Location Based Model Capacities - List

Tjänst:

AI Foundry

API-version:

2025-06-01

Lista platsbaserad ModelCapacities.

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-parametrar

Name	I	Obligatorisk	Typ	Description
location	path	True	string	Resursplats.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
modelFormat	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Modellens format
modelName	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Namnet på modellen
modelVersion	query	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Versionen av modellen

Svar

Name	Typ	Description
200 OK	ModelCapacityListResult	OKEJ. modelCapacities har hämtats efter plats.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

ListLocationBasedModelCapacities

Exempelbegäran

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

Exempelsvar

Statuskod:

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
      }
    }
  ]
}

Definitioner

Name	Description
CallRateLimit	Cognitive Services-kontot för samtalsfrekvensgränsen.
DeploymentModel	Egenskaper för distributionsmodellen för Cognitive Services-kontot.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ModelCapacityListResult	Listan över åtgärdssvar för cognitive services-konton.
ModelSkuCapacityProperties	Cognitive Services-konto ModelSkuCapacity.
RequestMatchPattern
ThrottlingRule
Value	Hämtar listan över Cognitive Services-konton ModelSkuCapacity.

CallRateLimit

Objekt

Cognitive Services-kontot för samtalsfrekvensgränsen.

Name	Typ	Description
count	number	Antalsvärdet för Gräns för samtalsfrekvens.
renewalPeriod	number	Förnyelseperioden i sekunder för samtalsfrekvensgränsen.
rules	ThrottlingRule[]

DeploymentModel

Objekt

Egenskaper för distributionsmodellen för Cognitive Services-kontot.

Name	Typ	Description
callRateLimit	CallRateLimit	Cognitive Services-kontot för samtalsfrekvensgränsen.
format	string	Format för distributionsmodell.
name	string	Namn på distributionsmodell.
publisher	string	Utgivare av distributionsmodell.
source	string	Valfritt. ARM-resurs-ID för distributionsmodellens källa.
sourceAccount	string (arm-id)	Valfritt. Modellens källa, ett annat ARM-resurs-ID för Microsoft.CognitiveServices-konton.
version	string	Valfritt. Version av distributionsmodell. Om version inte anges tilldelas en standardversion. Standardversionen är olika för olika modeller och kan ändras när det finns en ny version tillgänglig för en modell. Standardversionen för en modell kan hittas från API:et för listmodeller.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Information om felet.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

ModelCapacityListResult

Objekt

Listan över åtgärdssvar för cognitive services-konton.

Name	Typ	Description
nextLink	string	Länken som används för att hämta nästa sida i ModelSkuCapacity.
value	Value[]	Hämtar listan över Cognitive Services-konton ModelSkuCapacity.

ModelSkuCapacityProperties

Objekt

Cognitive Services-konto ModelSkuCapacity.

Name	Typ	Description
availableCapacity	number	Den tillgängliga kapaciteten för distribution med den här modellen och SKU:n.
availableFinetuneCapacity	number	Den tillgängliga kapaciteten för distribution med en finjusterad version av den här modellen och SKU:n.
model	DeploymentModel	Egenskaper för distributionsmodellen för Cognitive Services-kontot.
skuName	string

RequestMatchPattern

Objekt

Name	Typ	Description
method	string
path	string

ThrottlingRule

Objekt

Name	Typ	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

Value

Objekt

Hämtar listan över Cognitive Services-konton ModelSkuCapacity.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Platsen för modellens SKU-kapacitet.
name	string	Namnet på resursen
properties	ModelSkuCapacityProperties	Cognitive Services-konto ModelSkuCapacity.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"