Suppressions - Create

リファレンス

Service:: Advisor

API Version:: 2023-01-01

推奨事項のスヌーズまたは無視された属性を有効にします。スヌーズまたは無視された属性は、抑制と呼ばれます。この API を使用して、推奨事項のスヌーズまたは無視された状態を作成または更新します。

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}?api-version=2023-01-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	抑制の名前。
recommendationId	path	True	string	推奨事項 ID。
resourceUri	path	True	string	推奨事項が適用されるリソースの完全修飾 Azure Resource Manager識別子。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

要求本文

名前	型	説明
properties.suppressionId	string	抑制の GUID。
properties.ttl	string	抑制が有効な期間。

応答

名前	型	説明
200 OK	SuppressionContract	OK です。抑制が正常に作成されました。
404 Not Found	ArmErrorResponse	抑制する推奨事項が見つかりません。
Other Status Codes	ArmErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

CreateSuppression

Sample Request

HTTP

PUT https://management.azure.com/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId/suppressions/suppressionName1?api-version=2023-01-01

{
  "properties": {
    "ttl": "07:00:00:00"
  }
}

Sample Response

Status code:: 200

{
  "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId/suppressions/suppressionName1",
  "name": "suppressionName1",
  "type": "Microsoft.Advisor/suppressions",
  "properties": {
    "suppressionId": "suppressionId",
    "ttl": "07:00:00:00"
  }
}

Status code:: 404

{
  "error": {
    "code": "NotFound",
    "message": "Recommendation to be suppressed is not found. Subscription Id:{0} Recommendation Id:{1}"
  }
}

定義

名前	説明
ArmErrorResponse
ARMErrorResponseBody	ARM エラー応答本文。
createdByType	リソースを作成した ID の種類。
SuppressionContract	スヌーズまたは無視されたルールの詳細。たとえば、ルールに関連付けられている期間、名前、GUID などです。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ArmErrorResponse

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

ARMErrorResponseBody

ARM エラー応答本文。

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

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

SuppressionContract

スヌーズまたは無視されたルールの詳細。たとえば、ルールに関連付けられている期間、名前、GUID などです。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.expirationTimeStamp	string	有効期限のタイムスタンプを取得または設定します。
properties.suppressionId	string	抑制の GUID。
properties.ttl	string	抑制が有効な期間。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

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

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

Share via