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

Recommendations - List Recommended Rules For Web App

Service:

App Service

API Version:

2023-12-01

获取应用的所有建议的说明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations?featured={featured}&api-version=2023-12-01&$filter={$filter}

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
siteName	path	True	string	应用的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本
$filter	query		string	仅返回筛选器中指定的通道。 筛选器是使用 OData 语法指定的。 示例：$filter=channel eq 'Api' 或 channel eq 'Notification'
featured	query		boolean	指定 true 以仅返回最关键的建议。 默认值为 false，它将返回所有建议。

响应

名称	类型	说明
200 OK	RecommendationCollection	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

定义

名称	说明
Channels	此建议可以应用的频道列表。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
NotificationLevel	指示此建议的影响程度的级别。
Recommendation	表示由建议引擎生成的建议结果。
RecommendationCollection	建议集合。
ResourceScopeType	此建议适用的资源类型的名称，例如 Subscription、ServerFarm、Site。

Channels

此建议可以应用的频道列表。

名称	类型	说明
All	string
Api	string
Email	string
Notification	string
Webhook	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

NotificationLevel

指示此建议的影响程度的级别。

名称	类型	说明
Critical	string
Information	string
NonUrgentSuggestion	string
Warning	string

Recommendation

表示由建议引擎生成的建议结果。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.actionName	string	此对象建议的操作的名称。
properties.bladeName	string	指向门户上边栏选项卡的深层链接。
properties.categoryTags	string[]	此建议所属的类别标记列表。
properties.channels	Channels	此建议可以应用的频道列表。
properties.creationTime	string	创建此实例时的时间戳。
properties.displayName	string	规则 (的 UI 友好名称) 可能不是唯一的。
properties.enabled	integer	如此 如果此建议仍然有效 (即“可操作”) 。 如果无效，则为 False。
properties.endTime	string	建议引用的范围的结束时间（UTC）。
properties.extensionName	string	门户的扩展名称（如果存在）。
properties.forwardLink	string	将链接转发到与规则关联的外部文档。
properties.isDynamic	boolean	如此 如果这与动态添加的规则相关联
properties.level	NotificationLevel	指示此建议的影响程度的级别。
properties.message	string	建议文本。
properties.nextNotificationTime	string	下一步在 UTC 中通知此建议的时间。 Null 表示永远不会再收到通知。
properties.notificationExpirationTime	string	此通知过期时的 UTC 日期和时间。
properties.notifiedTime	string	实际已通知此实例的 UTC 时间的最后一个时间戳。 Null 表示此建议尚未收到通知。
properties.recommendationId	string	与每个建议对象关联的 GUID 值。
properties.resourceId	string	与此建议对象关联的完整 ARM 资源 ID 字符串。
properties.resourceScope	ResourceScopeType	此建议适用的资源类型的名称，例如 Subscription、ServerFarm、Site。
properties.ruleName	string	规则的唯一名称。
properties.score	number	由规则度量的指标值。
properties.startTime	string	建议引用的范围的开始时间（UTC）。
properties.states	string[]	此建议的状态列表。 如果为 null，则应将其视为“活动”。
type	string	资源类型。

RecommendationCollection

建议集合。

名称	类型	说明
nextLink	string	链接到下一页资源。
value	Recommendation[]	资源集合。

ResourceScopeType

此建议适用的资源类型的名称，例如 Subscription、ServerFarm、Site。

名称	类型	说明
ServerFarm	string
Subscription	string
WebSite	string