Deployments - List

Servizio:

Azure AI Services

Versione API:

2024-10-01

Ottiene le distribuzioni associate all'account servizi cognitivi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nome dell'account servizi cognitivi.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	DeploymentListResult	Distribuzioni recuperate correttamente.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

ListDeployments

Esempio di richiesta

HTTP

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

Java

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

    response = client.deployments.list(
        resource_group_name="resourceGroupName",
        account_name="accountName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.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/ListDeployments.json
func ExampleDeploymentsClient_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.NewDeploymentsClient().NewListPager("resourceGroupName", "accountName", 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.DeploymentListResult = armcognitiveservices.DeploymentListResult{
		// 	Value: []*armcognitiveservices.Deployment{
		// 		{
		// 			Name: to.Ptr("deploymentName"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts/deployments"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName"),
		// 			Properties: &armcognitiveservices.DeploymentProperties{
		// 				Model: &armcognitiveservices.DeploymentModel{
		// 					Name: to.Ptr("ada"),
		// 					Format: to.Ptr("OpenAI"),
		// 					Version: to.Ptr("1"),
		// 				},
		// 				ProvisioningState: to.Ptr(armcognitiveservices.DeploymentProvisioningStateSucceeded),
		// 			},
		// 			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

JavaScript

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

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json
// this example is just showing the usage of "Deployments_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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "subscriptionId";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// get the collection of this CognitiveServicesAccountDeploymentResource
CognitiveServicesAccountDeploymentCollection collection = cognitiveServicesAccount.GetCognitiveServicesAccountDeployments();

// invoke the operation and iterate over the result
await foreach (CognitiveServicesAccountDeploymentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CognitiveServicesAccountDeploymentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
      "name": "deploymentName",
      "type": "Microsoft.CognitiveServices/accounts/deployments",
      "sku": {
        "name": "Standard",
        "capacity": 1
      },
      "properties": {
        "model": {
          "format": "OpenAI",
          "name": "ada",
          "version": "1"
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CallRateLimit	L'account servizi cognitivi limita la frequenza delle chiamate.
createdByType	Tipo di identità che ha creato la risorsa.
Deployment	Distribuzione di account di Servizi cognitivi.
DeploymentCapacitySettings	Solo uso interno.
DeploymentListResult	Elenco delle risposte dell'operazione degli account servizi cognitivi.
DeploymentModel	Proprietà del modello di distribuzione dell'account servizi cognitivi.
DeploymentModelVersionUpgradeOption	Opzione di aggiornamento della versione del modello di distribuzione.
DeploymentProperties	Proprietà della distribuzione dell'account servizi cognitivi.
DeploymentProvisioningState	Ottiene lo stato della risorsa al momento della chiamata dell'operazione.
DeploymentScaleSettings	Proprietà del modello di distribuzione dell'account servizi cognitivi. (Deprecato, usare invece Deployment.sku.
DeploymentScaleType	Tipo di scalabilità di distribuzione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
RequestMatchPattern
Sku	Definizione del modello di risorse che rappresenta lo SKU
SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
ThrottlingRule

CallRateLimit

Object

L'account servizi cognitivi limita la frequenza delle chiamate.

Nome	Tipo	Descrizione
count	number	Valore count di Call Rate Limit.
renewalPeriod	number	Periodo di rinnovo in secondi del limite di frequenza delle chiamate.
rules	ThrottlingRule[]

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

Deployment

Object

Distribuzione di account di Servizi cognitivi.

Nome	Tipo	Descrizione
etag	string	Etag risorsa.
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties	DeploymentProperties	Proprietà della distribuzione dell'account servizi cognitivi.
sku	Sku	Definizione del modello di risorse che rappresenta lo SKU
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Object

Solo uso interno.

Nome	Tipo	Descrizione
designatedCapacity	integer (int32) minimum: 0	Capacità designata.
priority	integer (int32) minimum: 0	Priorità di questa impostazione di capacità.

DeploymentListResult

Object

Elenco delle risposte dell'operazione degli account servizi cognitivi.

Nome	Tipo	Descrizione
nextLink	string	Collegamento usato per ottenere la pagina successiva di Distribuzione.
value	Deployment[]	Ottiene l'elenco degli account servizi cognitivi Deployment e delle relative proprietà.

DeploymentModel

Object

Proprietà del modello di distribuzione dell'account servizi cognitivi.

Nome	Tipo	Descrizione
callRateLimit	CallRateLimit	L'account servizi cognitivi limita la frequenza delle chiamate.
format	string	Formato del modello di distribuzione.
name	string	Nome del modello di distribuzione.
publisher	string	Server di pubblicazione del modello di distribuzione.
source	string	Opzionale. ID risorsa ARM del modello di distribuzione.
sourceAccount	string (arm-id)	Opzionale. Origine del modello, un altro ID risorsa ARM account Microsoft.CognitiveServices.
version	string	Opzionale. Versione del modello di distribuzione. Se la versione non è specificata, verrà assegnata una versione predefinita. La versione predefinita è diversa per i diversi modelli e può cambiare quando è disponibile una nuova versione per un modello. La versione predefinita per un modello è disponibile nell'API dei modelli di elenco.

DeploymentModelVersionUpgradeOption

Enumerazione

Opzione di aggiornamento della versione del modello di distribuzione.

Valore	Descrizione
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

Proprietà della distribuzione dell'account servizi cognitivi.

Nome	Tipo	Descrizione
callRateLimit	CallRateLimit	L'account servizi cognitivi limita la frequenza delle chiamate.
capabilities	object	Funzionalità.
capacitySettings	DeploymentCapacitySettings	Solo uso interno.
currentCapacity	integer (int32)	Capacità corrente.
dynamicThrottlingEnabled	boolean	Se la limitazione dinamica è abilitata.
model	DeploymentModel	Proprietà del modello di distribuzione dell'account servizi cognitivi.
parentDeploymentName	string	Nome della distribuzione padre.
provisioningState	DeploymentProvisioningState	Ottiene lo stato della risorsa al momento della chiamata dell'operazione.
raiPolicyName	string	Nome della politica RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Proprietà del modello di distribuzione dell'account servizi cognitivi. (Deprecato, usare invece Deployment.sku.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Opzione di aggiornamento della versione del modello di distribuzione.

DeploymentProvisioningState

Enumerazione

Ottiene lo stato della risorsa al momento della chiamata dell'operazione.

Valore	Descrizione
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

Proprietà del modello di distribuzione dell'account servizi cognitivi. (Deprecato, usare invece Deployment.sku.

Nome	Tipo	Descrizione
activeCapacity	integer (int32)	Capacità attiva della distribuzione. Questo valore potrebbe essere diverso da capacity se il cliente ha aggiornato di recente capacity.
capacity	integer (int32)	Capacità di distribuzione.
scaleType	DeploymentScaleType	Tipo di scalabilità di distribuzione.

DeploymentScaleType

Enumerazione

Tipo di scalabilità di distribuzione.

Valore	Descrizione
Manual
Standard

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

RequestMatchPattern

Object

Nome	Tipo	Descrizione
method	string
path	string

Sku

Object

Definizione del modello di risorse che rappresenta lo SKU

Nome	Tipo	Descrizione
capacity	integer (int32)	Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.
name	string	Nome dello SKU. Ad esempio - P3. Si tratta in genere di un codice lettera+numero
size	string	Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo.
tier	SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

SkuTier

Enumerazione

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

Valore	Descrizione
Basic
Enterprise
Free
Premium
Standard

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

ThrottlingRule

Object

Nome	Tipo	Descrizione
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number