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 configurations resource type can be deployed with operations that target:
- Subscription - See subscription deployment commands* 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.Advisor/configurations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Advisor/configurations@2025-05-01-preview' = {
name: 'string'
properties: {
digests: [
{
actionGroupResourceId: 'string'
categories: [
'string'
]
frequency: int
language: 'string'
name: 'string'
state: 'string'
}
]
duration: 'string'
exclude: bool
lowCpuThreshold: 'string'
}
}
Property Values
Microsoft.Advisor/configurations
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| properties | The Advisor configuration data structure. | ConfigDataProperties |
ConfigDataProperties
| Name | Description | Value |
|---|---|---|
| digests | Advisor digest configuration. Valid only for subscriptions | DigestConfig[] |
| duration | Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. | '14' '21' '30' '60' '7' '90' |
| exclude | Exclude the resource from Advisor evaluations. Valid values: False (default) or True. | bool |
| lowCpuThreshold | Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. | '10' '15' '20' '5' |
DigestConfig
| Name | Description | Value |
|---|---|---|
| actionGroupResourceId | Action group resource id used by digest. | string |
| categories | Categories to send digest for. If categories are not provided, then digest will be sent for all categories. | String array containing any of: 'Cost' 'HighAvailability' 'OperationalExcellence' 'Performance' 'Security' |
| frequency | Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. | int |
| language | Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). | string |
| name | Name of digest configuration. Value is case-insensitive and must be unique within a subscription. | string |
| state | State of digest configuration. | 'Active' 'Disabled' |
ARM template resource definition
The configurations resource type can be deployed with operations that target:
- Subscription - See subscription deployment commands* 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.Advisor/configurations resource, add the following JSON to your template.
{
"type": "Microsoft.Advisor/configurations",
"apiVersion": "2025-05-01-preview",
"name": "string",
"properties": {
"digests": [
{
"actionGroupResourceId": "string",
"categories": [ "string" ],
"frequency": "int",
"language": "string",
"name": "string",
"state": "string"
}
],
"duration": "string",
"exclude": "bool",
"lowCpuThreshold": "string"
}
}
Property Values
Microsoft.Advisor/configurations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-05-01-preview' |
| name | The resource name | 'default' (required) |
| properties | The Advisor configuration data structure. | ConfigDataProperties |
| type | The resource type | 'Microsoft.Advisor/configurations' |
ConfigDataProperties
| Name | Description | Value |
|---|---|---|
| digests | Advisor digest configuration. Valid only for subscriptions | DigestConfig[] |
| duration | Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. | '14' '21' '30' '60' '7' '90' |
| exclude | Exclude the resource from Advisor evaluations. Valid values: False (default) or True. | bool |
| lowCpuThreshold | Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. | '10' '15' '20' '5' |
DigestConfig
| Name | Description | Value |
|---|---|---|
| actionGroupResourceId | Action group resource id used by digest. | string |
| categories | Categories to send digest for. If categories are not provided, then digest will be sent for all categories. | String array containing any of: 'Cost' 'HighAvailability' 'OperationalExcellence' 'Performance' 'Security' |
| frequency | Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. | int |
| language | Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). | string |
| name | Name of digest configuration. Value is case-insensitive and must be unique within a subscription. | string |
| state | State of digest configuration. | 'Active' 'Disabled' |
Usage Examples
Terraform (AzAPI provider) resource definition
The configurations resource type can be deployed with operations that target:
- Subscription* Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Advisor/configurations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Advisor/configurations@2025-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
digests = [
{
actionGroupResourceId = "string"
categories = [
"string"
]
frequency = int
language = "string"
name = "string"
state = "string"
}
]
duration = "string"
exclude = bool
lowCpuThreshold = "string"
}
}
}
Property Values
Microsoft.Advisor/configurations
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| properties | The Advisor configuration data structure. | ConfigDataProperties |
| type | The resource type | "Microsoft.Advisor/configurations@2025-05-01-preview" |
ConfigDataProperties
| Name | Description | Value |
|---|---|---|
| digests | Advisor digest configuration. Valid only for subscriptions | DigestConfig[] |
| duration | Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. | '14' '21' '30' '60' '7' '90' |
| exclude | Exclude the resource from Advisor evaluations. Valid values: False (default) or True. | bool |
| lowCpuThreshold | Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. | '10' '15' '20' '5' |
DigestConfig
| Name | Description | Value |
|---|---|---|
| actionGroupResourceId | Action group resource id used by digest. | string |
| categories | Categories to send digest for. If categories are not provided, then digest will be sent for all categories. | String array containing any of: 'Cost' 'HighAvailability' 'OperationalExcellence' 'Performance' 'Security' |
| frequency | Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. | int |
| language | Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). | string |
| name | Name of digest configuration. Value is case-insensitive and must be unique within a subscription. | string |
| state | State of digest configuration. | 'Active' 'Disabled' |