Recommendations - Get

リファレンス

サービス:: Advisor

API バージョン:: 2023-01-01

キャッシュされた推奨事項の詳細を取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	ResourceRecommendationBase	わかりました。推奨事項の詳細が正常に取得されました。
Other Status Codes	ArmErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

GetRecommendationDetail

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId",
  "name": "recommendationId",
  "properties": {
    "category": "Security",
    "impact": "Medium",
    "impactedField": "Microsoft.Compute/virtualMachines",
    "impactedValue": "armavset",
    "lastUpdated": "2017-02-24T22:24:43.3216408Z",
    "risk": "Warning",
    "shortDescription": {
      "problem": "Monitoring agent should be installed on your machines",
      "solution": "Monitoring agent should be installed on your machines"
    },
    "remediation": {
      "additionalProperties": {
        "httpMethod": "POST",
        "uri": "uri",
        "details": "link to document"
      }
    },
    "resourceMetadata": {
      "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz",
      "source": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Security/assessments/assessmentGuid",
      "action": {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link3",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz"
        }
      },
      "singular": "Virtual machine",
      "plural": "Virtual machines"
    },
    "actions": [
      {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link1",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/subscriptionId"
        }
      }
    ],
    "description": "After enabling Soft Delete, deleted data transitions to a soft deleted state instead of being permanently deleted. When data is overwritten, a soft deleted snapshot is generated to save the state of the overwritten data. You can configure the amount of time soft deleted data is recoverable before it permanently expires.",
    "label": "Enable Soft Delete",
    "learnMoreLink": "https://link2",
    "potentialBenefits": "Save and recover your data when blobs or blob snapshots are accidentally overwritten or deleted"
  },
  "type": "Microsoft.Advisor/recommendations"
}

定義

名前	説明
ArmErrorResponse
ARMErrorResponseBody	ARM エラー応答本文。
category	推奨事項のカテゴリ。
createdByType	リソースを作成した ID の種類。
impact	推奨事項のビジネスへの影響。
ResourceMetadata	レコメンデーションリソースのメタデータ
ResourceRecommendationBase	Advisor の推奨事項。
risk	推奨事項を実装しない潜在的なリスク。
ShortDescription	推奨事項の概要。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ArmErrorResponse

Object

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

ARMErrorResponseBody

Object

ARM エラー応答本文。

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

値	説明
Cost
HighAvailability
OperationalExcellence
Performance
Security

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

impact

列挙

推奨事項のビジネスへの影響。

値	説明
High
Low
Medium

ResourceMetadata

Object

レコメンデーションリソースのメタデータ

名前	型	説明
action	object	リソースを表示するアクション。
plural	string	リソースの種類の複数形のユーザーフレンドリ名。例: 仮想マシン
resourceId	string	評価されたリソースの Azure リソース ID
singular	string	リソースの種類の単一のユーザーフレンドリ名。例: 仮想マシン
source	string	推奨事項が生成されるソース

ResourceRecommendationBase

Object

Advisor の推奨事項。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.actions	object[]	推奨事項を実装するための推奨されるアクションの一覧。
properties.category	category	推奨事項のカテゴリ。
properties.description	string	推奨事項の詳細な説明。
properties.exposedMetadataProperties	object	追加情報を提供するために顧客に公開される推奨事項メタデータプロパティ。
properties.extendedProperties	object	拡張プロパティ
properties.impact	impact	推奨事項のビジネスへの影響。
properties.impactedField	string	Advisor によって識別されるリソースの種類。
properties.impactedValue	string	Advisor によって識別されるリソース。
properties.label	string	推奨事項のラベル。
properties.lastUpdated	string (date-time)	Advisor が推奨事項の有効性を確認した最新の時刻。
properties.learnMoreLink	string	推奨事項と生成ロジックの詳細については、このリンクを参照してください。
properties.metadata	object	推奨事項のメタデータ。
properties.potentialBenefits	string	推奨事項を実装することの潜在的な利点。
properties.recommendationTypeId	string	推奨事項の種類の GUID。
properties.remediation	object	推奨事項を適用する自動化された方法。
properties.resourceMetadata	ResourceMetadata	評価されたリソースのメタデータ
properties.risk	risk	推奨事項を実装しない潜在的なリスク。
properties.shortDescription	ShortDescription	推奨事項の概要。
properties.suppressionIds	string[] (uuid)	推奨事項のスヌーズおよび無視されたルールの一覧。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

risk

列挙

推奨事項を実装しない潜在的なリスク。

値	説明
Error
None
Warning

ShortDescription

Object

推奨事項の概要。

名前	型	説明
problem	string	推奨事項と提案されたソリューションによって識別される問題または機会。
solution	string	推奨事項と提案されたソリューションによって識別される問題または機会。

systemData

Object

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

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

次の方法で共有

Recommendations - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

GetRecommendationDetail

要求のサンプル

応答のサンプル

定義

ArmErrorResponse

ARMErrorResponseBody

category

createdByType

impact

ResourceMetadata

ResourceRecommendationBase

risk

ShortDescription

systemData

その他のリソース