Deployments - Create Or Update

Service:

Azure AI Services

Version d'API:

2024-10-01

Mettez à jour l’état des déploiements spécifiés associés au compte Cognitive Services.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nom du compte Cognitive Services.
deploymentName	path	True	string	Nom du déploiement associé au compte Cognitive Services
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties	DeploymentProperties	Propriétés du déploiement de compte Cognitive Services.
sku	Sku	Définition du modèle de ressource représentant la référence SKU
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	Deployment	Créez/mettez à jour le déploiement avec succès.
201 Created	Deployment	Créez le déploiement avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

PutDeployment

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Code d’état:

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

Définitions

Nom	Description
CallRateLimit	Limite de débit d’appel compte Cognitive Services.
createdByType	Type d’identité qui a créé la ressource.
Deployment	Déploiement de compte Cognitive Services.
DeploymentCapacitySettings	Utilisation interne uniquement.
DeploymentModel	Propriétés du modèle de déploiement de compte Cognitive Services.
DeploymentModelVersionUpgradeOption	Option de mise à niveau de version du modèle de déploiement.
DeploymentProperties	Propriétés du déploiement de compte Cognitive Services.
DeploymentProvisioningState	Obtient l’état de la ressource au moment de l’appel de l’opération.
DeploymentScaleSettings	Propriétés du modèle de déploiement de compte Cognitive Services. (Déconseillé, utilisez deployment.sku à la place.)
DeploymentScaleType	Type de mise à l’échelle du déploiement.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
RequestMatchPattern
Sku	Définition du modèle de ressource représentant la référence SKU
SkuTier	Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
ThrottlingRule

CallRateLimit

Object

Limite de débit d’appel compte Cognitive Services.

Nom	Type	Description
count	number	Valeur de nombre de limites du taux d’appel.
renewalPeriod	number	Période de renouvellement en secondes de limite du taux d’appel.
rules	ThrottlingRule[]

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

Deployment

Object

Déploiement de compte Cognitive Services.

Nom	Type	Description
etag	string	Etag de ressource.
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	DeploymentProperties	Propriétés du déploiement de compte Cognitive Services.
sku	Sku	Définition du modèle de ressource représentant la référence SKU
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DeploymentCapacitySettings

Object

Utilisation interne uniquement.

Nom	Type	Description
designatedCapacity	integer (int32) minimum: 0	Capacité désignée.
priority	integer (int32) minimum: 0	Priorité de ce paramètre de capacité.

DeploymentModel

Object

Propriétés du modèle de déploiement de compte Cognitive Services.

Nom	Type	Description
callRateLimit	CallRateLimit	Limite de débit d’appel compte Cognitive Services.
format	string	Format du modèle de déploiement.
name	string	Nom du modèle de déploiement.
publisher	string	Éditeur de modèle de déploiement.
source	string	Optionnel. ID de ressource ARM source du modèle de déploiement.
sourceAccount	string (arm-id)	Optionnel. Source du modèle, un autre ID de ressource ARM des comptes Microsoft.CognitiveServices.
version	string	Optionnel. Version du modèle de déploiement. Si la version n’est pas spécifiée, une version par défaut est affectée. La version par défaut est différente pour différents modèles et peut changer lorsqu’il existe une nouvelle version disponible pour un modèle. La version par défaut d’un modèle est disponible à partir de l’API des modèles de liste.

DeploymentModelVersionUpgradeOption

Énumération

Option de mise à niveau de version du modèle de déploiement.

Valeur	Description
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

Propriétés du déploiement de compte Cognitive Services.

Nom	Type	Description
callRateLimit	CallRateLimit	Limite de débit d’appel compte Cognitive Services.
capabilities	object	Fonctionnalités.
capacitySettings	DeploymentCapacitySettings	Utilisation interne uniquement.
currentCapacity	integer (int32)	Capacité actuelle.
dynamicThrottlingEnabled	boolean	Si la limitation dynamique est activée.
model	DeploymentModel	Propriétés du modèle de déploiement de compte Cognitive Services.
parentDeploymentName	string	Nom du déploiement parent.
provisioningState	DeploymentProvisioningState	Obtient l’état de la ressource au moment de l’appel de l’opération.
raiPolicyName	string	Nom de la stratégie RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Propriétés du modèle de déploiement de compte Cognitive Services. (Déconseillé, utilisez deployment.sku à la place.)
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Option de mise à niveau de version du modèle de déploiement.

DeploymentProvisioningState

Énumération

Obtient l’état de la ressource au moment de l’appel de l’opération.

Valeur	Description
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

Propriétés du modèle de déploiement de compte Cognitive Services. (Déconseillé, utilisez deployment.sku à la place.)

Nom	Type	Description
activeCapacity	integer (int32)	Capacité active de déploiement. Cette valeur peut être différente de capacity si le client a récemment mis à jour capacity.
capacity	integer (int32)	Capacité de déploiement.
scaleType	DeploymentScaleType	Type de mise à l’échelle du déploiement.

DeploymentScaleType

Énumération

Type de mise à l’échelle du déploiement.

Valeur	Description
Manual
Standard

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

RequestMatchPattern

Object

Nom	Type	Description
method	string
path	string

Sku

Object

Définition du modèle de ressource représentant la référence SKU

Nom	Type	Description
capacity	integer (int32)	Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici.
name	string	Nom de la référence SKU. Ex - P3. Il s’agit généralement d’une lettre+code numérique
size	string	Taille de la référence SKU. Lorsque le champ de nom est la combinaison de niveau et d’une autre valeur, il s’agit du code autonome.
tier	SkuTier	Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

SkuTier

Énumération

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

Valeur	Description
Basic
Enterprise
Free
Premium
Standard

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

ThrottlingRule

Object

Nom	Type	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number