Deployments - Create Or Update

Service:

Azure AI Services

API Version:

2023-05-01

Actualice el estado de las implementaciones especificadas asociadas a la cuenta de Cognitive Services.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de Cognitive Services. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
deploymentName	path	True	string	Nombre de la implementación asociada a la cuenta de Cognitive Services
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties	DeploymentProperties	Propiedades de la implementación de la cuenta de Cognitive Services.
sku	Sku	Definición del modelo de recursos que representa la SKU

Respuestas

Nombre	Tipo	Description
200 OK	Deployment	Cree o actualice correctamente la implementación.
201 Created	Deployment	Cree la implementación correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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

Definiciones

Nombre	Description
CallRateLimit	La cuenta de Cognitive Services limita la tasa de llamadas.
createdByType	Tipo de identidad que creó el recurso.
Deployment	Implementación de la cuenta de Cognitive Services.
DeploymentModel	Propiedades del modelo de implementación de cuentas de Cognitive Services.
DeploymentModelVersionUpgradeOption	Opción de actualización de la versión del modelo de implementación.
DeploymentProperties	Propiedades de la implementación de la cuenta de Cognitive Services.
DeploymentProvisioningState	Obtiene el estado del recurso en el momento en que se llamó a la operación.
DeploymentScaleSettings	Propiedades del modelo de implementación de cuentas de Cognitive Services.
DeploymentScaleType	Tipo de escala de implementación.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
RequestMatchPattern
Sku	Definición del modelo de recursos que representa la SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
ThrottlingRule

CallRateLimit

La cuenta de Cognitive Services limita la tasa de llamadas.

Nombre	Tipo	Description
count	number	El valor de recuento del límite de frecuencia de llamadas.
renewalPeriod	number	El período de renovación en segundos del límite de frecuencia de llamadas.
rules	ThrottlingRule[]

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Implementación de la cuenta de Cognitive Services.

Nombre	Tipo	Description
etag	string	Etag de recursos.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties	DeploymentProperties	Propiedades de la implementación de la cuenta de Cognitive Services.
sku	Sku	Definición del modelo de recursos que representa la SKU
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DeploymentModel

Propiedades del modelo de implementación de cuentas de Cognitive Services.

Nombre	Tipo	Description
callRateLimit	CallRateLimit	La cuenta de Cognitive Services limita la tasa de llamadas.
format	string	Formato del modelo de implementación.
name	string	Nombre del modelo de implementación.
source	string	Opcional. Id. de recurso de ARM de origen del modelo de implementación.
version	string	Opcional. Versión del modelo de implementación. Si no se especifica la versión, se asignará una versión predeterminada. La versión predeterminada es diferente para diferentes modelos y puede cambiar cuando hay nueva versión disponible para un modelo. La versión predeterminada de un modelo se puede encontrar en la API de modelos de lista.

DeploymentModelVersionUpgradeOption

Opción de actualización de la versión del modelo de implementación.

Nombre	Tipo	Description
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

Propiedades de la implementación de la cuenta de Cognitive Services.

Nombre	Tipo	Description
callRateLimit	CallRateLimit	La cuenta de Cognitive Services limita la tasa de llamadas.
capabilities	object	Las funcionalidades.
model	DeploymentModel	Propiedades del modelo de implementación de cuentas de Cognitive Services.
provisioningState	DeploymentProvisioningState	Obtiene el estado del recurso en el momento en que se llamó a la operación.
raiPolicyName	string	Nombre de la directiva RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Propiedades del modelo de implementación de cuentas de Cognitive Services.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Opción de actualización de la versión del modelo de implementación.

DeploymentProvisioningState

Obtiene el estado del recurso en el momento en que se llamó a la operación.

Nombre	Tipo	Description
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

Propiedades del modelo de implementación de cuentas de Cognitive Services.

Nombre	Tipo	Description
activeCapacity	integer	Capacidad activa de implementación. Este valor puede ser diferente de capacity si el cliente actualizó capacityrecientemente .
capacity	integer	Capacidad de implementación.
scaleType	DeploymentScaleType	Tipo de escala de implementación.

DeploymentScaleType

Tipo de escala de implementación.

Nombre	Tipo	Description
Manual	string
Standard	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

RequestMatchPattern

Nombre	Tipo	Description
method	string
path	string

Sku

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	El nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número.
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y algún otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Nombre	Tipo	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

ThrottlingRule

Nombre	Tipo	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number