Deployments - Create Or Update

Serviço:: Azure AI Services

Versão da API:: 2024-10-01

Atualize o estado das implantações especificadas associadas à conta dos Serviços Cognitivos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	O nome da conta dos Serviços Cognitivos.
deploymentName	path	True	string	O nome da implantação associada à Conta de Serviços Cognitivos
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	DeploymentProperties	Propriedades da implantação da conta dos Serviços Cognitivos.
sku	Sku	A definição do modelo de recursos que representa a SKU
tags	object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	Deployment	Crie/atualize a implantação com êxito.
201 Created	Deployment	Crie a implantação com êxito.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Exemplos

PutDeployment

Pedido de amostra

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


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

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

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

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

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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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"
  }
}

Definições

Name	Description
CallRateLimit	A conta de Serviços Cognitivos de limite de taxa de chamada.
createdByType	O tipo de identidade que criou o recurso.
Deployment	Implantação de conta de Serviços Cognitivos.
DeploymentCapacitySettings	Apenas para uso interno.
DeploymentModel	Propriedades do modelo de implantação de conta dos Serviços Cognitivos.
DeploymentModelVersionUpgradeOption	Opção de atualização da versão do modelo de implantação.
DeploymentProperties	Propriedades da implantação da conta dos Serviços Cognitivos.
DeploymentProvisioningState	Obtém o status do recurso no momento em que a operação foi chamada.
DeploymentScaleSettings	Propriedades do modelo de implantação de conta dos Serviços Cognitivos. (Preterido, use Deployment.sku em vez disso.)
DeploymentScaleType	Tipo de escala de implantação.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
RequestMatchPattern
Sku	A definição do modelo de recursos que representa a SKU
SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.
systemData	Metadados referentes à criação e última modificação do recurso.
ThrottlingRule

CallRateLimit

Object

A conta de Serviços Cognitivos de limite de taxa de chamada.

Name	Tipo	Description
count	number	O valor de contagem de Limite de Taxa de Chamada.
renewalPeriod	number	O período de renovação em segundos do Limite de Taxa de Chamada.
rules	ThrottlingRule[]

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

Deployment

Object

Implantação de conta de Serviços Cognitivos.

Name	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	DeploymentProperties	Propriedades da implantação da conta dos Serviços Cognitivos.
sku	Sku	A definição do modelo de recursos que representa a SKU
systemData	systemData	Metadados referentes à criação e última modificação do recurso.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Object

Apenas para uso interno.

Name	Tipo	Description
designatedCapacity	integer (int32) minimum: 0	A capacidade designada.
priority	integer (int32) minimum: 0	A prioridade desta definição de capacidade.

DeploymentModel

Object

Propriedades do modelo de implantação de conta dos Serviços Cognitivos.

Name	Tipo	Description
callRateLimit	CallRateLimit	A conta de Serviços Cognitivos de limite de taxa de chamada.
format	string	Formato do modelo de implantação.
name	string	Nome do modelo de implantação.
publisher	string	Editor do modelo de implantação.
source	string	Opcional. ID do recurso ARM de origem do modelo de implantação.
sourceAccount	string (arm-id)	Opcional. Origem do modelo, outra ID de recurso ARM de contas Microsoft.CognitiveServices.
version	string	Opcional. Versão do modelo de implantação. Se a versão não for especificada, uma versão padrão será atribuída. A versão padrão é diferente para modelos diferentes e pode mudar quando houver uma nova versão disponível para um modelo. A versão padrão para um modelo pode ser encontrada na API de modelos de lista.

DeploymentModelVersionUpgradeOption

Enumeração

Opção de atualização da versão do modelo de implantação.

Valor	Description
OnceNewDefaultVersionAvailable
OnceCurrentVersionExpired
NoAutoUpgrade

DeploymentProperties

Object

Propriedades da implantação da conta dos Serviços Cognitivos.

Name	Tipo	Description
callRateLimit	CallRateLimit	A conta de Serviços Cognitivos de limite de taxa de chamada.
capabilities	object	As capacidades.
capacitySettings	DeploymentCapacitySettings	Apenas para uso interno.
currentCapacity	integer (int32)	A capacidade atual.
dynamicThrottlingEnabled	boolean	Se a limitação dinâmica estiver ativada.
model	DeploymentModel	Propriedades do modelo de implantação de conta dos Serviços Cognitivos.
parentDeploymentName	string	O nome da implantação pai.
provisioningState	DeploymentProvisioningState	Obtém o status do recurso no momento em que a operação foi chamada.
raiPolicyName	string	O nome da política RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Propriedades do modelo de implantação de conta dos Serviços Cognitivos. (Preterido, use Deployment.sku em vez disso.)
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Opção de atualização da versão do modelo de implantação.

DeploymentProvisioningState

Enumeração

Obtém o status do recurso no momento em que a operação foi chamada.

Valor	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Disabled
Canceled

DeploymentScaleSettings

Object

Propriedades do modelo de implantação de conta dos Serviços Cognitivos. (Preterido, use Deployment.sku em vez disso.)

Name	Tipo	Description
activeCapacity	integer (int32)	Capacidade ativa de implantação. Esse valor pode ser diferente de `capacity` se o cliente atualizou recentemente `capacity`.
capacity	integer (int32)	Capacidade de implantação.
scaleType	DeploymentScaleType	Tipo de escala de implantação.

DeploymentScaleType

Enumeração

Tipo de escala de implantação.

Valor	Description
Standard
Manual

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

RequestMatchPattern

Object

Name	Tipo	Description
method	string
path	string

Sku

Object

A definição do modelo de recursos que representa a SKU

Name	Tipo	Description
capacity	integer (int32)	Se a SKU suportar scaleout/in, o inteiro de capacidade deve ser incluído. Se a expansão/entrada não for possível para o recurso, isso poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU. Ex - P3. Normalmente, é um código de letra + número
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e algum outro valor, este seria o código autônomo.
tier	SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

SkuTier

Enumeração

Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

Valor	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

ThrottlingRule

Object

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