Deployments - Create Or Update

Tjänst:

AI Foundry

API-version:

2025-06-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=2025-06-01

URI-parametrar

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

Begärandetext

Name	Typ	Description
properties	DeploymentProperties	Egenskaper för distribution av Cognitive Services-konton.
sku	Sku	Resursmodelldefinitionen som representerar SKU
tags	object	Resursetiketter.

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

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName?api-version=2025-06-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/2025-06-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="00000000-1111-2222-3333-444444444444",
    )

    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/2025-06-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1004eed4202d64b48157c084fe2830760f8190f4/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-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");
require("dotenv/config");

/**
 * 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/2025-06-01/examples/PutDeployment.json
 */
async function putDeployment() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  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/2025-06-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 = "00000000-1111-2222-3333-444444444444";
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

Exempelsvar

Statuskod:

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

Statuskod:

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	Cognitive Services-kontot för samtalsfrekvensgränsen.
createdByType	Den typ av identitet som skapade resursen.
Deployment	Distribution av Cognitive Services-konto.
DeploymentCapacitySettings	Endast intern användning.
DeploymentModel	Egenskaper för distributionsmodellen för Cognitive Services-kontot.
DeploymentModelVersionUpgradeOption	Uppgraderingsalternativ för distributionsmodellversion.
DeploymentProperties	Egenskaper för distribution av Cognitive Services-konton.
DeploymentProvisioningState	Hämtar status för resursen vid den tidpunkt då operationen anropades.
DeploymentScaleSettings	Egenskaper för distributionsmodellen för Cognitive Services-kontot. (Inaktuell, använd Deployment.sku i stället.)
DeploymentScaleType	Typ av distributionsskala.
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

Objekt

Cognitive Services-kontot för samtalsfrekvensgränsen.

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

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

Deployment

Objekt

Distribution av Cognitive Services-konto.

Name	Typ	Description
etag	string	Resurs-Etag.
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	DeploymentProperties	Egenskaper för distribution av Cognitive Services-konton.
sku	Sku	Resursmodelldefinitionen som representerar SKU
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Objekt

Endast intern användning.

Name	Typ	Description
designatedCapacity	integer (int32) minimum: 0	Den angivna kapaciteten.
priority	integer (int32) minimum: 0	Prioriteten för den här kapacitetsinställningen.

DeploymentModel

Objekt

Egenskaper för distributionsmodellen för Cognitive Services-kontot.

Name	Typ	Description
callRateLimit	CallRateLimit	Cognitive Services-kontot för samtalsfrekvensgränsen.
format	string	Format för distributionsmodell.
name	string	Namn på distributionsmodell.
publisher	string	Utgivare av distributionsmodell.
source	string	Valfritt. ARM-resurs-ID för distributionsmodellens källa.
sourceAccount	string (arm-id)	Valfritt. Modellens källa, ett annat ARM-resurs-ID för Microsoft.CognitiveServices-konton.
version	string	Valfritt. Version av distributionsmodell. Om version inte anges tilldelas en standardversion. Standardversionen är olika för olika modeller och kan ändras när det finns en ny version tillgänglig för en modell. Standardversionen för en modell kan hittas från API:et för listmodeller.

DeploymentModelVersionUpgradeOption

Uppräkning

Uppgraderingsalternativ för distributionsmodellversion.

Värde	Description
OnceNewDefaultVersionAvailable
OnceCurrentVersionExpired
NoAutoUpgrade

DeploymentProperties

Objekt

Egenskaper för distribution av Cognitive Services-konton.

Name	Typ	Description
callRateLimit	CallRateLimit	Cognitive Services-kontot för samtalsfrekvensgränsen.
capabilities	object	Kapaciteten.
capacitySettings	DeploymentCapacitySettings	Endast intern användning.
currentCapacity	integer (int32)	Den nuvarande kapaciteten.
dynamicThrottlingEnabled	boolean	Om den dynamiska begränsningen är aktiverad.
model	DeploymentModel	Egenskaper för distributionsmodellen för Cognitive Services-kontot.
parentDeploymentName	string	Namnet på den överordnade distributionen.
provisioningState	DeploymentProvisioningState	Hämtar status för resursen vid den tidpunkt då operationen anropades.
raiPolicyName	string	Namnet på RAI-principen.
rateLimits	ThrottlingRule[]
scaleSettings	DeploymentScaleSettings	Egenskaper för distributionsmodellen för Cognitive Services-kontot. (Inaktuell, använd Deployment.sku i stället.)
spilloverDeploymentName	string	Anger det distributionsnamn som ska hantera begäranden när begäran annars skulle ha begränsats på grund av att den aktuella dataflödesgränsen för distributionen har nåtts.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Uppgraderingsalternativ för distributionsmodellversion.

DeploymentProvisioningState

Uppräkning

Hämtar status för resursen vid den tidpunkt då operationen anropades.

Värde	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Disabled
Canceled

DeploymentScaleSettings

Objekt

Egenskaper för distributionsmodellen för Cognitive Services-kontot. (Inaktuell, använd Deployment.sku i stället.)

Name	Typ	Description
activeCapacity	integer (int32)	Aktiv kapacitet för distribution. Det här värdet kan skilja sig från capacity om kunden nyligen har uppdaterat capacity.
capacity	integer (int32)	Kapacitet för utbyggnad.
scaleType	DeploymentScaleType	Typ av distributionsskala.

DeploymentScaleType

Uppräkning

Typ av distributionsskala.

Värde	Description
Standard
Manual

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Information om felet.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

RequestMatchPattern

Objekt

Name	Typ	Description
method	string
path	string

Sku

Objekt

Resursmodelldefinitionen som representerar SKU

Name	Typ	Description
capacity	integer (int32)	Om SKU:n stöder utskalning/in bör kapacitets heltal 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

Uppräkning

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.

Värde	Description
Free
Basic
Standard
Premium
Enterprise

systemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för att skapa resurser (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

ThrottlingRule

Objekt

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