Microsoft.CognitiveServices (preview:2025-04-01)

2025/05/06 • 4 updated methods

Deployments_List (updated)
Description :  Gets the deployments associated with the Cognitive Services account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@added_302a31696afa4c82909c1bbb6fb646d5": {
                  "#name": "spilloverDeploymentName",
                  "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of Deployment. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Cognitive Services accounts Deployment and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Get (updated)
Description :  Gets the specified deployments associated with the Cognitive Services account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_f343e39e391e4076bf38c1b4daf63e3f": {
              "#name": "spilloverDeploymentName",
              "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment associated with the Cognitive Services Account ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (updated)
Description :  Update the state of specified deployments associated with the Cognitive Services account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_CreateOrUpdate",
  "$parameters": {
    "deployment": {
      "$properties": {
        "properties": [
          {
            "@added_ab370a80b0584398804b6a28b8014d6b": {
              "#name": "spilloverDeploymentName",
              "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_e9709c532b304fdf90831acab434178b": {
              "#name": "spilloverDeploymentName",
              "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "@added_e8c364e9088e4807a198d25d63d00c40": {
              "#name": "spilloverDeploymentName",
              "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment associated with the Cognitive Services Account ,
Required: True ,
}
string ,
deployment:
{
Description: The deployment properties. ,
Required: True ,
}
{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Update (updated)
Description :  Update specified deployments associated with the Cognitive Services account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_e7d0cc1b865a495981c35f80bb2966d7": {
              "#name": "spilloverDeploymentName",
              "Description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment associated with the Cognitive Services Account ,
Required: True ,
}
string ,
deployment:
{
Description: The deployment properties. ,
Required: True ,
}
{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Resource Etag. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of Cognitive Services account deployment. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the resource at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Disabled: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: Properties of Cognitive Services account deployment model. ,
Required: False ,
}
{
publisher:
{
Description: Deployment model publisher. ,
Required: False ,
}
string ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
source:
{
Description: Optional. Deployment model source ARM resource ID. ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
Description: Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) ,
Required: False ,
}
{
scaleType:
{
Description: Deployment scale type. ,
Enum:
{
Standard: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Deployment capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
activeCapacity:
{
Description: Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
raiPolicyName:
{
Description: The name of RAI policy. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
versionUpgradeOption:
{
Description: Deployment model version upgrade option. ,
Enum:
{
OnceNewDefaultVersionAvailable: No description available. ,
OnceCurrentVersionExpired: No description available. ,
NoAutoUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
currentCapacity:
{
Description: The current capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
capacitySettings:
{
Description: Internal use only. ,
Required: False ,
}
{
designatedCapacity:
{
Description: The designated capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
priority:
{
Description: The priority of this capacity setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
parentDeploymentName:
{
Description: The name of parent deployment. ,
Required: False ,
}
string ,
spilloverDeploymentName:
{
Description: Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}