你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Configurations - Create In Resource Group

参考

服务:: Advisor

API 版本:: 2023-01-01

创建/覆盖 Azure 顾问配置。

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

URI 参数

名称	在	必需	类型	说明
configurationName	path	True	ConfigurationName	顾问配置名称。值必须为“default”
resourceGroup	path	True	string	Azure 资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

名称	类型	说明
properties.digests	DigestConfig[]	顾问摘要配置。仅对订阅有效
properties.duration	Duration	顾问低 CPU 利用率评估的最短持续时间。仅对订阅有效。有效值：7 (默认) 、14、21、30、60 或 90。
properties.exclude	boolean	从顾问评估中排除资源。有效值：false (默认值) 或 True。
properties.lowCpuThreshold	CpuThreshold	顾问低 CPU 使用率评估的最低百分比阈值。仅对订阅有效。有效值：5 (默认) 、10、15 或 20。

响应

名称	类型	说明
200 OK	ConfigData	已成功创建/重写配置。
Other Status Codes	ArmErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

PutConfigurations

示例请求

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/default?api-version=2023-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"
      }
    ]
  }
}

示例响应

状态代码:: 200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/v2/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"
      }
    ]
  }
}

定义

名称	说明
ArmErrorResponse
ARMErrorResponseBody	ARM 错误响应正文。
Category	要为其发送摘要的类别。如果未提供类别，则将为所有类别发送摘要。
ConfigData	顾问配置数据结构。
ConfigurationName	顾问配置名称。值必须为“default”
CpuThreshold	顾问低 CPU 使用率评估的最低百分比阈值。仅对订阅有效。有效值：5 (默认) 、10、15 或 20。
createdByType	创建资源的标识类型。
DigestConfig	顾问摘要配置实体
DigestConfigState	摘要配置的状态。
Duration	顾问低 CPU 利用率评估的最短持续时间。仅对订阅有效。有效值：7 (默认) 、14、21、30、60 或 90。
systemData	与资源的创建和上次修改相关的元数据。

ArmErrorResponse

名称	类型	说明
error	ARMErrorResponseBody	ARM 错误响应正文。

ARMErrorResponseBody

ARM 错误响应正文。

名称	类型	说明
code	string	获取或设置可用于以编程方式标识错误的字符串。
message	string	获取或设置详细描述错误并提供调试信息的字符串。

名称	类型	说明
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

ConfigData

顾问配置数据结构。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.digests	DigestConfig[]	顾问摘要配置。仅对订阅有效
properties.duration	Duration	顾问低 CPU 利用率评估的最短持续时间。仅对订阅有效。有效值：7 (默认) 、14、21、30、60 或 90。
properties.exclude	boolean	从顾问评估中排除资源。有效值：false (默认值) 或 True。
properties.lowCpuThreshold	CpuThreshold	顾问低 CPU 使用率评估的最低百分比阈值。仅对订阅有效。有效值：5 (默认) 、10、15 或 20。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ConfigurationName

顾问配置名称。值必须为“default”

名称	类型	说明
default	string

CpuThreshold

顾问低 CPU 使用率评估的最低百分比阈值。仅对订阅有效。有效值：5 (默认) 、10、15 或 20。

名称	类型	说明
10	string
15	string
20	string
5	string

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

顾问摘要配置实体

名称	类型	说明
actionGroupResourceId	string	摘要使用的操作组资源 ID。
categories	Category[]	要为其发送摘要的类别。如果未提供类别，则将为所有类别发送摘要。
frequency	integer	触发摘要的频率（以天为单位）。值必须介于 7 到 30 天（含）之间。
language	string	摘要内容正文的语言。值必须是Azure 门户支持的语言之一的 ISO 639-1 代码。否则，它将转换为一个。默认值为英语 (en) 。
name	string	摘要配置的名称。值不区分大小写，在订阅中必须是唯一的。
state	DigestConfigState	摘要配置的状态。

DigestConfigState

摘要配置的状态。

名称	类型	说明
Active	string
Disabled	string

Duration

顾问低 CPU 利用率评估的最短持续时间。仅对订阅有效。有效值：7 (默认) 、14、21、30、60 或 90。

名称	类型	说明
14	string
21	string
30	string
60	string
7	string
90	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

通过