Recommendations - List

參考

服務:: Advisor

API 版本:: 2023-01-01

取得訂用帳戶的快取建議。建議是藉由叫用 generateRecommendations 來產生或計算。

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

含選擇性參數:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$filter={$filter}&$top={$top}&$skipToken={$skipToken}

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。
$filter	query		string	要套用至建議的篩選條件。篩選條件可以套用至運算符 ['eq'、'and'、 'or'] 的屬性 ['ResourceId'、'ResourceGroup'、'RecommendationTypeGuid'、'Category']。範例： - $filter=Category eq 'Cost' 和 ResourceGroup eq 'MyResourceGroup'
$skipToken	query		string	要與這個 API 分頁版本搭配使用的頁面接續令牌。
$top	query		integer int32	如果使用此 API 的分頁版本，則每頁的建議數目。

回應

名稱	類型	Description
200 OK	ResourceRecommendationBaseListResult	正常。已成功取得快取的建議。
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	模擬您的用戶帳戶

範例

ListRecommendations

範例要求

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$top=10

範例回覆

狀態碼:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$top=10&$skiptoken=skiptoken",
  "value": [
    {
      "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recGUID1",
      "name": "recGUID1",
      "properties": {
        "category": "HighAvailability",
        "impact": "Medium",
        "impactedField": "Microsoft.Compute/availabilitySets",
        "impactedValue": "armavset",
        "lastUpdated": "2017-02-24T22:24:43.3216408Z",
        "risk": "Warning",
        "remediation": {
          "additionalProperties": {
            "httpMethod": "POST",
            "uri": "uri",
            "details": "link to document"
          }
        },
        "shortDescription": {
          "problem": "To ensure high availability add one or more virtual machines to this availability set",
          "solution": "To ensure high availability add one or more virtual machines to this availability set"
        },
        "resourceMetadata": {
          "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/availabilitysets/abc",
          "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"
            }
          },
          "singular": "Availability set",
          "plural": "Availability sets"
        },
        "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"
    },
    {
      "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recGUID2",
      "name": "recGUID2",
      "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"
        },
        "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"
            }
          },
          "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": "Monitoring agent should be installed on your machines.",
        "label": "Enable monitoring agent",
        "learnMoreLink": "https://link2",
        "potentialBenefits": "Protect and monitor machine"
      },
      "type": "Microsoft.Advisor/recommendations"
    }
  ]
}

定義

名稱	Description
ArmErrorResponse
ARMErrorResponseBody	ARM 錯誤回應本文。
category	建議的類別。
createdByType	建立資源的身分識別類型。
impact	建議的業務影響。
ResourceMetadata	建議資源元數據
ResourceRecommendationBase	Advisor 建議。
ResourceRecommendationBaseListResult	Advisor 建議的清單。
risk	未實作建議的潛在風險。
ShortDescription	建議的摘要。
systemData	與建立和上次修改資源相關的元數據。

ArmErrorResponse

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

ARMErrorResponseBody

ARM 錯誤回應本文。

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

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

createdByType

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

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

impact

建議的業務影響。

名稱	類型	Description
High	string
Low	string
Medium	string

ResourceMetadata

建議資源元數據

名稱	類型	Description
action	object	要檢視資源的動作。
plural	string	資源類型的複數用戶易記名稱。例如：虛擬機
resourceId	string	已評估資源的 Azure 資源識別碼
singular	string	資源類型的單一使用者易記名稱。例如：虛擬機
source	string	產生建議的來源

ResourceRecommendationBase

Advisor 建議。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如“/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	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[]	建議的已取消和關閉規則清單。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ResourceRecommendationBaseListResult

Advisor 建議的清單。

名稱	類型	Description
nextLink	string	用來取得下一頁建議的連結。
value	ResourceRecommendationBase[]	建議清單。

risk

未實作建議的潛在風險。

名稱	類型	Description
Error	string
None	string
Warning	string

ShortDescription

建議的摘要。

名稱	類型	Description
problem	string	建議和建議解決方案所識別的問題或機會。
solution	string	建議和建議解決方案所識別的問題或機會。

systemData

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

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

共用方式為