Deployments - Create Or Update

Szolgáltatás:

Azure AI Services

API-verzió:

2024-10-01

Frissítse a Cognitive Services-fiókhoz társított meghatározott üzemelő példányok állapotát.

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

URI-paraméterek

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

Kérelem törzse

Name	Típus	Description
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ó
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	Deployment	Az üzembe helyezés létrehozása/frissítése sikeresen.
201 Created	Deployment	Az üzembe helyezés létrehozása sikeresen megtörtént.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

PutDeployment

Mintakérelem

HTTP

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

{
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "properties": {
    "model": {
      "format": "OpenAI",
      "name": "ada",
      "version": "1"
    }
  }
}

Java

import com.azure.resourcemanager.cognitiveservices.models.DeploymentModel;
import com.azure.resourcemanager.cognitiveservices.models.DeploymentProperties;
import com.azure.resourcemanager.cognitiveservices.models.Sku;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * PutDeployment.json
     */
    /**
     * Sample code: PutDeployment.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void putDeployment(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.deployments().define("deploymentName").withExistingAccount("resourceGroupName", "accountName")
            .withSku(new Sku().withName("Standard").withCapacity(1)).withProperties(new DeploymentProperties()
                .withModel(new DeploymentModel().withFormat("OpenAI").withName("ada").withVersion("1")))
            .create();
    }
}

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 put_deployment.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.begin_create_or_update(
        resource_group_name="resourceGroupName",
        account_name="accountName",
        deployment_name="deploymentName",
        deployment={
            "properties": {"model": {"format": "OpenAI", "name": "ada", "version": "1"}},
            "sku": {"capacity": 1, "name": "Standard"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.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/azcore/to"
	"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/PutDeployment.json
func ExampleDeploymentsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "accountName", "deploymentName", armcognitiveservices.Deployment{
		Properties: &armcognitiveservices.DeploymentProperties{
			Model: &armcognitiveservices.DeploymentModel{
				Name:    to.Ptr("ada"),
				Format:  to.Ptr("OpenAI"),
				Version: to.Ptr("1"),
			},
		},
		SKU: &armcognitiveservices.SKU{
			Name:     to.Ptr("Standard"),
			Capacity: to.Ptr[int32](1),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Deployment = 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 Update the state of specified deployments associated with the Cognitive Services account.
 *
 * @summary Update the state of specified deployments associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json
 */
async function putDeployment() {
  const subscriptionId = process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const deploymentName = "deploymentName";
  const deployment = {
    properties: { model: { name: "ada", format: "OpenAI", version: "1" } },
    sku: { name: "Standard", capacity: 1 },
  };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    deploymentName,
    deployment,
  );
  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.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json
// this example is just showing the usage of "Deployments_CreateOrUpdate" 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
string deploymentName = "deploymentName";
CognitiveServicesAccountDeploymentData data = new CognitiveServicesAccountDeploymentData()
{
    Sku = new CognitiveServicesSku("Standard")
    {
        Capacity = 1,
    },
    Properties = new CognitiveServicesAccountDeploymentProperties()
    {
        Model = new CognitiveServicesAccountDeploymentModel()
        {
            Format = "OpenAI",
            Name = "ada",
            Version = "1",
        },
    },
};
ArmOperation<CognitiveServicesAccountDeploymentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, deploymentName, data);
CognitiveServicesAccountDeploymentResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

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

Állapotkód:

201

{
  "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": "Accepted"
  }
}

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.
DeploymentCapacitySettings	Csak belső használatra.
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ásakor.
DeploymentScaleSettings	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai. (Elavult, használja helyette a Deployment.sku-t.)
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

Tárgy

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

Name	Típus	Description
count	number	A hívássebesség-korlát számértéke.
renewalPeriod	number	A megújítási időszak másodpercben a hívássebesség-korláttól.
rules	ThrottlingRule[]

createdByType

Felsorolás

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

Érték	Description
User
Application
ManagedIdentity
Key

Deployment

Tárgy

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. Ex - /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.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Tárgy

Csak belső használatra.

Name	Típus	Description
designatedCapacity	integer (int32) minimum: 0	A kijelölt kapacitás.
priority	integer (int32) minimum: 0	A kapacitásbeállítás prioritása.

DeploymentModel

Tárgy

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	Az üzembehelyezési modell neve.
publisher	string	Üzembehelyezési modell közzétevője.
source	string	Szabadon választható. Az üzembehelyezési modell forrás ARM-erőforrás-azonosítója.
sourceAccount	string (arm-id)	Szabadon választható. A modell forrása egy másik Microsoft.CognitiveServices-fiók ARM-erőforrás-azonosítója.
version	string	Szabadon választható. Az ü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 változhat, ha egy modellhez új verzió érhető el. A modell alapértelmezett verziója a listamodellek API-jából származik.

DeploymentModelVersionUpgradeOption

Felsorolás

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

Érték	Description
OnceNewDefaultVersionAvailable
OnceCurrentVersionExpired
NoAutoUpgrade

DeploymentProperties

Tárgy

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.
capacitySettings	DeploymentCapacitySettings	Csak belső használatra.
currentCapacity	integer (int32)	Az aktuális kapacitás.
dynamicThrottlingEnabled	boolean	Ha a dinamikus szabályozás engedélyezve van.
model	DeploymentModel	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai.
parentDeploymentName	string	A szülőtelepítés neve.
provisioningState	DeploymentProvisioningState	Lekéri az erőforrás állapotát a művelet meghívásakor.
raiPolicyName	string	Az RAI-szabályzat neve.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai. (Elavult, használja helyette a Deployment.sku-t.)
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Az üzembehelyezési modell verziófrissítési lehetősége.

DeploymentProvisioningState

Felsorolás

Lekéri az erőforrás állapotát a művelet meghívásakor.

Érték	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Disabled
Canceled

DeploymentScaleSettings

Tárgy

A Cognitive Services-fiók üzembehelyezési modelljének tulajdonságai. (Elavult, használja helyette a Deployment.sku-t.)

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

DeploymentScaleType

Felsorolás

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

Érték	Description
Standard
Manual

ErrorAdditionalInfo

Tárgy

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 információtípus.

ErrorDetail

Tárgy

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 hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

RequestMatchPattern

Tárgy

Name	Típus	Description
method	string
path	string

Sku

Tárgy

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

Name	Típus	Description
capacity	integer (int32)	Ha az SKU támogatja a vertikális felskálázást/azt, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforrás esetében nem lehetséges a vertikális felskálázás/beskálázás, akkor ez kihagyható.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az 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, akkor 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

Felsorolás

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.

Érték	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Tárgy

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

Name	Típus	Description
createdAt	string (date-time)	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 (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

ThrottlingRule

Tárgy

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