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/projects/applications/agentDeployments 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/projects/applications/agentDeployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments@2026-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
agents: [
{
agentId: 'string'
agentName: 'string'
agentVersion: 'string'
}
]
deploymentId: 'string'
description: 'string'
displayName: 'string'
protocols: [
{
protocol: 'string'
version: 'string'
}
]
state: 'string'
tags: {
{customized property}: 'string'
}
deploymentType: 'string'
// For remaining properties, see AgentDeploymentProperties objects
}
}
AgentDeploymentProperties objects
Set the deploymentType property to specify the type of object.
For Hosted, use:
{
deploymentType: 'Hosted'
maxReplicas: int
minReplicas: int
}
For Managed, use:
{
deploymentType: 'Managed'
}
Property Values
Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments
| 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/projects/applications |
| properties | [Required] Additional attributes of the entity. | AgentDeploymentProperties (required) |
AgentDeploymentProperties
| Name | Description | Value |
|---|---|---|
| agents | Returns a flat list of agent:version deployed in this deployment. | VersionedAgentReference[] |
| deploymentId | Gets or sets the unique identifier of the deployment. | string |
| deploymentType | Set to 'Hosted' for type HostedAgentDeployment. Set to 'Managed' for type ManagedAgentDeployment. | 'Hosted' 'Managed' (required) |
| description | The asset description text. | string |
| displayName | Gets or sets the display name of the deployment. | string |
| protocols | Gets or sets the supported protocol types and versions exposed by this deployment. | AgentProtocolVersion[] |
| state | Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). | 'Deleted' 'Deleting' 'Failed' 'Running' 'Starting' 'Stopped' 'Stopping' 'Updating' |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
AgentProtocolVersion
| Name | Description | Value |
|---|---|---|
| protocol | The protocol used by the agent/exposed by a deployment. | 'A2A' 'Agent' 'Responses' |
| version | The version of the protocol. | string |
HostedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Hosted' (required) |
| maxReplicas | Gets or sets the maximum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
| minReplicas | Gets or sets the minimum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
ManagedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Managed' (required) |
ResourceBaseTags
| Name | Description | Value |
|---|
VersionedAgentReference
| Name | Description | Value |
|---|---|---|
| agentId | Gets the agent's unique identifier within the organization (subscription). | string |
| agentName | Gets the agent's name (unique within the project/app). | string |
| agentVersion | Gets the agent's version (unique for each agent lineage). | string |
ARM template resource definition
The accounts/projects/applications/agentDeployments 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/projects/applications/agentDeployments resource, add the following JSON to your template.
{
"type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments",
"apiVersion": "2026-03-01",
"name": "string",
"properties": {
"agents": [
{
"agentId": "string",
"agentName": "string",
"agentVersion": "string"
}
],
"deploymentId": "string",
"description": "string",
"displayName": "string",
"protocols": [
{
"protocol": "string",
"version": "string"
}
],
"state": "string",
"tags": {
"{customized property}": "string"
},
"deploymentType": "string"
// For remaining properties, see AgentDeploymentProperties objects
}
}
AgentDeploymentProperties objects
Set the deploymentType property to specify the type of object.
For Hosted, use:
{
"deploymentType": "Hosted",
"maxReplicas": "int",
"minReplicas": "int"
}
For Managed, use:
{
"deploymentType": "Managed"
}
Property Values
Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-03-01' |
| name | The resource name | string (required) |
| properties | [Required] Additional attributes of the entity. | AgentDeploymentProperties (required) |
| type | The resource type | 'Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments' |
AgentDeploymentProperties
| Name | Description | Value |
|---|---|---|
| agents | Returns a flat list of agent:version deployed in this deployment. | VersionedAgentReference[] |
| deploymentId | Gets or sets the unique identifier of the deployment. | string |
| deploymentType | Set to 'Hosted' for type HostedAgentDeployment. Set to 'Managed' for type ManagedAgentDeployment. | 'Hosted' 'Managed' (required) |
| description | The asset description text. | string |
| displayName | Gets or sets the display name of the deployment. | string |
| protocols | Gets or sets the supported protocol types and versions exposed by this deployment. | AgentProtocolVersion[] |
| state | Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). | 'Deleted' 'Deleting' 'Failed' 'Running' 'Starting' 'Stopped' 'Stopping' 'Updating' |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
AgentProtocolVersion
| Name | Description | Value |
|---|---|---|
| protocol | The protocol used by the agent/exposed by a deployment. | 'A2A' 'Agent' 'Responses' |
| version | The version of the protocol. | string |
HostedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Hosted' (required) |
| maxReplicas | Gets or sets the maximum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
| minReplicas | Gets or sets the minimum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
ManagedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Managed' (required) |
ResourceBaseTags
| Name | Description | Value |
|---|
VersionedAgentReference
| Name | Description | Value |
|---|---|---|
| agentId | Gets the agent's unique identifier within the organization (subscription). | string |
| agentName | Gets the agent's name (unique within the project/app). | string |
| agentVersion | Gets the agent's version (unique for each agent lineage). | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The accounts/projects/applications/agentDeployments 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/projects/applications/agentDeployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments@2026-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
agents = [
{
agentId = "string"
agentName = "string"
agentVersion = "string"
}
]
deploymentId = "string"
description = "string"
displayName = "string"
protocols = [
{
protocol = "string"
version = "string"
}
]
state = "string"
tags = {
{customized property} = "string"
}
deploymentType = "string"
// For remaining properties, see AgentDeploymentProperties objects
}
}
}
AgentDeploymentProperties objects
Set the deploymentType property to specify the type of object.
For Hosted, use:
{
deploymentType = "Hosted"
maxReplicas = int
minReplicas = int
}
For Managed, use:
{
deploymentType = "Managed"
}
Property Values
Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments
| 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/projects/applications |
| properties | [Required] Additional attributes of the entity. | AgentDeploymentProperties (required) |
| type | The resource type | "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments@2026-03-01" |
AgentDeploymentProperties
| Name | Description | Value |
|---|---|---|
| agents | Returns a flat list of agent:version deployed in this deployment. | VersionedAgentReference[] |
| deploymentId | Gets or sets the unique identifier of the deployment. | string |
| deploymentType | Set to 'Hosted' for type HostedAgentDeployment. Set to 'Managed' for type ManagedAgentDeployment. | 'Hosted' 'Managed' (required) |
| description | The asset description text. | string |
| displayName | Gets or sets the display name of the deployment. | string |
| protocols | Gets or sets the supported protocol types and versions exposed by this deployment. | AgentProtocolVersion[] |
| state | Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). | 'Deleted' 'Deleting' 'Failed' 'Running' 'Starting' 'Stopped' 'Stopping' 'Updating' |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
AgentProtocolVersion
| Name | Description | Value |
|---|---|---|
| protocol | The protocol used by the agent/exposed by a deployment. | 'A2A' 'Agent' 'Responses' |
| version | The version of the protocol. | string |
HostedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Hosted' (required) |
| maxReplicas | Gets or sets the maximum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
| minReplicas | Gets or sets the minimum number of replicas for this hosted deployment. | int Constraints: Min value = 0 |
ManagedAgentDeployment
| Name | Description | Value |
|---|---|---|
| deploymentType | Gets or sets the type of deployment for the agent. | 'Managed' (required) |
ResourceBaseTags
| Name | Description | Value |
|---|
VersionedAgentReference
| Name | Description | Value |
|---|---|---|
| agentId | Gets the agent's unique identifier within the organization (subscription). | string |
| agentName | Gets the agent's name (unique within the project/app). | string |
| agentVersion | Gets the agent's version (unique for each agent lineage). | string |