Deployments - Create Or Update

Service:

Azure AI Services

API Version:

2023-05-01

Uppdatera tillståndet för angivna distributioner som är associerade med Cognitive Services-kontot.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Namnet på Cognitive Services-kontot. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
deploymentName	path	True	string	Namnet på distributionen som är associerad med Cognitive Services-kontot
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties	DeploymentProperties	Egenskaper för cognitive services-kontodistribution.
sku	Sku	Resursmodelldefinitionen som representerar SKU

Svar

Name	Typ	Description
200 OK	Deployment	Skapa/uppdatera distributionen.
201 Created	Deployment	Skapa distributionen.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Definitioner

Name	Description
CallRateLimit	Anropsfrekvensen begränsar Cognitive Services-kontot.
createdByType	Den typ av identitet som skapade resursen.
Deployment	Cognitive Services-kontodistribution.
DeploymentModel	Egenskaper för Cognitive Services-kontodistributionsmodellen.
DeploymentModelVersionUpgradeOption	Uppgraderingsalternativ för distributionsmodellversion.
DeploymentProperties	Egenskaper för cognitive services-kontodistribution.
DeploymentProvisioningState	Hämtar status för resursen när åtgärden anropades.
DeploymentScaleSettings	Egenskaper för Cognitive Services-kontodistributionsmodellen.
DeploymentScaleType	Distributionsskalningstyp.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
RequestMatchPattern
Sku	Resursmodelldefinitionen som representerar SKU
SkuTier	Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.
systemData	Metadata som rör skapande och senaste ändring av resursen.
ThrottlingRule

CallRateLimit

Anropsfrekvensen begränsar Cognitive Services-kontot.

Name	Typ	Description
count	number	Antalsvärdet för gräns för samtalsfrekvens.
renewalPeriod	number	Förnyelseperioden i sekunder av samtalsfrekvensgränsen.
rules	ThrottlingRule[]

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Deployment

Cognitive Services-kontodistribution.

Name	Typ	Description
etag	string	Resurs-Etag.
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	DeploymentProperties	Egenskaper för cognitive services-kontodistribution.
sku	Sku	Resursmodelldefinitionen som representerar SKU
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DeploymentModel

Egenskaper för Cognitive Services-kontodistributionsmodellen.

Name	Typ	Description
callRateLimit	CallRateLimit	Anropsfrekvensen begränsar Cognitive Services-kontot.
format	string	Distributionsmodellformat.
name	string	Namn på distributionsmodell.
source	string	Valfritt. ARM-resurs-ID för distributionsmodellkälla.
version	string	Valfritt. Distributionsmodellversion. Om versionen inte anges tilldelas en standardversion. Standardversionen är annorlunda för olika modeller och kan ändras när det finns en ny version tillgänglig för en modell. Det gick att hitta standardversionen för en modell från API:et för listmodeller.

DeploymentModelVersionUpgradeOption

Uppgraderingsalternativ för distributionsmodellversion.

Name	Typ	Description
NoAutoUpgrade	string
OnceCurrentVersionExpired	string
OnceNewDefaultVersionAvailable	string

DeploymentProperties

Egenskaper för cognitive services-kontodistribution.

Name	Typ	Description
callRateLimit	CallRateLimit	Anropsfrekvensen begränsar Cognitive Services-kontot.
capabilities	object	Funktionerna.
model	DeploymentModel	Egenskaper för Cognitive Services-kontodistributionsmodellen.
provisioningState	DeploymentProvisioningState	Hämtar status för resursen när åtgärden anropades.
raiPolicyName	string	Namnet på RAI-principen.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Egenskaper för Cognitive Services-kontodistributionsmodellen.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Uppgraderingsalternativ för distributionsmodellversion.

DeploymentProvisioningState

Hämtar status för resursen när åtgärden anropades.

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

DeploymentScaleSettings

Egenskaper för Cognitive Services-kontodistributionsmodellen.

Name	Typ	Description
activeCapacity	integer	Aktiv kapacitet för distribution. Det här värdet kan skilja sig från capacity om kunden nyligen uppdaterade capacity.
capacity	integer	Distributionskapacitet.
scaleType	DeploymentScaleType	Distributionsskalningstyp.

DeploymentScaleType

Distributionsskalningstyp.

Name	Typ	Description
Manual	string
Standard	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

RequestMatchPattern

Name	Typ	Description
method	string
path	string

Sku

Resursmodelldefinitionen som representerar SKU

Name	Typ	Description
capacity	integer	Om SKU:n har stöd för utskalning/inskalning bör kapacitetsheltalet inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas.
family	string	Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.
name	string	Namnet på SKU:n. Ex - P3. Det är vanligtvis en bokstav+nummerkod
size	string	SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden.
tier	SkuTier	Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.

SkuTier

Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

ThrottlingRule

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