Recommendations - Get Rule Details By Web App

Service:

App Service

API Version:

2023-12-01

Description for Get a recommendation rule for an app.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the recommendation.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
siteName	path	True	string	Name of the app.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version
recommendationId	query		string	The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.
updateSeen	query		boolean	Specify true to update the last-seen timestamp of the recommendation object.

Responses

Name	Type	Description
200 OK	RecommendationRule	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
Channels	List of channels that this recommendation can apply.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
NotificationLevel	Level indicating how critical this recommendation can impact.
RecommendationRule	Represents a recommendation rule that the recommendation engine can perform.

Channels

List of channels that this recommendation can apply.

Name	Type	Description
All	string
Api	string
Email	string
Notification	string
Webhook	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

NotificationLevel

Level indicating how critical this recommendation can impact.

Name	Type	Description
Critical	string
Information	string
NonUrgentSuggestion	string
Warning	string

RecommendationRule

Represents a recommendation rule that the recommendation engine can perform.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.actionName	string	Name of action that is recommended by this rule in string.
properties.bladeName	string	Deep link to a blade on the portal. Applicable to dynamic rule only.
properties.categoryTags	string[]	The list of category tags that this recommendation rule belongs to.
properties.channels	Channels	List of available channels that this rule applies.
properties.description	string	Localized detailed description of the rule.
properties.displayName	string	UI friendly name of the rule.
properties.extensionName	string	Extension name of the portal if exists. Applicable to dynamic rule only.
properties.forwardLink	string	Forward link to an external document associated with the rule. Applicable to dynamic rule only.
properties.isDynamic	boolean	True if this is associated with a dynamically added rule
properties.level	NotificationLevel	Level of impact indicating how critical this rule is.
properties.message	string	Localized name of the rule (Good for UI).
properties.recommendationId	string	Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.
properties.recommendationName	string	Unique name of the rule.
type	string	Resource type.