Configurations - Create In Resource Group
Azure Advisor 構成を作成または上書きします。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/default?api-version=2023-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
configuration
|
path | True |
Advisor 構成名。 値は 'default' である必要があります |
|
resource
|
path | True |
string |
Azure リソース グループの名前。 |
subscription
|
path | True |
string |
Azure サブスクリプション ID。 |
api-version
|
query | True |
string |
クライアント要求で使用される API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.digests |
Advisor ダイジェストの構成。 サブスクリプションに対してのみ有効 |
|
properties.duration |
Advisor の CPU 使用率の低い評価の最小期間。 サブスクリプションに対してのみ有効です。 有効な値: 7 (既定値)、14、21、30、60、または 90。 |
|
properties.exclude |
boolean |
Advisor の評価からリソースを除外します。 有効な値: False (既定値) または True。 |
properties.lowCpuThreshold |
Advisor の CPU 使用率の低い評価の最小割合のしきい値。 サブスクリプションに対してのみ有効です。 有効な値: 5 (既定値)、10、15、または 20。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
構成が正常に作成または上書きされました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
PutConfigurations
要求のサンプル
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"
}
]
}
}
応答のサンプル
{
"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"
}
]
}
}
定義
名前 | 説明 |
---|---|
Arm |
|
ARMError |
ARM エラー応答本文。 |
Category |
ダイジェストを送信するカテゴリ。 カテゴリが指定されていない場合は、すべてのカテゴリに対してダイジェストが送信されます。 |
Config |
Advisor 構成データ構造。 |
Configuration |
Advisor 構成名。 値は 'default' である必要があります |
Cpu |
Advisor の CPU 使用率の低い評価の最小割合のしきい値。 サブスクリプションに対してのみ有効です。 有効な値: 5 (既定値)、10、15、または 20。 |
created |
リソースを作成した ID の種類。 |
Digest |
Advisor Digest 構成エンティティ |
Digest |
ダイジェスト構成の状態。 |
Duration |
Advisor の CPU 使用率の低い評価の最小期間。 サブスクリプションに対してのみ有効です。 有効な値: 7 (既定値)、14、21、30、60、または 90。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
ArmErrorResponse
名前 | 型 | 説明 |
---|---|---|
error |
ARM エラー応答本文。 |
ARMErrorResponseBody
ARM エラー応答本文。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プログラムによってエラーを識別するために使用できる文字列を取得または設定します。 |
message |
string |
エラーを詳細に説明し、デバッグ情報を提供する文字列を取得または設定します。 |
Category
ダイジェストを送信するカテゴリ。 カテゴリが指定されていない場合は、すべてのカテゴリに対してダイジェストが送信されます。
名前 | 型 | 説明 |
---|---|---|
Cost |
string |
|
HighAvailability |
string |
|
OperationalExcellence |
string |
|
Performance |
string |
|
Security |
string |
ConfigData
Advisor 構成データ構造。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
リソースの名前 |
properties.digests |
Advisor ダイジェストの構成。 サブスクリプションに対してのみ有効 |
|
properties.duration |
Advisor の CPU 使用率の低い評価の最小期間。 サブスクリプションに対してのみ有効です。 有効な値: 7 (既定値)、14、21、30、60、または 90。 |
|
properties.exclude |
boolean |
Advisor の評価からリソースを除外します。 有効な値: False (既定値) または True。 |
properties.lowCpuThreshold |
Advisor の CPU 使用率の低い評価の最小割合のしきい値。 サブスクリプションに対してのみ有効です。 有効な値: 5 (既定値)、10、15、または 20。 |
|
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ConfigurationName
Advisor 構成名。 値は 'default' である必要があります
名前 | 型 | 説明 |
---|---|---|
default |
string |
CpuThreshold
Advisor の CPU 使用率の低い評価の最小割合のしきい値。 サブスクリプションに対してのみ有効です。 有効な値: 5 (既定値)、10、15、または 20。
名前 | 型 | 説明 |
---|---|---|
10 |
string |
|
15 |
string |
|
20 |
string |
|
5 |
string |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DigestConfig
Advisor Digest 構成エンティティ
名前 | 型 | 説明 |
---|---|---|
actionGroupResourceId |
string |
ダイジェストで使用されるアクション グループ リソース ID。 |
categories |
Category[] |
ダイジェストを送信するカテゴリ。 カテゴリが指定されていない場合は、すべてのカテゴリに対してダイジェストが送信されます。 |
frequency |
integer |
ダイジェストがトリガーされる頻度 (日数)。 値は、7 日から 30 日までの範囲である必要があります。 |
language |
string |
ダイジェスト コンテンツ本文の言語。 サポートされている言語の 1 つの ISO 639-1 コードAzure portal値にする必要があります。 それ以外の場合は、1 つに変換されます。 既定値は英語 (en) です。 |
name |
string |
ダイジェスト構成の名前。 値では大文字と小文字が区別されず、サブスクリプション内で一意である必要があります。 |
state |
ダイジェスト構成の状態。 |
DigestConfigState
ダイジェスト構成の状態。
名前 | 型 | 説明 |
---|---|---|
Active |
string |
|
Disabled |
string |
Duration
Advisor の 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 |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |