Deployments - List Skus

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-10-01

Zobrazí seznam zadaných skladových položek nasazení přidružených k účtu služeb Cognitive Services.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Název účtu služeb Cognitive Services.
deploymentName	path	True	string	Název nasazení přidruženého k účtu služeb Cognitive Services
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DeploymentSkuListResult	OK – Vypíše skladové položky nasazení úspěšně.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

ListDeploymentSkus

Ukázkový požadavek

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName/skus?api-version=2024-10-01


/**
 * Samples for Deployments ListSkus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListDeploymentSkus.json
     */
    /**
     * Sample code: ListDeploymentSkus.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listDeploymentSkus(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.deployments().listSkus("resourceGroupName", "accountName", "deploymentName",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_deployment_skus.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.deployments.list_skus(
        resource_group_name="resourceGroupName",
        account_name="accountName",
        deployment_name="deploymentName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.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

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/ListDeploymentSkus.json
func ExampleDeploymentsClient_NewListSKUsPager() {
	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().NewListSKUsPager("resourceGroupName", "accountName", "deploymentName", 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.DeploymentSKUListResult = armcognitiveservices.DeploymentSKUListResult{
		// 	Value: []*armcognitiveservices.SKUResource{
		// 		{
		// 			Capacity: &armcognitiveservices.CapacityConfig{
		// 				Default: to.Ptr[int32](100),
		// 				AllowedValues: []*int32{
		// 					to.Ptr[int32](100),
		// 					to.Ptr[int32](200)},
		// 					Maximum: to.Ptr[int32](1000),
		// 					Minimum: to.Ptr[int32](100),
		// 					Step: to.Ptr[int32](100),
		// 				},
		// 				ResourceType: to.Ptr("Microsoft.CognitiveServices/accounts/deployments"),
		// 				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

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the specified deployments skus associated with the Cognitive Services account.
 *
 * @summary Lists the specified deployments skus associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.json
 */
async function listDeploymentSkus() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const deploymentName = "deploymentName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.deployments.listSkus(
    resourceGroupName,
    accountName,
    deploymentName,
  )) {
    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

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/ListDeploymentSkus.json
// this example is just showing the usage of "Deployments_ListSkus" 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 CognitiveServicesAccountDeploymentResource created on azure
// for more information of creating CognitiveServicesAccountDeploymentResource, please refer to the document of CognitiveServicesAccountDeploymentResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
string deploymentName = "deploymentName";
ResourceIdentifier cognitiveServicesAccountDeploymentResourceId = CognitiveServicesAccountDeploymentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, deploymentName);
CognitiveServicesAccountDeploymentResource cognitiveServicesAccountDeployment = client.GetCognitiveServicesAccountDeploymentResource(cognitiveServicesAccountDeploymentResourceId);

// invoke the operation and iterate over the result
await foreach (CognitiveServicesResourceSku item in cognitiveServicesAccountDeployment.GetSkusAsync())
{
    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

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "resourceType": "Microsoft.CognitiveServices/accounts/deployments",
      "sku": {
        "name": "Standard",
        "capacity": 1
      },
      "capacity": {
        "minimum": 100,
        "maximum": 1000,
        "step": 100,
        "default": 100,
        "allowedValues": [
          100,
          200
        ]
      }
    }
  ]
}

Definice

Name	Description
CapacityConfig	Konfigurace kapacity.
DeploymentSkuListResult	Seznam odpovědí na operace účtů služeb Cognitive Services.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Sku	Definice modelu prostředků představující skladovou položku
SkuResource	Vlastnosti prostředku prostředku účtu služeb Cognitive Services
SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

CapacityConfig

Objekt

Konfigurace kapacity.

Name	Typ	Description
allowedValues	integer[] (int32)	Pole povolených hodnot pro kapacitu.
default	integer (int32)	Výchozí kapacita.
maximum	integer (int32)	Maximální kapacita.
minimum	integer (int32)	Minimální kapacita.
step	integer (int32)	Minimální přírůstkové mezi povolenými hodnotami kapacity.

DeploymentSkuListResult

Objekt

Seznam odpovědí na operace účtů služeb Cognitive Services.

Name	Typ	Description
nextLink	string	Odkaz použitý k získání další stránky skladových položek nasazení.
value	SkuResource[]	Získá seznam skladových položek nasazení účtů služeb Cognitive Services.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Sku

Objekt

Definice modelu prostředků představující skladovou položku

Name	Typ	Description
capacity	integer (int32)	Pokud skladová položka podporuje horizontální navýšení/snížení kapacity, měla by být zahrnuta celá čísla kapacity. Pokud není pro prostředek možné horizontální navýšení kapacity nebo jeho snížení kapacity, může se tento parametr vynechat.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky. Ex - P3. Obvykle se jedná o písmeno+číslo.
size	string	Velikost skladové položky. Pokud je pole název kombinací vrstvy a jiné hodnoty, jedná se o samostatný kód.
tier	SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

SkuResource

Objekt

Vlastnosti prostředku prostředku účtu služeb Cognitive Services

Name	Typ	Description
capacity	CapacityConfig	Konfigurace kapacity.
resourceType	string	Název typu prostředku.
sku	Sku	Definice modelu prostředků představující skladovou položku

SkuTier

Výčet

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

Hodnota	Description
Basic
Enterprise
Free
Premium
Standard