Deployments - Create Or Update

Ссылка

Служба:: Azure AI Services

Версия API:: 2024-10-01

Обновите состояние указанных развертываний, связанных с учетной записью Cognitive Services.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Имя учетной записи Cognitive Services.
deploymentName	path	True	string	Имя развертывания, связанного с учетной записью Cognitive Services
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Тип	Описание
properties	DeploymentProperties	Свойства развертывания учетной записи Cognitive Services.
sku	Sku	Определение модели ресурсов, представляющее номер SKU
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	Deployment	Создание и обновление развертывания успешно.
201 Created	Deployment	Успешно создайте развертывание.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Примеры

PutDeployment

Образец запроса

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

Пример ответа

Код состояния:: 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"
  }
}

Код состояния:: 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"
  }
}

Определения

Имя	Описание
CallRateLimit	Учетная запись Ограничения частоты вызовов Cognitive Services.
createdByType	Тип удостоверения, создавшего ресурс.
Deployment	Развертывание учетной записи Cognitive Services.
DeploymentCapacitySettings	Только внутреннее использование.
DeploymentModel	Свойства модели развертывания учетной записи Cognitive Services.
DeploymentModelVersionUpgradeOption	Вариант обновления версии модели развертывания.
DeploymentProperties	Свойства развертывания учетной записи Cognitive Services.
DeploymentProvisioningState	Возвращает состояние ресурса во время вызова операции.
DeploymentScaleSettings	Свойства модели развертывания учетной записи Cognitive Services. (Не рекомендуется использовать deployment.sku.)
DeploymentScaleType	Тип масштабирования развертывания.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
RequestMatchPattern
Sku	Определение модели ресурсов, представляющее номер SKU
SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
ThrottlingRule

CallRateLimit

Object

Учетная запись Ограничения частоты вызовов Cognitive Services.

Имя	Тип	Описание
count	number	Значение счетчика ограничения частоты звонков.
renewalPeriod	number	Период продления в секундах ограничения частоты звонков.
rules	ThrottlingRule[]

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

Deployment

Object

Развертывание учетной записи Cognitive Services.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	DeploymentProperties	Свойства развертывания учетной записи Cognitive Services.
sku	Sku	Определение модели ресурсов, представляющее номер SKU
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Object

Только внутреннее использование.

Имя	Тип	Описание
designatedCapacity	integer (int32) minimum: 0	Назначенная емкость.
priority	integer (int32) minimum: 0	Приоритет этого параметра емкости.

DeploymentModel

Object

Свойства модели развертывания учетной записи Cognitive Services.

Имя	Тип	Описание
callRateLimit	CallRateLimit	Учетная запись Ограничения частоты вызовов Cognitive Services.
format	string	Формат модели развертывания.
name	string	Имя модели развертывания.
publisher	string	Издатель модели развертывания.
source	string	Необязательный. Исходный идентификатор ресурса ARM для модели развертывания.
sourceAccount	string (arm-id)	Необязательный. Источник модели, другой учетные записи Microsoft.CognitiveServices, идентификатор ресурса ARM.
version	string	Необязательный. Версия модели развертывания. Если версия не указана, будет назначена версия по умолчанию. Версия по умолчанию отличается для разных моделей и может измениться при наличии новой версии для модели. Версию по умолчанию для модели можно найти в API моделей списков.

DeploymentModelVersionUpgradeOption

Перечисление

Вариант обновления версии модели развертывания.

Значение	Описание
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

Свойства развертывания учетной записи Cognitive Services.

Имя	Тип	Описание
callRateLimit	CallRateLimit	Учетная запись Ограничения частоты вызовов Cognitive Services.
capabilities	object	Возможности.
capacitySettings	DeploymentCapacitySettings	Только внутреннее использование.
currentCapacity	integer (int32)	Текущая емкость.
dynamicThrottlingEnabled	boolean	Если включена динамическая регулирование.
model	DeploymentModel	Свойства модели развертывания учетной записи Cognitive Services.
parentDeploymentName	string	Имя родительского развертывания.
provisioningState	DeploymentProvisioningState	Возвращает состояние ресурса во время вызова операции.
raiPolicyName	string	Имя политики RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Свойства модели развертывания учетной записи Cognitive Services. (Не рекомендуется использовать deployment.sku.)
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Вариант обновления версии модели развертывания.

DeploymentProvisioningState

Перечисление

Возвращает состояние ресурса во время вызова операции.

Значение	Описание
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

Свойства модели развертывания учетной записи Cognitive Services. (Не рекомендуется использовать deployment.sku.)

Имя	Тип	Описание
activeCapacity	integer (int32)	Активная емкость развертывания. Это значение может отличаться от `capacity`, если клиент недавно обновил `capacity`.
capacity	integer (int32)	Емкость развертывания.
scaleType	DeploymentScaleType	Тип масштабирования развертывания.

DeploymentScaleType

Перечисление

Тип масштабирования развертывания.

Значение	Описание
Manual
Standard

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

RequestMatchPattern

Object

Имя	Тип	Описание
method	string
path	string

Sku

Object

Определение модели ресурсов, представляющее номер SKU

Имя	Тип	Описание
capacity	integer (int32)	Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU. Ex - P3. Обычно это код буквы и числа
size	string	Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.
tier	SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

SkuTier

Перечисление

Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

Значение	Описание
Basic
Enterprise
Free
Premium
Standard

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

ThrottlingRule

Object

Имя	Тип	Описание
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number