Deployments - Create Or Update

Service:

Azure AI Services

API Version:

2023-05-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=2023-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte Cognitive Services. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
deploymentName	path	True	string	Nom du déploiement associé au compte Cognitive Services
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	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

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 la raison de l’échec de l’opération.

Exemples

PutDeployment

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName?api-version=2023-05-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/2023-05-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/2023-05-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/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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/2023-05-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 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/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 CognitiveServicesAccountDeploymentResource created on azure
// for more information of creating CognitiveServicesAccountDeploymentResource, please refer to the document of CognitiveServicesAccountDeploymentResource
string subscriptionId = "subscriptionId";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
string deploymentName = "deploymentName";
ResourceIdentifier cognitiveServicesAccountDeploymentResourceId = CognitiveServicesAccountDeploymentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, deploymentName);
CognitiveServicesAccountDeploymentResource cognitiveServicesAccountDeployment = client.GetCognitiveServicesAccountDeploymentResource(cognitiveServicesAccountDeploymentResourceId);

// invoke the operation
CognitiveServicesAccountDeploymentData data = new CognitiveServicesAccountDeploymentData()
{
    Properties = new CognitiveServicesAccountDeploymentProperties()
    {
        Model = new CognitiveServicesAccountDeploymentModel()
        {
            Format = "OpenAI",
            Name = "ada",
            Version = "1",
        },
        ScaleSettings = new CognitiveServicesAccountDeploymentScaleSettings()
        {
            ScaleType = CognitiveServicesAccountDeploymentScaleType.Manual,
            Capacity = 1,
        },
    },
};
ArmOperation<CognitiveServicesAccountDeploymentResource> lro = await cognitiveServicesAccountDeployment.UpdateAsync(WaitUntil.Completed, 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

Sample Response

Status code:

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

Status code:

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	La limite de débit d’appels compte Cognitive Services.
createdByType	Type d’identité qui a créé la ressource.
Deployment	Déploiement de compte Cognitive Services.
DeploymentModel	Propriétés du modèle de déploiement de compte Cognitive Services.
DeploymentModelVersionUpgradeOption	Option de mise à niveau de la version du modèle de déploiement.
DeploymentProperties	Propriétés du déploiement de compte Cognitive Services.
DeploymentProvisioningState	Obtient le status de la ressource au moment où l’opération a été appelée.
DeploymentScaleSettings	Propriétés du modèle de déploiement de compte Cognitive Services.
DeploymentScaleType	Type d’échelle de 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 requis sur un PUT.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
ThrottlingRule

CallRateLimit

La limite de débit d’appels compte Cognitive Services.

Nom	Type	Description
count	number	Valeur de nombre de la limite de débit d’appels.
renewalPeriod	number	Période de renouvellement en secondes de limite de débit d’appels.
rules	ThrottlingRule[]

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Déploiement de compte Cognitive Services.

Nom	Type	Description
etag	string	Etag de la 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.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DeploymentModel

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

Nom	Type	Description
callRateLimit	CallRateLimit	La limite de débit d’appels compte Cognitive Services.
format	string	Format du modèle de déploiement.
name	string	Nom du modèle de déploiement.
source	string	facultatif. ID de ressource ARM source du modèle de déploiement.
version	string	facultatif. 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 quand une nouvelle version est disponible pour un modèle. La version par défaut d’un modèle peut être trouvée à partir de l’API des modèles de liste.

DeploymentModelVersionUpgradeOption

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

Nom	Type	Description
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

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

Nom	Type	Description
callRateLimit	CallRateLimit	La limite de débit d’appels compte Cognitive Services.
capabilities	object	Fonctionnalités.
model	DeploymentModel	Propriétés du modèle de déploiement de compte Cognitive Services.
provisioningState	DeploymentProvisioningState	Obtient le status de la ressource au moment où l’opération a été appelée.
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.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Option de mise à niveau de la version du modèle de déploiement.

DeploymentProvisioningState

Obtient le status de la ressource au moment où l’opération a été appelée.

Nom	Type	Description
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

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

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

DeploymentScaleType

Type d’échelle de déploiement.

Nom	Type	Description
Manual	string
Standard	string

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

RequestMatchPattern

Nom	Type	Description
method	string
path	string

Sku

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

Nom	Type	Description
capacity	integer	Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si un scale-out/scale-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, cela peut être capturé ici.
name	string	Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre
size	string	Taille de la référence SKU. Lorsque le champ name est la combinaison du 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 requis sur un PUT.

SkuTier

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

Nom	Type	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

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

Nom	Type	Description
createdAt	string	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	Horodatage de la dernière modification de la 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

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