Share via

Configurations - Create In Resource Group

Service:
Advisor
API Version:
2025-01-01

Create/Overwrite Azure Advisor configuration.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/default?api-version=2025-01-01

URI Parameters

Name In Required Type Description
configurationName
 path True

ConfigurationName

Advisor configuration name. Value must be 'default'
resourceGroup
 path True

string

The name of the Azure resource group.
subscriptionId
 path True

string

The Azure subscription ID.
api-version
 query True

string

The version of the API to be used with the client request.

Request Body

Name Type Description
properties.digests

DigestConfig[]

Advisor digest configuration. Valid only for subscriptions
properties.duration

Duration

Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.
properties.exclude

boolean

Exclude the resource from Advisor evaluations. Valid values: False (default) or True.
properties.lowCpuThreshold

CpuThreshold

Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.

Responses

Name Type Description
200 OK

ConfigData

Successfully created/overwrote configuration.
Other Status Codes

ArmErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

PutConfigurations

Sample request

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/default?api-version=2025-01-01

{
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "digests": [
      {
        "name": "digestConfigName",
        "actionGroupResourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/microsoft.insights/actionGroups/actionGroupName",
        "frequency": 30,
        "categories": [
          "HighAvailability",
          "Security",
          "Performance",
          "Cost",
          "OperationalExcellence"
        ],
        "language": "en",
        "state": "Active"
      }
    ]
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/58c3f667-7a62-4bfd-a658-846493e9a493/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/default",
  "type": "Microsoft.Advisor/configurations",
  "name": "default",
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "digests": [
      {
        "name": "digestConfigName",
        "actionGroupResourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/microsoft.insights/actionGroups/actionGroupName",
        "frequency": 30,
        "categories": [
          "HighAvailability",
          "Security",
          "Performance",
          "Cost",
          "OperationalExcellence"
        ],
        "language": "en",
        "state": "Active"
      }
    ]
  }
}

Definitions

Name Description
ArmErrorResponse
ARMErrorResponseBody

ARM error response body.
Category

Categories to send digest for. If categories are not provided, then digest will be sent for all categories.
ConfigData

The Advisor configuration data structure.
ConfigurationName

Advisor configuration name. Value must be 'default'
CpuThreshold

Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.
createdByType

The type of identity that created the resource.
DigestConfig

Advisor Digest configuration entity
DigestConfigState

State of digest configuration.
Duration

Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.
systemData

Metadata pertaining to creation and last modification of the resource.

ArmErrorResponse

Object
Name Type Description
error

ARMErrorResponseBody

ARM error response body.

ARMErrorResponseBody

Object

ARM error response body.

Name Type Description
code

string

Gets or sets the string that can be used to programmatically identify the error.
message

string

Gets or sets the string that describes the error in detail and provides debugging information.

Category

Enumeration

Categories to send digest for. If categories are not provided, then digest will be sent for all categories.

Value Description
HighAvailability
Security
Performance
Cost
OperationalExcellence

ConfigData

Object

The Advisor configuration data structure.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

The name of the resource
properties.digests

DigestConfig[]

Advisor digest configuration. Valid only for subscriptions
properties.duration

Duration

Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.
properties.exclude

boolean

Exclude the resource from Advisor evaluations. Valid values: False (default) or True.
properties.lowCpuThreshold

CpuThreshold

Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ConfigurationName

Enumeration

Advisor configuration name. Value must be 'default'

Value Description
default

CpuThreshold

Enumeration

Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.

Value Description
5
10
15
20

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

DigestConfig

Object

Advisor Digest configuration entity

Name Type Description
actionGroupResourceId

string

Action group resource id used by digest.
categories

Category[]

Categories to send digest for. If categories are not provided, then digest will be sent for all categories.
frequency

integer (int32)

Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive.
language

string

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).
name

string

Name of digest configuration. Value is case-insensitive and must be unique within a subscription.
state

DigestConfigState

State of digest configuration.

DigestConfigState

Enumeration

State of digest configuration.

Value Description
Active
Disabled

Duration

Enumeration

Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.

Value Description
7
14
21
30
60
90

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.