你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 资源管理器标识符。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

响应

名称	类型	说明
200 OK	ResourceRecommendationBase	没问题。已成功获取建议详细信息。
Other Status Codes	ArmErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 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	创建资源的标识类型。
impact	建议的业务影响。
ResourceMetadata	建议资源元数据
ResourceRecommendationBase	顾问建议。
risk	未实施建议的潜在风险。
ShortDescription	建议摘要。
systemData	与资源的创建和上次修改相关的元数据。

ArmErrorResponse

名称	类型	说明
error	ARMErrorResponseBody	ARM 错误响应正文。

ARMErrorResponseBody

ARM 错误响应正文。

名称	类型	说明
code	string	获取或设置可用于以编程方式标识错误的字符串。
message	string	获取或设置详细描述错误并提供调试信息的字符串。

名称	类型	说明
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

impact

建议的业务影响。

名称	类型	说明
High	string
Low	string
Medium	string

ResourceMetadata

建议资源元数据

名称	类型	说明
action	object	用于查看资源的操作。
plural	string	资源类型的复数用户友好名称。例如：虚拟机
resourceId	string	已评估资源的 Azure 资源 ID
singular	string	资源类型的单一用户友好名称。例如：虚拟机
source	string	生成建议的源

ResourceRecommendationBase

顾问建议。

名称	类型	说明
id	string	资源的完全限定的资源 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	顾问标识的资源类型。
properties.impactedValue	string	顾问标识的资源。
properties.label	string	建议的标签。
properties.lastUpdated	string	顾问最近检查建议的有效性的时间。
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	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

risk

未实施建议的潜在风险。

名称	类型	说明
Error	string
None	string
Warning	string

ShortDescription

建议摘要。

名称	类型	说明
problem	string	建议和建议的解决方案确定的问题或机会。
solution	string	建议和建议的解决方案确定的问题或机会。

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

通过