RecommendationsOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:recommendations> attribute.

Inheritance: builtins.object

RecommendationsOperations

Constructor

RecommendationsOperations(*args, **kwargs)

Methods

disable_all_for_hosting_environment	Disable all recommendations for an app. Description for Disable all recommendations for an app.
disable_all_for_web_app	Disable all recommendations for an app. Description for Disable all recommendations for an app.
disable_recommendation_for_hosting_environment	Disables the specific rule for a web site permanently. Description for Disables the specific rule for a web site permanently.
disable_recommendation_for_site	Disables the specific rule for a web site permanently. Description for Disables the specific rule for a web site permanently.
disable_recommendation_for_subscription	Disables the specified rule so it will not apply to a subscription in the future. Description for Disables the specified rule so it will not apply to a subscription in the future.
get_rule_details_by_hosting_environment	Get a recommendation rule for an app. Description for Get a recommendation rule for an app.
get_rule_details_by_web_app	Get a recommendation rule for an app. Description for Get a recommendation rule for an app.
list	List all recommendations for a subscription. Description for List all recommendations for a subscription.
list_history_for_hosting_environment	Get past recommendations for an app, optionally specified by the time range. Description for Get past recommendations for an app, optionally specified by the time range.
list_history_for_web_app	Get past recommendations for an app, optionally specified by the time range. Description for Get past recommendations for an app, optionally specified by the time range.
list_recommended_rules_for_hosting_environment	Get all recommendations for a hosting environment. Description for Get all recommendations for a hosting environment.
list_recommended_rules_for_web_app	Get all recommendations for an app. Description for Get all recommendations for an app.
reset_all_filters	Reset all recommendation opt-out settings for a subscription. Description for Reset all recommendation opt-out settings for a subscription.
reset_all_filters_for_hosting_environment	Reset all recommendation opt-out settings for an app. Description for Reset all recommendation opt-out settings for an app.
reset_all_filters_for_web_app	Reset all recommendation opt-out settings for an app. Description for Reset all recommendation opt-out settings for an app.

disable_all_for_hosting_environment

Disable all recommendations for an app.

Description for Disable all recommendations for an app.

disable_all_for_hosting_environment(resource_group_name: str, environment_name: str, hosting_environment_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
environment_name Required	str Name of the app. Required.
hosting_environment_name Required	str Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

disable_all_for_web_app

Disable all recommendations for an app.

Description for Disable all recommendations for an app.

disable_all_for_web_app(resource_group_name: str, site_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Name of the app. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

disable_recommendation_for_hosting_environment

Disables the specific rule for a web site permanently.

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

disable_recommendation_for_hosting_environment(resource_group_name: str, environment_name: str, name: str, hosting_environment_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
environment_name Required	str Site name. Required.
name Required	str Rule name. Required.
hosting_environment_name Required	str Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

disable_recommendation_for_site

Disables the specific rule for a web site permanently.

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

disable_recommendation_for_site(resource_group_name: str, site_name: str, name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Site name. Required.
name Required	str Rule name. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

disable_recommendation_for_subscription

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

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

disable_recommendation_for_subscription(name: str, **kwargs: Any) -> None

Parameters

Name	Description
name Required	str Rule name. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_rule_details_by_hosting_environment

Get a recommendation rule for an app.

Description for Get a recommendation rule for an app.

get_rule_details_by_hosting_environment(resource_group_name: str, hosting_environment_name: str, name: str, update_seen: bool | None = None, recommendation_id: str | None = None, **kwargs: Any) -> RecommendationRule

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
hosting_environment_name Required	str Name of the hosting environment. Required.
name Required	str Name of the recommendation. Required.
update_seen Required	bool Specify `<code>true</code>` to update the last-seen timestamp of the recommendation object. Default value is None.
recommendation_id Required	str The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. Default value is None.

Returns

Type	Description
RecommendationRule	RecommendationRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_rule_details_by_web_app

Get a recommendation rule for an app.

Description for Get a recommendation rule for an app.

get_rule_details_by_web_app(resource_group_name: str, site_name: str, name: str, update_seen: bool | None = None, recommendation_id: str | None = None, **kwargs: Any) -> RecommendationRule

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Name of the app. Required.
name Required	str Name of the recommendation. Required.
update_seen Required	bool Specify `<code>true</code>` to update the last-seen timestamp of the recommendation object. Default value is None.
recommendation_id Required	str The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. Default value is None.

Returns

Type	Description
RecommendationRule	RecommendationRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

List all recommendations for a subscription.

Description for List all recommendations for a subscription.

list(featured: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]

Parameters

Name	Description
featured Required	bool Specify `<code>true</code>` to return only the most critical recommendations. The default is `<code>false</code>`, which returns all recommendations. Default value is None.
filter Required	str 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]. Default value is None.

Returns

Type	Description
ItemPaged[Recommendation]	An iterator like instance of either Recommendation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_history_for_hosting_environment

Get past recommendations for an app, optionally specified by the time range.

Description for Get past recommendations for an app, optionally specified by the time range.

list_history_for_hosting_environment(resource_group_name: str, hosting_environment_name: str, expired_only: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
hosting_environment_name Required	str Name of the hosting environment. Required.
expired_only Required	bool Specify `<code>false</code>` to return all recommendations. The default is `<code>true</code>`, which returns only expired recommendations. Default value is None.
filter Required	str 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]. Default value is None.

Returns

Type	Description
ItemPaged[Recommendation]	An iterator like instance of either Recommendation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_history_for_web_app

Get past recommendations for an app, optionally specified by the time range.

Description for Get past recommendations for an app, optionally specified by the time range.

list_history_for_web_app(resource_group_name: str, site_name: str, expired_only: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Name of the app. Required.
expired_only Required	bool Specify `<code>false</code>` to return all recommendations. The default is `<code>true</code>`, which returns only expired recommendations. Default value is None.
filter Required	str 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]. Default value is None.

Returns

Type	Description
ItemPaged[Recommendation]	An iterator like instance of either Recommendation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_recommended_rules_for_hosting_environment

Get all recommendations for a hosting environment.

Description for Get all recommendations for a hosting environment.

list_recommended_rules_for_hosting_environment(resource_group_name: str, hosting_environment_name: str, featured: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
hosting_environment_name Required	str Name of the app. Required.
featured Required	bool Specify `<code>true</code>` to return only the most critical recommendations. The default is `<code>false</code>`, which returns all recommendations. Default value is None.
filter Required	str Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'. Default value is None.

Returns

Type	Description
ItemPaged[Recommendation]	An iterator like instance of either Recommendation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_recommended_rules_for_web_app

Get all recommendations for an app.

Description for Get all recommendations for an app.

list_recommended_rules_for_web_app(resource_group_name: str, site_name: str, featured: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Name of the app. Required.
featured Required	bool Specify `<code>true</code>` to return only the most critical recommendations. The default is `<code>false</code>`, which returns all recommendations. Default value is None.
filter Required	str Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'. Default value is None.

Returns

Type	Description
ItemPaged[Recommendation]	An iterator like instance of either Recommendation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reset_all_filters

Reset all recommendation opt-out settings for a subscription.

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

reset_all_filters(**kwargs: Any) -> None

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reset_all_filters_for_hosting_environment

Reset all recommendation opt-out settings for an app.

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

reset_all_filters_for_hosting_environment(resource_group_name: str, environment_name: str, hosting_environment_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
environment_name Required	str Name of the app. Required.
hosting_environment_name Required	str Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reset_all_filters_for_web_app

Reset all recommendation opt-out settings for an app.

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

reset_all_filters_for_web_app(resource_group_name: str, site_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
site_name Required	str Name of the app. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2022_09_01\\models\\__init__.py'>

Share via

RecommendationsOperations Class

Constructor

Methods

disable_all_for_hosting_environment

Parameters

Returns

Exceptions

disable_all_for_web_app

Parameters

Returns

Exceptions

disable_recommendation_for_hosting_environment

Parameters

Returns

Exceptions

disable_recommendation_for_site

Parameters

Returns

Exceptions

disable_recommendation_for_subscription

Parameters

Returns

Exceptions

get_rule_details_by_hosting_environment

Parameters

Returns

Exceptions

get_rule_details_by_web_app

Parameters

Returns

Exceptions

list

Parameters

Returns

Exceptions

list_history_for_hosting_environment

Parameters

Returns

Exceptions

list_history_for_web_app

Parameters

Returns

Exceptions

list_recommended_rules_for_hosting_environment

Parameters

Returns

Exceptions

list_recommended_rules_for_web_app

Parameters

Returns

Exceptions

reset_all_filters

Returns

Exceptions

reset_all_filters_for_hosting_environment

Parameters

Returns

Exceptions

reset_all_filters_for_web_app

Parameters

Returns

Exceptions

Attributes

models

Additional resources