Deployments - List

Dienst:

Azure AI Services

API-Version:

2024-10-01

Ruft die Bereitstellungen ab, die dem Cognitive Services-Konto zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Der Name des Cognitive Services-Kontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentListResult	Erfolgreich abgerufene Bereitstellungen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

ListDeployments

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CallRateLimit	Das Anrufratenlimit des Cognitive Services-Kontos.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Deployment	Bereitstellung von Cognitive Services-Konten.
DeploymentCapacitySettings	Nur interne Verwendung.
DeploymentListResult	Die Liste der kognitiven Dienste konten Operation Reaktion.
DeploymentModel	Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten.
DeploymentModelVersionUpgradeOption	Option für das Upgrade der Bereitstellungsmodellversion.
DeploymentProperties	Eigenschaften der Bereitstellung von Cognitive Services-Konten.
DeploymentProvisioningState	Ruft den Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.
DeploymentScaleSettings	Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten. (Veraltet, verwenden Sie stattdessen "Deployment.sku".)
DeploymentScaleType	Bereitstellungsskalierungstyp.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
RequestMatchPattern
Sku	Die Definition des Ressourcenmodells, die SKU darstellt
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
ThrottlingRule

CallRateLimit

Objekt

Das Anrufratenlimit des Cognitive Services-Kontos.

Name	Typ	Beschreibung
count	number	Der Anzahlwert des Anrufratenlimits.
renewalPeriod	number	Der Verlängerungszeitraum in Sekunden des Anrufratenlimits.
rules	ThrottlingRule[]

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Deployment

Objekt

Bereitstellung von Cognitive Services-Konten.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	DeploymentProperties	Eigenschaften der Bereitstellung von Cognitive Services-Konten.
sku	Sku	Die Definition des Ressourcenmodells, die SKU darstellt
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Objekt

Nur interne Verwendung.

Name	Typ	Beschreibung
designatedCapacity	integer (int32) minimum: 0	Die vorgesehene Kapazität.
priority	integer (int32) minimum: 0	Die Priorität dieser Kapazitätseinstellung.

DeploymentListResult

Objekt

Die Liste der kognitiven Dienste konten Operation Reaktion.

Name	Typ	Beschreibung
nextLink	string	Der Link, der zum Abrufen der nächsten Seite der Bereitstellung verwendet wird.
value	Deployment[]	Ruft die Liste der Cognitive Services-Konten Bereitstellung und deren Eigenschaften ab.

DeploymentModel

Objekt

Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten.

Name	Typ	Beschreibung
callRateLimit	CallRateLimit	Das Anrufratenlimit des Cognitive Services-Kontos.
format	string	Bereitstellungsmodellformat.
name	string	Name des Bereitstellungsmodells.
publisher	string	Herausgeber des Bereitstellungsmodells.
source	string	Wahlfrei. Arm-Ressourcen-ID der Bereitstellungsmodellquelle.
sourceAccount	string (arm-id)	Wahlfrei. Quelle des Modells, eine andere Microsoft.CognitiveServices-Konten ARM-Ressourcen-ID.
version	string	Wahlfrei. Bereitstellungsmodellversion. Wenn keine Version angegeben ist, wird eine Standardversion zugewiesen. Die Standardversion unterscheidet sich für verschiedene Modelle und kann sich ändern, wenn eine neue Version für ein Modell verfügbar ist. Die Standardversion für ein Modell wurde aus der Listenmodelle-API gefunden.

DeploymentModelVersionUpgradeOption

Enumeration

Option für das Upgrade der Bereitstellungsmodellversion.

Wert	Beschreibung
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Objekt

Eigenschaften der Bereitstellung von Cognitive Services-Konten.

Name	Typ	Beschreibung
callRateLimit	CallRateLimit	Das Anrufratenlimit des Cognitive Services-Kontos.
capabilities	object	Die Funktionen.
capacitySettings	DeploymentCapacitySettings	Nur interne Verwendung.
currentCapacity	integer (int32)	Die aktuelle Kapazität.
dynamicThrottlingEnabled	boolean	Wenn die dynamische Einschränkung aktiviert ist.
model	DeploymentModel	Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten.
parentDeploymentName	string	Der Name der übergeordneten Bereitstellung.
provisioningState	DeploymentProvisioningState	Ruft den Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.
raiPolicyName	string	Der Name der RAI-Richtlinie.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten. (Veraltet, verwenden Sie stattdessen "Deployment.sku".)
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Option für das Upgrade der Bereitstellungsmodellversion.

DeploymentProvisioningState

Enumeration

Ruft den Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.

Wert	Beschreibung
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Objekt

Eigenschaften des Bereitstellungsmodells für Cognitive Services-Konten. (Veraltet, verwenden Sie stattdessen "Deployment.sku".)

Name	Typ	Beschreibung
activeCapacity	integer (int32)	Aktive Bereitstellungskapazität. Dieser Wert unterscheidet sich möglicherweise von capacity, wenn der Kunde kürzlich capacityaktualisiert hat.
capacity	integer (int32)	Bereitstellungskapazität.
scaleType	DeploymentScaleType	Bereitstellungsskalierungstyp.

DeploymentScaleType

Enumeration

Bereitstellungsskalierungstyp.

Wert	Beschreibung
Manual
Standard

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

RequestMatchPattern

Objekt

Name	Typ	Beschreibung
method	string
path	string

Sku

Objekt

Die Definition des Ressourcenmodells, die SKU darstellt

Name	Typ	Beschreibung
capacity	integer (int32)	Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU. Ex - P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

SkuTier

Enumeration

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

Wert	Beschreibung
Basic
Enterprise
Free
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

ThrottlingRule

Objekt

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