Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The accounts/deployments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CognitiveServices/accounts/deployments@2025-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
capacitySettings: {
designatedCapacity: int
priority: int
}
currentCapacity: int
model: {
format: 'string'
name: 'string'
publisher: 'string'
source: 'string'
sourceAccount: 'string'
version: 'string'
}
parentDeploymentName: 'string'
raiPolicyName: 'string'
scaleSettings: {
capacity: int
scaleType: 'string'
}
spilloverDeploymentName: 'string'
versionUpgradeOption: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
DeploymentCapacitySettings
| Name | Description | Value |
|---|---|---|
| designatedCapacity | The designated capacity. | int Constraints: Min value = 0 |
| priority | The priority of this capacity setting. | int Constraints: Min value = 0 |
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| publisher | Deployment model publisher. | string |
| source | Optional. Deployment model source ARM resource ID. | string |
| sourceAccount | Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. | string |
| version | 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. | string |
DeploymentProperties
| Name | Description | Value |
|---|---|---|
| capacitySettings | Internal use only. | DeploymentCapacitySettings |
| currentCapacity | The current capacity. | int |
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| parentDeploymentName | The name of parent deployment. | string |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) | DeploymentScaleSettings |
| spilloverDeploymentName | Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. | string |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
DeploymentTags
| Name | Description | Value |
|---|
Microsoft.CognitiveServices/accounts/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: accounts |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | 'Basic' 'Enterprise' 'Free' 'Premium' 'Standard' |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Basic Agent Setup API Keys | This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using API keys authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources. |
| Basic Agent Setup Identity | This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using managed identity authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources. |
| Deploy Secure AI Foundry with a managed virtual network | This template creates a secure Azure AI Foundry environment with robust network and identity security restrictions. |
| Network Secured Agent with User Managed Identity | This set of templates demonstrates how to set up Azure AI Agent Service with virtual network isolation using User Managed Identity authetication for the AI Service/AOAI connection and private network links to connect the agent to your secure data. |
| Standard Agent Setup | This set of templates demonstrates how to set up Azure AI Agent Service with the standard setup, meaning with managed identity authentication for project/hub connections and public internet access enabled. Agents use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you will incur costs based on your usage. |
ARM template resource definition
The accounts/deployments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following JSON to your template.
{
"type": "Microsoft.CognitiveServices/accounts/deployments",
"apiVersion": "2025-04-01-preview",
"name": "string",
"properties": {
"capacitySettings": {
"designatedCapacity": "int",
"priority": "int"
},
"currentCapacity": "int",
"model": {
"format": "string",
"name": "string",
"publisher": "string",
"source": "string",
"sourceAccount": "string",
"version": "string"
},
"parentDeploymentName": "string",
"raiPolicyName": "string",
"scaleSettings": {
"capacity": "int",
"scaleType": "string"
},
"spilloverDeploymentName": "string",
"versionUpgradeOption": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
DeploymentCapacitySettings
| Name | Description | Value |
|---|---|---|
| designatedCapacity | The designated capacity. | int Constraints: Min value = 0 |
| priority | The priority of this capacity setting. | int Constraints: Min value = 0 |
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| publisher | Deployment model publisher. | string |
| source | Optional. Deployment model source ARM resource ID. | string |
| sourceAccount | Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. | string |
| version | 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. | string |
DeploymentProperties
| Name | Description | Value |
|---|---|---|
| capacitySettings | Internal use only. | DeploymentCapacitySettings |
| currentCapacity | The current capacity. | int |
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| parentDeploymentName | The name of parent deployment. | string |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) | DeploymentScaleSettings |
| spilloverDeploymentName | Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. | string |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
DeploymentTags
| Name | Description | Value |
|---|
Microsoft.CognitiveServices/accounts/deployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-04-01-preview' |
| name | The resource name | string (required) |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.CognitiveServices/accounts/deployments' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | 'Basic' 'Enterprise' 'Free' 'Premium' 'Standard' |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Basic Agent Setup API Keys |
This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using API keys authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources. |
| Basic Agent Setup Identity |
This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using managed identity authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources. |
| Deploy Secure AI Foundry with a managed virtual network |
This template creates a secure Azure AI Foundry environment with robust network and identity security restrictions. |
| Network Secured Agent with User Managed Identity |
This set of templates demonstrates how to set up Azure AI Agent Service with virtual network isolation using User Managed Identity authetication for the AI Service/AOAI connection and private network links to connect the agent to your secure data. |
| Standard Agent Setup |
This set of templates demonstrates how to set up Azure AI Agent Service with the standard setup, meaning with managed identity authentication for project/hub connections and public internet access enabled. Agents use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you will incur costs based on your usage. |
Terraform (AzAPI provider) resource definition
The accounts/deployments resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CognitiveServices/accounts/deployments@2025-04-01-preview"
name = "string"
parent_id = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
capacitySettings = {
designatedCapacity = int
priority = int
}
currentCapacity = int
model = {
format = "string"
name = "string"
publisher = "string"
source = "string"
sourceAccount = "string"
version = "string"
}
parentDeploymentName = "string"
raiPolicyName = "string"
scaleSettings = {
capacity = int
scaleType = "string"
}
spilloverDeploymentName = "string"
versionUpgradeOption = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
DeploymentCapacitySettings
| Name | Description | Value |
|---|---|---|
| designatedCapacity | The designated capacity. | int Constraints: Min value = 0 |
| priority | The priority of this capacity setting. | int Constraints: Min value = 0 |
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| publisher | Deployment model publisher. | string |
| source | Optional. Deployment model source ARM resource ID. | string |
| sourceAccount | Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. | string |
| version | 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. | string |
DeploymentProperties
| Name | Description | Value |
|---|---|---|
| capacitySettings | Internal use only. | DeploymentCapacitySettings |
| currentCapacity | The current capacity. | int |
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| parentDeploymentName | The name of parent deployment. | string |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) | DeploymentScaleSettings |
| spilloverDeploymentName | Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. | string |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
DeploymentTags
| Name | Description | Value |
|---|
Microsoft.CognitiveServices/accounts/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: accounts |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.CognitiveServices/accounts/deployments@2025-04-01-preview" |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | 'Basic' 'Enterprise' 'Free' 'Premium' 'Standard' |