recommendations

Creates, updates, deletes, gets or lists a recommendations resource.

Overview

Name	recommendations
Type	Resource
Id	azure.app_service.recommendations

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	Recommendation resource specific properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId	featured, $filter	Description for List all recommendations for a subscription.
reset_all_filters	exec	subscriptionId		Description for Reset all recommendation opt-out settings for a subscription.
disable_recommendation_for_subscription	exec	name, subscriptionId		Description for Disables the specified rule so it will not apply to a subscription in the future.
disable_all_for_hosting_environment	exec	resourceGroupName, environmentName, hostingEnvironmentName, subscriptionId		Description for Disable all recommendations for an app.
reset_all_filters_for_hosting_environment	exec	resourceGroupName, environmentName, hostingEnvironmentName, subscriptionId		Description for Reset all recommendation opt-out settings for an app.
disable_recommendation_for_hosting_environment	exec	resourceGroupName, environmentName, name, hostingEnvironmentName, subscriptionId		Description for Disables the specific rule for a web site permanently.
disable_all_for_web_app	exec	resourceGroupName, siteName, subscriptionId		Description for Disable all recommendations for an app.
reset_all_filters_for_web_app	exec	resourceGroupName, siteName, subscriptionId		Description for Reset all recommendation opt-out settings for an app.
disable_recommendation_for_site	exec	resourceGroupName, siteName, name, subscriptionId		Description for Disables the specific rule for a web site permanently.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentName	string	Site name
hostingEnvironmentName	string
name	string	Rule name
resourceGroupName	string	Name of the resource group to which the resource belongs.
siteName	string	Site name
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
$filter	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	boolean	Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.

SELECT examples

list

Description for List all recommendations for a subscription.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.recommendations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND featured = '{{ featured }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

reset_all_filters

Description for Reset all recommendation opt-out settings for a subscription.

EXEC azure.app_service.recommendations.reset_all_filters 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_recommendation_for_subscription

Description for Disables the specified rule so it will not apply to a subscription in the future.

EXEC azure.app_service.recommendations.disable_recommendation_for_subscription 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_all_for_hosting_environment

Description for Disable all recommendations for an app.

EXEC azure.app_service.recommendations.disable_all_for_hosting_environment 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@hostingEnvironmentName='{{ hostingEnvironmentName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

reset_all_filters_for_hosting_environment

Description for Reset all recommendation opt-out settings for an app.

EXEC azure.app_service.recommendations.reset_all_filters_for_hosting_environment 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@hostingEnvironmentName='{{ hostingEnvironmentName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_recommendation_for_hosting_environment

Description for Disables the specific rule for a web site permanently.

EXEC azure.app_service.recommendations.disable_recommendation_for_hosting_environment 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@name='{{ name }}' --required, 
@hostingEnvironmentName='{{ hostingEnvironmentName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_all_for_web_app

Description for Disable all recommendations for an app.

EXEC azure.app_service.recommendations.disable_all_for_web_app 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

reset_all_filters_for_web_app

Description for Reset all recommendation opt-out settings for an app.

EXEC azure.app_service.recommendations.reset_all_filters_for_web_app 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_recommendation_for_site

Description for Disables the specific rule for a web site permanently.

EXEC azure.app_service.recommendations.disable_recommendation_for_site 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;