Accounts - List Skus

Serviço:

Azure AI Services

Versão da API:

2024-10-01

Listar SKUs disponíveis para a conta dos Serviços Cognitivos solicitada

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	O nome da conta dos Serviços Cognitivos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AccountSkuListResult	O provedor de recursos deve retornar 200 (OK) para indicar que a operação foi concluída com êxito. Para obter uma explicação detalhada de cada campo no corpo da resposta, consulte a descrição do corpo da solicitação na seção de recursos PUT. As únicas propriedades específicas do GET são "name", "type" e "id". SKU de Descrição de Campo Obrigatório, objeto O conjunto exato de chaves que definem esse sku. Isso corresponde aos campos no respectivo recurso. sku.name Obrigatório, cadeia de caracteres O nome da SKU. Normalmente, isso é uma letra + código numérico, como A0 ou P3 sku.tier Required, cadeia de caracteres A camada deste SKU específico. Normalmente, um de: · Gratuito · Básico · Standard · Prêmio
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou. Se o recurso não existir, 404 (NotFound) serão retornados.

Exemplos

List SKUs

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/skus?api-version=2024-10-01

Java

/**
 * Samples for Accounts ListSkus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.
     * json
     */
    /**
     * Sample code: List SKUs.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void listSKUs(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.accounts().listSkusWithResponse("myResourceGroup", "myAccount", 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_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="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.accounts.list_skus(
        resource_group_name="myResourceGroup",
        account_name="myAccount",
    )
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.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/ListSkus.json
func ExampleAccountsClient_ListSKUs() {
	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)
	}
	res, err := clientFactory.NewAccountsClient().ListSKUs(ctx, "myResourceGroup", "myAccount", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AccountSKUListResult = armcognitiveservices.AccountSKUListResult{
	// 	Value: []*armcognitiveservices.AccountSKU{
	// 		{
	// 			ResourceType: to.Ptr("Microsoft.CognitiveServices/accounts"),
	// 			SKU: &armcognitiveservices.SKU{
	// 				Name: to.Ptr("F0"),
	// 				Tier: to.Ptr(armcognitiveservices.SKUTierFree),
	// 			},
	// 		},
	// 		{
	// 			ResourceType: to.Ptr("Microsoft.CognitiveServices/accounts"),
	// 			SKU: &armcognitiveservices.SKU{
	// 				Name: to.Ptr("S0"),
	// 				Tier: to.Ptr(armcognitiveservices.SKUTierStandard),
	// 			},
	// 	}},
	// }
}

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 List available SKUs for the requested Cognitive Services account
 *
 * @summary List available SKUs for the requested Cognitive Services account
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.json
 */
async function listSkUs() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "myResourceGroup";
  const accountName = "myAccount";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.listSkus(resourceGroupName, accountName);
  console.log(result);
}

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/2024-10-01/examples/ListSkus.json
// this example is just showing the usage of "Accounts_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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "myResourceGroup";
string accountName = "myAccount";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// invoke the operation and iterate over the result
await foreach (CognitiveServicesAccountSku item in cognitiveServicesAccount.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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "resourceType": "Microsoft.CognitiveServices/accounts",
      "sku": {
        "name": "F0",
        "tier": "Free"
      }
    },
    {
      "resourceType": "Microsoft.CognitiveServices/accounts",
      "sku": {
        "name": "S0",
        "tier": "Standard"
      }
    }
  ]
}

Definições

Nome	Description
AccountSku	Tipo de recurso e SKU dos Serviços Cognitivos.
AccountSkuListResult	A lista de resposta da operação de contas de serviços cognitivos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Sku	A definição do modelo de recurso que representa o SKU
SkuTier	Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

AccountSku

Objeto

Tipo de recurso e SKU dos Serviços Cognitivos.

Nome	Tipo	Description
resourceType	string	Namespace e tipo de recurso
sku	Sku	A conta do SKU dos Serviços Cognitivos.

AccountSkuListResult

Objeto

A lista de resposta da operação de contas de serviços cognitivos.

Nome	Tipo	Description
value	AccountSku[]	Obtém a lista de contas dos Serviços Cognitivos e suas propriedades.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

Objeto

A definição do modelo de recurso que representa o SKU

Nome	Tipo	Description
capacity	integer (int32)	Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.
name	string	O nome da SKU. Ex - P3. Normalmente, é um código letter+number
size	string	O tamanho da SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo.
tier	SkuTier	Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

SkuTier

Enumeração

Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

Valor	Description
Basic
Enterprise
Free
Premium
Standard