Deployments - Create Or Update

Update the state of specified deployments associated with the Cognitive Services account.

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

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of Cognitive Services account.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

deploymentName
path True

string

The name of the deployment associated with the Cognitive Services Account

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
properties

DeploymentProperties

Properties of Cognitive Services account deployment.

sku

Sku

The resource model definition representing SKU

tags

object

Resource tags.

Responses

Name Type Description
200 OK

Deployment

Create/Update the deployment successfully.

201 Created

Deployment

Create the deployment successfully.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

PutDeployment

Sample request

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

Sample response

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

Definitions

Name Description
CallRateLimit

The call rate limit Cognitive Services account.

createdByType

The type of identity that created the resource.

Deployment

Cognitive Services account deployment.

DeploymentCapacitySettings

Internal use only.

DeploymentModel

Properties of Cognitive Services account deployment model.

DeploymentModelVersionUpgradeOption

Deployment model version upgrade option.

DeploymentProperties

Properties of Cognitive Services account deployment.

DeploymentProvisioningState

Gets the status of the resource at the time the operation was called.

DeploymentScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)

DeploymentScaleType

Deployment scale type.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

RequestMatchPattern
Sku

The resource model definition representing SKU

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

systemData

Metadata pertaining to creation and last modification of the resource.

ThrottlingRule

CallRateLimit

The call rate limit Cognitive Services account.

Name Type Description
count

number

The count value of Call Rate Limit.

renewalPeriod

number

The renewal period in seconds of Call Rate Limit.

rules

ThrottlingRule[]

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Deployment

Cognitive Services account deployment.

Name Type Description
etag

string

Resource Etag.

id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties

DeploymentProperties

Properties of Cognitive Services account deployment.

sku

Sku

The resource model definition representing SKU

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DeploymentCapacitySettings

Internal use only.

Name Type Description
designatedCapacity

integer

The designated capacity.

priority

integer

The priority of this capacity setting.

DeploymentModel

Properties of Cognitive Services account deployment model.

Name Type Description
callRateLimit

CallRateLimit

The call rate limit Cognitive Services account.

format

string

Deployment model format.

name

string

Deployment model name.

publisher

string

Deployment model publisher.

source

string

Optional. Deployment model source ARM resource ID.

sourceAccount

string

Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID.

version

string

Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.

DeploymentModelVersionUpgradeOption

Deployment model version upgrade option.

Name Type Description
NoAutoUpgrade

string

OnceCurrentVersionExpired

string

OnceNewDefaultVersionAvailable

string

DeploymentProperties

Properties of Cognitive Services account deployment.

Name Type Description
callRateLimit

CallRateLimit

The call rate limit Cognitive Services account.

capabilities

object

The capabilities.

capacitySettings

DeploymentCapacitySettings

Internal use only.

currentCapacity

integer

The current capacity.

dynamicThrottlingEnabled

boolean

If the dynamic throttling is enabled.

model

DeploymentModel

Properties of Cognitive Services account deployment model.

parentDeploymentName

string

The name of parent deployment.

provisioningState

DeploymentProvisioningState

Gets the status of the resource at the time the operation was called.

raiPolicyName

string

The name of RAI policy.

rateLimits

ThrottlingRule[]

scaleSettings

DeploymentScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)

versionUpgradeOption

DeploymentModelVersionUpgradeOption

Deployment model version upgrade option.

DeploymentProvisioningState

Gets the status of the resource at the time the operation was called.

Name Type Description
Accepted

string

Canceled

string

Creating

string

Deleting

string

Disabled

string

Failed

string

Moving

string

Succeeded

string

DeploymentScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)

Name Type Description
activeCapacity

integer

Deployment active capacity. This value might be different from capacity if customer recently updated capacity.

capacity

integer

Deployment capacity.

scaleType

DeploymentScaleType

Deployment scale type.

DeploymentScaleType

Deployment scale type.

Name Type Description
Manual

string

Standard

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

RequestMatchPattern

Name Type Description
method

string

path

string

Sku

The resource model definition representing SKU

Name Type Description
capacity

integer

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family

string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

name

string

The name of the SKU. Ex - P3. It is typically a letter+number code

size

string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name Type Description
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

ThrottlingRule

Name Type Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number