Deployments - Create Or Update

Service:

Azure AI Services

API Version:

2023-05-01

Aktualisieren Sie den Status der angegebenen Bereitstellungen, die dem Cognitive Services-Konto zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Cognitive Services-Kontos. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
deploymentName	path	True	string	Der Name der Bereitstellung, die dem Cognitive Services-Konto zugeordnet ist
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties	DeploymentProperties	Eigenschaften der Cognitive Services-Kontobereitstellung.
sku	Sku	Die Ressourcenmodelldefinition, die die SKU darstellt

Antworten

Name	Typ	Beschreibung
200 OK	Deployment	Erstellen/Aktualisieren Sie die Bereitstellung erfolgreich.
201 Created	Deployment	Erstellen Sie die Bereitstellung erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

PutDeployment

Sample Request

HTTP

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

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/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

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/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

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/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

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/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

dotnet

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

Definitionen

Name	Beschreibung
CallRateLimit	Das Cognitive Services-Konto für die Anrufratenbegrenzung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Deployment	Bereitstellung eines Cognitive Services-Kontos.
DeploymentModel	Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.
DeploymentModelVersionUpgradeOption	Upgradeoption der Bereitstellungsmodellversion.
DeploymentProperties	Eigenschaften der Cognitive Services-Kontobereitstellung.
DeploymentProvisioningState	Ruft die status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.
DeploymentScaleSettings	Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.
DeploymentScaleType	Bereitstellungsskalierungstyp.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
RequestMatchPattern
Sku	Die Ressourcenmodelldefinition, die die SKU darstellt
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
ThrottlingRule

CallRateLimit

Das Cognitive Services-Konto für die Anrufratenbegrenzung.

Name	Typ	Beschreibung
count	number	Der Count-Wert des Anrufratenlimits.
renewalPeriod	number	Der Verlängerungszeitraum in Sekunden des Anrufratenlimits.
rules	ThrottlingRule[]

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Bereitstellung eines Cognitive Services-Kontos.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	DeploymentProperties	Eigenschaften der Cognitive Services-Kontobereitstellung.
sku	Sku	Die Ressourcenmodelldefinition, die die SKU darstellt
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DeploymentModel

Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.

Name	Typ	Beschreibung
callRateLimit	CallRateLimit	Das Cognitive Services-Konto für die Anrufratenbegrenzung.
format	string	Bereitstellungsmodellformat.
name	string	Name des Bereitstellungsmodells.
source	string	Optional. ARM-Ressourcen-ID der Bereitstellungsmodellquelle.
version	string	Optional. Bereitstellungsmodellversion. Wenn version nicht angegeben wird, wird eine Standardversion zugewiesen. Die Standardversion unterscheidet sich für verschiedene Modelle und kann sich ändern, wenn eine neue Version für ein Modell verfügbar ist. Die Standardversion für ein Modell kann über die Listenmodell-API gefunden werden.

DeploymentModelVersionUpgradeOption

Upgradeoption der Bereitstellungsmodellversion.

Name	Typ	Beschreibung
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

Eigenschaften der Cognitive Services-Kontobereitstellung.

Name	Typ	Beschreibung
callRateLimit	CallRateLimit	Das Cognitive Services-Konto für die Anrufratenbegrenzung.
capabilities	object	Die Funktionen.
model	DeploymentModel	Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.
provisioningState	DeploymentProvisioningState	Ruft die status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.
raiPolicyName	string	Der Name der RAI-Richtlinie.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Upgradeoption der Bereitstellungsmodellversion.

DeploymentProvisioningState

Ruft die status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs ab.

Name	Typ	Beschreibung
Accepted	string
Canceled	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Moving	string
Succeeded	string

DeploymentScaleSettings

Eigenschaften des Cognitive Services-Kontobereitstellungsmodells.

Name	Typ	Beschreibung
activeCapacity	integer	Aktive Bereitstellungskapazität. Dieser Wert kann sich von dem capacity unterscheiden, wenn der Kunde kürzlich aktualisiert hat capacity.
capacity	integer	Bereitstellungskapazität.
scaleType	DeploymentScaleType	Bereitstellungsskalierungstyp.

DeploymentScaleType

Bereitstellungsskalierungstyp.

Name	Typ	Beschreibung
Manual	string
Standard	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

RequestMatchPattern

Name	Typ	Beschreibung
method	string
path	string

Sku

Die Ressourcenmodelldefinition, die die SKU darstellt

Name	Typ	Beschreibung
capacity	integer	Wenn die SKU das Horizontal-/Einskalieren unterstützt, sollte die ganze Kapazität enthalten sein. Wenn das Horizontal-/Einskalieren für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.
name	string	Der Name der SKU. Beispiel: P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Feld name die Kombination aus Ebene und einem anderen Wert ist, ist dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.

Name	Typ	Beschreibung
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

ThrottlingRule

Name	Typ	Beschreibung
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number