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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties	DeploymentProperties	Cognitive Services 계정 배포의 속성입니다.
sku	Sku	SKU를 나타내는 리소스 모델 정의
tags	object	리소스 태그.

응답

Name	형식	Description
200 OK	Deployment	배포를 성공적으로 만들기/업데이트합니다.
201 Created	Deployment	배포를 성공적으로 만듭니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

예제

PutDeployment

샘플 요청

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

샘플 응답

상태 코드:

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

정의

Name	Description
CallRateLimit	호출 속도 제한 Cognitive Services 계정입니다.
createdByType	리소스를 만든 ID의 형식입니다.
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 계정입니다.

Name	형식	Description
count	number	호출 속도 제한의 개수 값입니다.
renewalPeriod	number	통화 속도 제한의 갱신 기간(초)입니다.
rules	ThrottlingRule[]

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
Application
Key
ManagedIdentity
User

Deployment

Object

Cognitive Services 계정 배포.

Name	형식	Description
etag	string	리소스 Etag.
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /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

내부 전용입니다.

Name	형식	Description
designatedCapacity	integer (int32) minimum: 0	지정된 용량입니다.
priority	integer (int32) minimum: 0	이 용량 설정의 우선 순위입니다.

DeploymentModel

Object

Cognitive Services 계정 배포 모델의 속성입니다.

Name	형식	Description
callRateLimit	CallRateLimit	호출 속도 제한 Cognitive Services 계정입니다.
format	string	배포 모델 형식입니다.
name	string	배포 모델 이름입니다.
publisher	string	배포 모델 게시자입니다.
source	string	선택적. 배포 모델 원본 ARM 리소스 ID입니다.
sourceAccount	string (arm-id)	선택적. 모델의 원본인 다른 Microsoft.CognitiveServices 계정 ARM 리소스 ID입니다.
version	string	선택적. 배포 모델 버전입니다. 버전을 지정하지 않으면 기본 버전이 할당됩니다. 기본 버전은 모델에 따라 다르며 모델에 사용할 수 있는 새 버전이 있는 경우 변경될 수 있습니다. 모델의 기본 버전은 목록 모델 API에서 찾을 수 있습니다.

DeploymentModelVersionUpgradeOption

열거형

배포 모델 버전 업그레이드 옵션입니다.

값	Description
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Object

Cognitive Services 계정 배포의 속성입니다.

Name	형식	Description
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

열거형

작업이 호출된 시점의 리소스 상태를 가져옵니다.

값	Description
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Object

Cognitive Services 계정 배포 모델의 속성입니다. (사용되지 않음, Deployment.sku를 대신 사용하세요.)

Name	형식	Description
activeCapacity	integer (int32)	배포 활성 용량. 이 값은 고객이 최근에 capacity업데이트한 경우 capacity 다를 수 있습니다.
capacity	integer (int32)	배포 용량.
scaleType	DeploymentScaleType	배포 크기 조정 유형입니다.

DeploymentScaleType

열거형

배포 크기 조정 유형입니다.

값	Description
Manual
Standard

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

RequestMatchPattern

Object

Name	형식	Description
method	string
path	string

Sku

Object

SKU를 나타내는 리소스 모델 정의

Name	형식	Description
capacity	integer (int32)	SKU가 스케일 아웃/인을 지원하는 경우 용량 정수가 포함되어야 합니다. 리소스에 대해 스케일 아웃/인이 불가능한 경우 생략할 수 있습니다.
family	string	서비스에 여러 세대의 하드웨어가 있는 경우 동일한 SKU에 대해 여기에서 캡처할 수 있습니다.
name	string	SKU의 이름입니다. 예 - P3. 일반적으로 letter+number 코드입니다.
size	string	SKU 크기입니다. 이름 필드가 계층과 다른 값의 조합인 경우 독립 실행형 코드입니다.
tier	SkuTier	이 필드는 서비스에 둘 이상의 계층이 있지만 PUT에는 필요하지 않은 경우 리소스 공급자가 구현해야 합니다.

SkuTier

열거형

이 필드는 서비스에 둘 이상의 계층이 있지만 PUT에는 필요하지 않은 경우 리소스 공급자가 구현해야 합니다.

값	Description
Basic
Enterprise
Free
Premium
Standard

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

ThrottlingRule

Object

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