Deployments - List

Service:

Azure AI Services

API Version:

2023-05-01

Lekéri a Cognitive Services-fiókhoz társított üzemelő példányokat.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A Cognitive Services-fiók neve. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	DeploymentListResult	Az üzemelő példányok lekérése sikerült.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

ListDeployments

Sample Request

HTTP

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

Java

/** Samples for Deployments List. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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/2023-05-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/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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),
		// 				ScaleSettings: &armcognitiveservices.DeploymentScaleSettings{
		// 					Capacity: to.Ptr[int32](1),
		// 					ScaleType: to.Ptr(armcognitiveservices.DeploymentScaleTypeManual),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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/2023-05-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CognitiveServices;
using Azure.ResourceManager.CognitiveServices.Models;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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

Sample Response

Status code:

200

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

Definíciók

Name	Description
CallRateLimit	A hívási sebesség korlátozza a Cognitive Services-fiókot.
createdByType	Az erőforrást létrehozó identitás típusa.
Deployment	Cognitive Services-fiók üzembe helyezése.
DeploymentListResult	A Cognitive Services-fiókok műveleti válaszainak listája.
DeploymentModel	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.
DeploymentModelVersionUpgradeOption	Az üzembehelyezési modell verziófrissítési lehetősége.
DeploymentProperties	A Cognitive Services-fiók üzembe helyezésének tulajdonságai.
DeploymentProvisioningState	Lekéri az erőforrás állapotát a művelet meghívásának időpontjában.
DeploymentScaleSettings	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.
DeploymentScaleType	Üzembe helyezési skálázás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
RequestMatchPattern
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
ThrottlingRule

CallRateLimit

A hívási sebesség korlátozza a Cognitive Services-fiókot.

Name	Típus	Description
count	number	A hívási sebesség korlátjának számértéke.
renewalPeriod	number	A megújítási időszak másodpercben a hívási sebesség korlátja után.
rules	ThrottlingRule[]

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Cognitive Services-fiók üzembe helyezése.

Name	Típus	Description
etag	string	Erőforráscímke.
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	DeploymentProperties	A Cognitive Services-fiók üzembe helyezésének tulajdonságai.
sku	Sku	A termékváltozatot képviselő erőforrásmodell-definíció
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

DeploymentListResult

A Cognitive Services-fiókok műveleti válaszainak listája.

Name	Típus	Description
nextLink	string	Az Üzembe helyezés következő oldalának lekéréséhez használt hivatkozás.
value	Deployment[]	Lekéri a Cognitive Services-fiókok üzembe helyezésének listáját és tulajdonságait.

DeploymentModel

A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.

Name	Típus	Description
callRateLimit	CallRateLimit	A hívási sebesség korlátozza a Cognitive Services-fiókot.
format	string	Üzembehelyezési modell formátuma.
name	string	Üzembehelyezési modell neve.
source	string	Választható. Üzembehelyezési modell forrás ARM-erőforrás-azonosítója.
version	string	Választható. Üzembehelyezési modell verziója. Ha nincs megadva verzió, a rendszer egy alapértelmezett verziót rendel hozzá. Az alapértelmezett verzió eltérő a különböző modellek esetében, és megváltozhat, ha egy modellhez új verzió érhető el. A modell alapértelmezett verziója megtalálható a listamodellek API-jából.

DeploymentModelVersionUpgradeOption

Az üzembehelyezési modell verziófrissítési lehetősége.

Name	Típus	Description
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

A Cognitive Services-fiók üzembe helyezésének tulajdonságai.

Name	Típus	Description
callRateLimit	CallRateLimit	A hívási sebesség korlátozza a Cognitive Services-fiókot.
capabilities	object	A képességek.
model	DeploymentModel	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.
provisioningState	DeploymentProvisioningState	Lekéri az erőforrás állapotát a művelet meghívásának időpontjában.
raiPolicyName	string	Az RAI-szabályzat neve.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Az üzembehelyezési modell verziófrissítési lehetősége.

DeploymentProvisioningState

Lekéri az erőforrás állapotát a művelet meghívásának időpontjában.

Name	Típus	Description
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.

Name	Típus	Description
activeCapacity	integer	Üzembe helyezés aktív kapacitása. Ez az érték eltérhet capacity , ha az ügyfél nemrég frissült capacity.
capacity	integer	Üzembehelyezési kapacitás.
scaleType	DeploymentScaleType	Üzembe helyezési skálázás típusa.

DeploymentScaleType

Üzembe helyezési skálázás típusa.

Name	Típus	Description
Manual	string
Standard	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

RequestMatchPattern

Name	Típus	Description
method	string
path	string

Sku

A termékváltozatot képviselő erőforrásmodell-definíció

Name	Típus	Description
capacity	integer	Ha a termékváltozat támogatja a fel- és leskálázást, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforráshoz nem lehet vertikális felskálázást/beskálázást végezni, ez kihagyható.
family	string	Ha a szolgáltatás eltérő hardvergenerációval rendelkezik ugyanahhoz a termékváltozathoz, akkor az itt rögzíthető.
name	string	A termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuTier

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Name	Típus	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

ThrottlingRule

Name	Típus	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number