Deployments - Create Or Update

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-10-01

Zaktualizuj stan określonych wdrożeń skojarzonych z kontem usług Cognitive Services.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nazwa konta usług Cognitive Services.
deploymentName	path	True	string	Nazwa wdrożenia skojarzonego z kontem usług Cognitive Services
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties	DeploymentProperties	Właściwości wdrożenia konta usług Cognitive Services.
sku	Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Deployment	Pomyślnie utwórz/zaktualizuj wdrożenie.
201 Created	Deployment	Pomyślnie utwórz wdrożenie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

PutDeployment

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
CallRateLimit	Limit liczby wywołań konta usług Cognitive Services.
createdByType	Typ tożsamości, która utworzyła zasób.
Deployment	Wdrażanie konta usług Cognitive Services.
DeploymentCapacitySettings	Tylko do użytku wewnętrznego.
DeploymentModel	Właściwości modelu wdrażania konta usług Cognitive Services.
DeploymentModelVersionUpgradeOption	Opcja uaktualnienia wersji modelu wdrażania.
DeploymentProperties	Właściwości wdrożenia konta usług Cognitive Services.
DeploymentProvisioningState	Pobiera stan zasobu w momencie wywołania operacji.
DeploymentScaleSettings	Właściwości modelu wdrażania konta usług Cognitive Services. (Przestarzałe, zamiast tego użyj polecenia Deployment.sku).
DeploymentScaleType	Typ skalowania wdrożenia.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
RequestMatchPattern
Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
ThrottlingRule

CallRateLimit

Objekt

Limit liczby wywołań konta usług Cognitive Services.

Nazwa	Typ	Opis
count	number	Wartość licznika limitu liczby wywołań.
renewalPeriod	number	Okres odnawiania w sekundach limitu liczby wywołań.
rules	ThrottlingRule[]

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

Deployment

Objekt

Wdrażanie konta usług Cognitive Services.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	DeploymentProperties	Właściwości wdrożenia konta usług Cognitive Services.
sku	Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Objekt

Tylko do użytku wewnętrznego.

Nazwa	Typ	Opis
designatedCapacity	integer (int32) minimum: 0	Wyznaczona pojemność.
priority	integer (int32) minimum: 0	Priorytet tego ustawienia pojemności.

DeploymentModel

Objekt

Właściwości modelu wdrażania konta usług Cognitive Services.

Nazwa	Typ	Opis
callRateLimit	CallRateLimit	Limit liczby wywołań konta usług Cognitive Services.
format	string	Format modelu wdrażania.
name	string	Nazwa modelu wdrażania.
publisher	string	Wydawca modelu wdrażania.
source	string	Fakultatywny. Identyfikator zasobu usługi ARM źródła modelu wdrażania.
sourceAccount	string (arm-id)	Fakultatywny. Źródło modelu, inne konto Microsoft.CognitiveServices, identyfikator zasobu ARM.
version	string	Fakultatywny. Wersja modelu wdrażania. Jeśli wersja nie zostanie określona, zostanie przypisana domyślna wersja. Wersja domyślna różni się w przypadku różnych modeli i może ulec zmianie, gdy istnieje nowa wersja dostępna dla modelu. Wersję domyślną modelu można znaleźć w interfejsie API modeli listy.

DeploymentModelVersionUpgradeOption

Wyliczanie

Opcja uaktualnienia wersji modelu wdrażania.

Wartość	Opis
NoAutoUpgrade
OnceCurrentVersionExpired
OnceNewDefaultVersionAvailable

DeploymentProperties

Objekt

Właściwości wdrożenia konta usług Cognitive Services.

Nazwa	Typ	Opis
callRateLimit	CallRateLimit	Limit liczby wywołań konta usług Cognitive Services.
capabilities	object	Możliwości.
capacitySettings	DeploymentCapacitySettings	Tylko do użytku wewnętrznego.
currentCapacity	integer (int32)	Bieżąca pojemność.
dynamicThrottlingEnabled	boolean	Jeśli jest włączona dynamiczna ograniczanie przepustowości.
model	DeploymentModel	Właściwości modelu wdrażania konta usług Cognitive Services.
parentDeploymentName	string	Nazwa wdrożenia nadrzędnego.
provisioningState	DeploymentProvisioningState	Pobiera stan zasobu w momencie wywołania operacji.
raiPolicyName	string	Nazwa zasad RAI.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Właściwości modelu wdrażania konta usług Cognitive Services. (Przestarzałe, zamiast tego użyj polecenia Deployment.sku).
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Opcja uaktualnienia wersji modelu wdrażania.

DeploymentProvisioningState

Wyliczanie

Pobiera stan zasobu w momencie wywołania operacji.

Wartość	Opis
Accepted
Canceled
Creating
Deleting
Disabled
Failed
Moving
Succeeded

DeploymentScaleSettings

Objekt

Właściwości modelu wdrażania konta usług Cognitive Services. (Przestarzałe, zamiast tego użyj polecenia Deployment.sku).

Nazwa	Typ	Opis
activeCapacity	integer (int32)	Aktywna pojemność wdrożenia. Ta wartość może się różnić od capacity, jeśli klient niedawno zaktualizował capacity.
capacity	integer (int32)	Pojemność wdrożenia.
scaleType	DeploymentScaleType	Typ skalowania wdrożenia.

DeploymentScaleType

Wyliczanie

Typ skalowania wdrożenia.

Wartość	Opis
Manual
Standard

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

RequestMatchPattern

Objekt

Nazwa	Typ	Opis
method	string
path	string

Sku

Objekt

Definicja modelu zasobów reprezentująca jednostkę SKU

Nazwa	Typ	Opis
capacity	integer (int32)	Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU. Ex - P3. Zazwyczaj jest to kod z literą i cyfrą
size	string	Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod.
tier	SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

SkuTier

Wyliczanie

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

Wartość	Opis
Basic
Enterprise
Free
Premium
Standard

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

ThrottlingRule

Objekt

Nazwa	Typ	Opis
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number