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 observabilityAgents 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.Monitor/observabilityAgents resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Monitor/observabilityAgents@2026-05-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
enabled: bool
monitoringAccountId: 'string'
operations: [
{
instructions: 'string'
mode: 'string'
type: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Monitor/observabilityAgents
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{1,63}$)(?!-)[a-zA-Z0-9-]*[a-zA-Z0-9]$ (required) |
| properties | Resource properties | ObservabilityAgentProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
ObservabilityAgentProperties
| Name | Description | Value |
|---|---|---|
| enabled | Whether the observability agent is enabled. Defaults to true when not specified. | bool |
| monitoringAccountId | Resource ID of the Azure Monitor workspace where this agent stores the issues it produces. | string (required) |
| operations | Configuration overrides for agent operations. When omitted, default behavior applies for all operations. | OperationEntry[] |
OperationEntry
| Name | Description | Value |
|---|---|---|
| instructions | Custom instructions that guide the agent's behavior for this operation. | string Constraints: Max length = 8192 |
| mode | Execution mode for this operation. Defaults to Auto when not specified. | 'Auto' 'Manual' |
| type | Type of operation. | 'Investigation' 'IssueCreation' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The observabilityAgents 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.
Usage Examples
Resource format
To create a Microsoft.Monitor/observabilityAgents resource, add the following JSON to your template.
{
"type": "Microsoft.Monitor/observabilityAgents",
"apiVersion": "2026-05-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"enabled": "bool",
"monitoringAccountId": "string",
"operations": [
{
"instructions": "string",
"mode": "string",
"type": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Monitor/observabilityAgents
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-05-01-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{1,63}$)(?!-)[a-zA-Z0-9-]*[a-zA-Z0-9]$ (required) |
| properties | Resource properties | ObservabilityAgentProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Monitor/observabilityAgents' |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
ObservabilityAgentProperties
| Name | Description | Value |
|---|---|---|
| enabled | Whether the observability agent is enabled. Defaults to true when not specified. | bool |
| monitoringAccountId | Resource ID of the Azure Monitor workspace where this agent stores the issues it produces. | string (required) |
| operations | Configuration overrides for agent operations. When omitted, default behavior applies for all operations. | OperationEntry[] |
OperationEntry
| Name | Description | Value |
|---|---|---|
| instructions | Custom instructions that guide the agent's behavior for this operation. | string Constraints: Max length = 8192 |
| mode | Execution mode for this operation. Defaults to Auto when not specified. | 'Auto' 'Manual' |
| type | Type of operation. | 'Investigation' 'IssueCreation' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The observabilityAgents 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.Monitor/observabilityAgents resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Monitor/observabilityAgents@2026-05-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
enabled = bool
monitoringAccountId = "string"
operations = [
{
instructions = "string"
mode = "string"
type = "string"
}
]
}
}
}
Property Values
Microsoft.Monitor/observabilityAgents
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{1,63}$)(?!-)[a-zA-Z0-9-]*[a-zA-Z0-9]$ (required) |
| properties | Resource properties | ObservabilityAgentProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Monitor/observabilityAgents@2026-05-01-preview" |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
ObservabilityAgentProperties
| Name | Description | Value |
|---|---|---|
| enabled | Whether the observability agent is enabled. Defaults to true when not specified. | bool |
| monitoringAccountId | Resource ID of the Azure Monitor workspace where this agent stores the issues it produces. | string (required) |
| operations | Configuration overrides for agent operations. When omitted, default behavior applies for all operations. | OperationEntry[] |
OperationEntry
| Name | Description | Value |
|---|---|---|
| instructions | Custom instructions that guide the agent's behavior for this operation. | string Constraints: Max length = 8192 |
| mode | Execution mode for this operation. Defaults to Auto when not specified. | 'Auto' 'Manual' |
| type | Type of operation. | 'Investigation' 'IssueCreation' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|