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 パラメーター

名前	/	必須	型	説明
configurationName	path	True	ConfigurationName	Advisor 構成名。値は 'default' である必要があります
subscriptionId	path	True	string	Azure サブスクリプション ID。
api-version	query	True	string	クライアント要求で使用する API のバージョン。

要求本文

名前	型	説明
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。

応答

名前	型	説明
200 OK	ConfigData	構成が正常に作成または上書きされました。
Other Status Codes	ArmErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
      }
    ]
  }
}

定義

名前	説明
ArmErrorResponse
ARMErrorResponseBody	ARM エラー応答本文。
Category	ダイジェストを送信するカテゴリ。カテゴリが指定されていない場合は、すべてのカテゴリに対してダイジェストが送信されます。
ConfigData	Advisor 構成データ構造。
ConfigurationName	Advisor 構成名。値は 'default' である必要があります
CpuThreshold	Advisor の CPU 使用率が低い評価の最小割合のしきい値。サブスクリプションに対してのみ有効です。有効な値: 5 (既定値)、10、15、または 20。
createdByType	リソースを作成した ID の種類。
DigestConfig	Advisor Digest 構成エンティティ
DigestConfigState	ダイジェスト構成の状態。
Duration	Advisor の CPU 使用率が低い評価の最小期間。サブスクリプションに対してのみ有効です。有効な値: 7 (既定値)、14、21、30、60、または 90。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ArmErrorResponse

Object

名前	型	説明
error	ARMErrorResponseBody	ARM エラー応答本文。

ARMErrorResponseBody

Object

ARM エラー応答本文。

名前	型	説明
code	string	プログラムでエラーを識別するために使用できる文字列を取得または設定します。
message	string	エラーの詳細を説明し、デバッグ情報を提供する文字列を取得または設定します。

値	説明
Cost
HighAvailability
OperationalExcellence
Performance
Security

ConfigData

Object

Advisor 構成データ構造。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/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	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ConfigurationName

列挙

Advisor 構成名。値は 'default' である必要があります

値	説明
default

CpuThreshold

列挙

Advisor の CPU 使用率が低い評価の最小割合のしきい値。サブスクリプションに対してのみ有効です。有効な値: 5 (既定値)、10、15、または 20。

値	説明
10
15
20
5

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DigestConfig

Object

Advisor Digest 構成エンティティ

名前	型	説明
actionGroupResourceId	string	ダイジェストによって使用されるアクショングループのリソース ID。
categories	Category[]	ダイジェストを送信するカテゴリ。カテゴリが指定されていない場合は、すべてのカテゴリに対してダイジェストが送信されます。
frequency	integer (int32)	ダイジェストがトリガーされる頻度 (日数)。値は、7 日から 30 日までの範囲である必要があります。
language	string	ダイジェストコンテンツ本文の言語。 Azure portal でサポートされている言語の 1 つに対して ISO 639-1 コードを指定する必要があります。それ以外の場合は、1 に変換されます。既定値は英語 (en) です。
name	string	ダイジェスト構成の名前。値では大文字と小文字が区別されず、サブスクリプション内で一意である必要があります。
state	DigestConfigState	ダイジェスト構成の状態。

DigestConfigState

列挙

ダイジェスト構成の状態。

値	説明
Active
Disabled

Duration

列挙

Advisor の CPU 使用率が低い評価の最小期間。サブスクリプションに対してのみ有効です。有効な値: 7 (既定値)、14、21、30、60、または 90。

値	説明
14
21
30
60
7
90

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Configurations - Create In Subscription

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

PutConfigurations

要求のサンプル

応答のサンプル

定義

ArmErrorResponse

ARMErrorResponseBody

Category

ConfigData

ConfigurationName

CpuThreshold

createdByType

DigestConfig

DigestConfigState

Duration

systemData

その他のリソース