Microsoft.CognitiveServices accounts/deployments 2023-05-01
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@2023-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
model: {
format: 'string'
name: 'string'
source: 'string'
version: 'string'
}
raiPolicyName: 'string'
scaleSettings: {
capacity: int
scaleType: 'string'
}
versionUpgradeOption: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
}
Property Values
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| source | Optional. Deployment model source 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 |
|---|---|---|
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. | DeploymentScaleSettings |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
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 |
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 Azure AI Studio with a managed virtual network | This template creates a secure Azure AI Studio 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": "2023-05-01",
"name": "string",
"properties": {
"model": {
"format": "string",
"name": "string",
"source": "string",
"version": "string"
},
"raiPolicyName": "string",
"scaleSettings": {
"capacity": "int",
"scaleType": "string"
},
"versionUpgradeOption": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
}
}
Property Values
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| source | Optional. Deployment model source 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 |
|---|---|---|
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. | DeploymentScaleSettings |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
Microsoft.CognitiveServices/accounts/deployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| name | The resource name | string (required) |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties |
| sku | The resource model definition representing SKU | Sku |
| 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 Azure AI Studio with a managed virtual network |
This template creates a secure Azure AI Studio 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@2023-05-01"
name = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
body = jsonencode({
properties = {
model = {
format = "string"
name = "string"
source = "string"
version = "string"
}
raiPolicyName = "string"
scaleSettings = {
capacity = int
scaleType = "string"
}
versionUpgradeOption = "string"
}
})
}
Property Values
DeploymentModel
| Name | Description | Value |
|---|---|---|
| format | Deployment model format. | string |
| name | Deployment model name. | string |
| source | Optional. Deployment model source 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 |
|---|---|---|
| model | Properties of Cognitive Services account deployment model. | DeploymentModel |
| raiPolicyName | The name of RAI policy. | string |
| scaleSettings | Properties of Cognitive Services account deployment model. | DeploymentScaleSettings |
| versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
DeploymentScaleSettings
| Name | Description | Value |
|---|---|---|
| capacity | Deployment capacity. | int |
| scaleType | Deployment scale type. | 'Manual' 'Standard' |
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 |
| type | The resource type | "Microsoft.CognitiveServices/accounts/deployments@2023-05-01" |
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' |