Deployments - Create Or Update

Başvuru

Service:: Azure AI Services

API Version:: 2023-05-01

Bilişsel Hizmetler hesabıyla ilişkili belirtilen dağıtımların durumunu güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string	Bilişsel Hizmetler hesabının adı. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.-]*$`
deploymentName	path	True	string	Bilişsel Hizmetler Hesabı ile ilişkili dağıtımın adı
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties	DeploymentProperties	Bilişsel Hizmetler hesap dağıtımının özellikleri.
sku	Sku	SKU'yu temsil eden kaynak modeli tanımı

Yanıtlar

Name	Tür	Description
200 OK	Deployment	Dağıtımı başarıyla oluşturun/güncelleştirin.
201 Created	Deployment	Dağıtımı başarıyla oluşturun.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

PutDeployment

Sample Request

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

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

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

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

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

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

Tanımlar

Name	Description
CallRateLimit	Çağrı oranı sınırı Bilişsel Hizmetler hesabı.
createdByType	Kaynağı oluşturan kimliğin türü.
Deployment	Bilişsel Hizmetler hesabı dağıtımı.
DeploymentModel	Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.
DeploymentModelVersionUpgradeOption	Dağıtım modeli sürüm yükseltme seçeneği.
DeploymentProperties	Bilişsel Hizmetler hesap dağıtımının özellikleri.
DeploymentProvisioningState	İşlemin çağrıldığı sırada kaynağın durumunu alır.
DeploymentScaleSettings	Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.
DeploymentScaleType	Dağıtım ölçek türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
RequestMatchPattern
Sku	SKU'yu temsil eden kaynak modeli tanımı
SkuTier	Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
ThrottlingRule

CallRateLimit

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

Name	Tür	Description
count	number	Çağrı Hızı Sınırı'nın sayı değeri.
renewalPeriod	number	Arama Hızı Sınırı'nın saniye cinsinden yenileme süresi.
rules	ThrottlingRule[]

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Bilişsel Hizmetler hesabı dağıtımı.

Name	Tür	Description
etag	string	Kaynak Etag'i.
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties	DeploymentProperties	Bilişsel Hizmetler hesap dağıtımının özellikleri.
sku	Sku	SKU'yu temsil eden kaynak modeli tanımı
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

DeploymentModel

Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.

Name	Tür	Description
callRateLimit	CallRateLimit	Çağrı oranı sınırı Bilişsel Hizmetler hesabı.
format	string	Dağıtım modeli biçimi.
name	string	Dağıtım modeli adı.
source	string	İsteğe bağlı. Dağıtım modeli kaynak ARM kaynak kimliği.
version	string	İsteğe bağlı. Dağıtım modeli sürümü. Sürüm belirtilmezse, varsayılan bir sürüm atanır. Varsayılan sürüm farklı modeller için farklıdır ve bir model için yeni sürüm kullanılabilir olduğunda değişebilir. Model için varsayılan sürüm, liste modelleri API'sinden bulunabilir.

DeploymentModelVersionUpgradeOption

Dağıtım modeli sürüm yükseltme seçeneği.

Name	Tür	Description
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

Bilişsel Hizmetler hesap dağıtımının özellikleri.

Name	Tür	Description
callRateLimit	CallRateLimit	Çağrı oranı sınırı Bilişsel Hizmetler hesabı.
capabilities	object	Özellikler.
model	DeploymentModel	Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.
provisioningState	DeploymentProvisioningState	İşlemin çağrıldığı sırada kaynağın durumunu alır.
raiPolicyName	string	RAI ilkesinin adı.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Dağıtım modeli sürüm yükseltme seçeneği.

DeploymentProvisioningState

İşlemin çağrıldığı sırada kaynağın durumunu alır.

Name	Tür	Description
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

Bilişsel Hizmetler hesabı dağıtım modelinin özellikleri.

Name	Tür	Description
activeCapacity	integer	Dağıtım etkin kapasitesi. Bu değer, müşteri tarafından yakın zamanda güncelleştirildiyse `capacity`değerinden `capacity` farklı olabilir.
capacity	integer	Dağıtım kapasitesi.
scaleType	DeploymentScaleType	Dağıtım ölçek türü.

DeploymentScaleType

Dağıtım ölçek türü.

Name	Tür	Description
Manual	string
Standard	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

RequestMatchPattern

Name	Tür	Description
method	string
path	string

Sku

SKU'yu temsil eden kaynak modeli tanımı

Name	Tür	Description
capacity	integer	SKU ölçeği genişletmeyi/daraltma işlemini destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir.
family	string	Hizmetin aynı SKU için farklı nesil donanımları varsa, bu burada yakalanabilir.
name	string	SKU'nun adı. Ex - P3. Bu genellikle letter+number kodudur
size	string	SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olur.
tier	SkuTier	Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

SkuTier

Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

Name	Tür	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

ThrottlingRule

Name	Tür	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number