Configurations - Create In Subscription

參考

服務:: Advisor

API 版本:: 2023-01-01

建立/覆寫 Azure Advisor 組態，並同時刪除內含資源群組的所有組態。

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

URI 參數

名稱	位於	必要	類型	Description
configurationName	path	True	ConfigurationName	Advisor 組態名稱。值必須是 'default'
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	類型	Description
properties.digests	DigestConfig[]	Advisor 摘要設定。僅適用於訂用帳戶
properties.duration	Duration	Advisor 低 CPU 使用率評估的最小持續時間。僅適用於訂用帳戶。有效值：7 (預設) 、14、21、30、60 或 90。
properties.exclude	boolean	從 Advisor 評估中排除資源。有效值：False (預設) 或 True。
properties.lowCpuThreshold	CpuThreshold	Advisor 低 CPU 使用率評估的最小百分比閾值。僅適用於訂用帳戶。有效值：5 (預設) 、10、15 或 20。

回應

名稱	類型	Description
200 OK	ConfigData	已成功建立/覆寫設定。
Other Status Codes	ArmErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

PutConfigurations

範例要求

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/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"
      }
    ]
  }
}

定義

名稱	Description
ArmErrorResponse
ARMErrorResponseBody	ARM 錯誤回應本文。
Category	要傳送摘要的類別。如果未提供類別，則會針對所有類別傳送摘要。
ConfigData	Advisor 設定數據結構。
ConfigurationName	Advisor 組態名稱。值必須是 'default'
CpuThreshold	Advisor 低 CPU 使用率評估的最小百分比閾值。僅適用於訂用帳戶。有效值：5 (預設) 、10、15 或 20。
createdByType	建立資源的身分識別類型。
DigestConfig	Advisor 摘要設定實體
DigestConfigState	摘要組態的狀態。
Duration	Advisor 低 CPU 使用率評估的最小持續時間。僅適用於訂用帳戶。有效值：7 (預設) 、14、21、30、60 或 90。
systemData	與建立和上次修改資源相關的元數據。

ArmErrorResponse

名稱	類型	Description
error	ARMErrorResponseBody	ARM 錯誤回應本文。

ARMErrorResponseBody

ARM 錯誤回應本文。

名稱	類型	Description
code	string	取得或設定可用來以程式設計方式識別錯誤的字串。
message	string	取得或設定字串，這個字串會詳細描述錯誤並提供偵錯資訊。

名稱	類型	Description
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

ConfigData

Advisor 設定數據結構。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.digests	DigestConfig[]	Advisor 摘要設定。僅適用於訂用帳戶
properties.duration	Duration	Advisor 低 CPU 使用率評估的最小持續時間。僅適用於訂用帳戶。有效值：7 (預設) 、14、21、30、60 或 90。
properties.exclude	boolean	從 Advisor 評估中排除資源。有效值：False (預設) 或 True。
properties.lowCpuThreshold	CpuThreshold	Advisor 低 CPU 使用率評估的最小百分比閾值。僅適用於訂用帳戶。有效值：5 (預設) 、10、15 或 20。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ConfigurationName

Advisor 組態名稱。值必須是 'default'

名稱	類型	Description
default	string

CpuThreshold

Advisor 低 CPU 使用率評估的最小百分比閾值。僅適用於訂用帳戶。有效值：5 (預設) 、10、15 或 20。

名稱	類型	Description
10	string
15	string
20	string
5	string

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Advisor 摘要設定實體

名稱	類型	Description
actionGroupResourceId	string	摘要所使用的動作群組資源標識碼。
categories	Category[]	要傳送摘要的類別。如果未提供類別，則會針對所有類別傳送摘要。
frequency	integer	摘要的觸發頻率，以天為單位。值必須介於 7 到 30 天之間。
language	string	摘要內容本文的語言。值必須是其中一種 Azure 入口網站支援語言的 ISO 639-1 代碼。否則，它會轉換成一個。默認值為 english (en) 。
name	string	摘要組態的名稱。值不區分大小寫，而且在訂用帳戶內必須是唯一的。
state	DigestConfigState	摘要組態的狀態。

DigestConfigState

摘要組態的狀態。

名稱	類型	Description
Active	string
Disabled	string

Duration

Advisor 低 CPU 使用率評估的最小持續時間。僅適用於訂用帳戶。有效值：7 (預設) 、14、21、30、60 或 90。

名稱	類型	Description
14	string
21	string
30	string
60	string
7	string
90	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為