Sign in

v1

latestSwagger 2.02026-07-13295146626.9 KB
Recommendations

Gets a list of recommendations associated with the specified subscription.

get/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations

Path parameters

subscriptionIdstring required

Subscription Id

Query parameters

featuredboolean

If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available

$filterstring

Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification'

api-versionstring required

API Version

Response

OK

creationTimestring date-time

Timestamp when this instance was created.

recommendationIdstring

A GUID value that each recommendation object is associated with.

resourceIdstring

Full ARM resource ID string that this recommendation object is associated with.

resourceScopestring

Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.

ruleNamestring

Unique name of the rule

displayNamestring

UI friendly name of the rule (may not be unique)

messagestring

Localized text of recommendation, good for UI.

level'Critical' | 'Warning' | 'Information' | 'NonUrgentSuggestion' required

Level indicating how critical this recommendation can impact.

channels'Notification' | 'Api' | 'Email' | 'All' required

List of channels that this recommendation can apply.

tagsstring[]

The list of category tags that this recommendation belongs to.

actionNamestring

Name of action recommended by this object.

enabledinteger

On/off flag indicating the rule is currently enabled or disabled.

startTimestring date-time

The beginning time of a range that the recommendation refers to.

endTimestring date-time

The end time of a range that the recommendation refers to.

nextNotificationTimestring date-time

When to notify this recommendation next. Null means that this will never be notified anymore.

notificationExpirationTimestring date-time

Date and time when this notification expires.

notifiedTimestring date-time

Last timestamp this instance was actually notified. Null means that this recommendation hasn't been notified yet.

scorenumber double

A metric value measured by the rule.