Recommendations - List

Description for List all recommendations for a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations?api-version=2022-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations?featured={featured}&api-version=2022-03-01&$filter={$filter}

URI Parameters

Name In Required Type Description
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

$filter
query

string

Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]

featured
query

boolean

Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.

Responses

Name Type Description
200 OK

RecommendationCollection

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.

Recommendation

Represents a recommendation result generated by the recommendation engine.

RecommendationCollection

Collection of recommendations.

ResourceScopeType

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

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

Recommendation

Represents a recommendation result generated by the recommendation engine.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.actionName

string

Name of action recommended by this object.

properties.bladeName

string

Deep link to a blade on the portal.

properties.categoryTags

string[]

The list of category tags that this recommendation belongs to.

properties.channels

Channels

List of channels that this recommendation can apply.

properties.creationTime

string

Timestamp when this instance was created.

properties.displayName

string

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

properties.enabled

integer

True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.

properties.endTime

string

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

properties.extensionName

string

Extension name of the portal if exists.

properties.forwardLink

string

Forward link to an external document associated with the rule.

properties.isDynamic

boolean

True if this is associated with a dynamically added rule

properties.level

NotificationLevel

Level indicating how critical this recommendation can impact.

properties.message

string

Recommendation text.

properties.nextNotificationTime

string

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

properties.notificationExpirationTime

string

Date and time in UTC when this notification expires.

properties.notifiedTime

string

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

properties.recommendationId

string

A GUID value that each recommendation object is associated with.

properties.resourceId

string

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

properties.resourceScope

ResourceScopeType

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

properties.ruleName

string

Unique name of the rule.

properties.score

number

A metric value measured by the rule.

properties.startTime

string

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

properties.states

string[]

The list of states of this recommendation. If it's null then it should be considered "Active".

type

string

Resource type.

RecommendationCollection

Collection of recommendations.

Name Type Description
nextLink

string

Link to next page of resources.

value

Recommendation[]

Collection of resources.

ResourceScopeType

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

Name Type Description
ServerFarm

string

Subscription

string

WebSite

string