Bicep resource definition
The workspaces/capabilityHosts resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File |
Description |
| 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. |
To create a Microsoft.MachineLearningServices/workspaces/capabilityHosts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/capabilityHosts@2026-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
acaEnvironmentConnections: [
'string'
]
aiServicesConnections: [
'string'
]
capabilityHostKind: 'string'
customerSubnet: 'string'
description: 'string'
properties: {
{customized property}: 'string'
}
storageConnections: [
'string'
]
tags: {
{customized property}: 'string'
}
threadStorageConnections: [
'string'
]
vectorStoreConnections: [
'string'
]
}
}
Property Values
Microsoft.MachineLearningServices/workspaces/capabilityHosts
| 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: workspaces |
| properties |
[Required] Additional attributes of the entity. |
CapabilityHostProperties (required) |
CapabilityHostProperties
| Name |
Description |
Value |
| acaEnvironmentConnections |
List of Aca Environment connections. |
string[] |
| aiServicesConnections |
List of AI services connections. |
string[] |
| capabilityHostKind |
Kind of this capability host. |
'Agents' |
| customerSubnet |
Customer subnet info to help set up this capability host. |
string |
| description |
The asset description text. |
string |
| properties |
The asset property dictionary. |
ResourceBaseProperties |
| storageConnections |
List of Storage connections. |
string[] |
| tags |
Tag dictionary. Tags can be added, removed, and updated. |
ResourceBaseTags |
| threadStorageConnections |
List of Thread storage connections. |
string[] |
| vectorStoreConnections |
List of VectorStore connections. |
string[] |
ResourceBaseProperties
ARM template resource definition
The workspaces/capabilityHosts resource type can be deployed with operations that target:
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template |
Description |
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. |
To create a Microsoft.MachineLearningServices/workspaces/capabilityHosts resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/capabilityHosts",
"apiVersion": "2026-05-01",
"name": "string",
"properties": {
"acaEnvironmentConnections": [ "string" ],
"aiServicesConnections": [ "string" ],
"capabilityHostKind": "string",
"customerSubnet": "string",
"description": "string",
"properties": {
"{customized property}": "string"
},
"storageConnections": [ "string" ],
"tags": {
"{customized property}": "string"
},
"threadStorageConnections": [ "string" ],
"vectorStoreConnections": [ "string" ]
}
}
Property Values
Microsoft.MachineLearningServices/workspaces/capabilityHosts
| Name |
Description |
Value |
| apiVersion |
The api version |
'2026-05-01' |
| name |
The resource name |
string (required) |
| properties |
[Required] Additional attributes of the entity. |
CapabilityHostProperties (required) |
| type |
The resource type |
'Microsoft.MachineLearningServices/workspaces/capabilityHosts' |
CapabilityHostProperties
| Name |
Description |
Value |
| acaEnvironmentConnections |
List of Aca Environment connections. |
string[] |
| aiServicesConnections |
List of AI services connections. |
string[] |
| capabilityHostKind |
Kind of this capability host. |
'Agents' |
| customerSubnet |
Customer subnet info to help set up this capability host. |
string |
| description |
The asset description text. |
string |
| properties |
The asset property dictionary. |
ResourceBaseProperties |
| storageConnections |
List of Storage connections. |
string[] |
| tags |
Tag dictionary. Tags can be added, removed, and updated. |
ResourceBaseTags |
| threadStorageConnections |
List of Thread storage connections. |
string[] |
| vectorStoreConnections |
List of VectorStore connections. |
string[] |
ResourceBaseProperties
The workspaces/capabilityHosts resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
To create a Microsoft.MachineLearningServices/workspaces/capabilityHosts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/capabilityHosts@2026-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
acaEnvironmentConnections = [
"string"
]
aiServicesConnections = [
"string"
]
capabilityHostKind = "string"
customerSubnet = "string"
description = "string"
properties = {
{customized property} = "string"
}
storageConnections = [
"string"
]
tags = {
{customized property} = "string"
}
threadStorageConnections = [
"string"
]
vectorStoreConnections = [
"string"
]
}
}
}
Property Values
Microsoft.MachineLearningServices/workspaces/capabilityHosts
| 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: workspaces |
| properties |
[Required] Additional attributes of the entity. |
CapabilityHostProperties (required) |
| type |
The resource type |
"Microsoft.MachineLearningServices/workspaces/capabilityHosts@2026-05-01" |
CapabilityHostProperties
| Name |
Description |
Value |
| acaEnvironmentConnections |
List of Aca Environment connections. |
string[] |
| aiServicesConnections |
List of AI services connections. |
string[] |
| capabilityHostKind |
Kind of this capability host. |
'Agents' |
| customerSubnet |
Customer subnet info to help set up this capability host. |
string |
| description |
The asset description text. |
string |
| properties |
The asset property dictionary. |
ResourceBaseProperties |
| storageConnections |
List of Storage connections. |
string[] |
| tags |
Tag dictionary. Tags can be added, removed, and updated. |
ResourceBaseTags |
| threadStorageConnections |
List of Thread storage connections. |
string[] |
| vectorStoreConnections |
List of VectorStore connections. |
string[] |
ResourceBaseProperties