RecommendationsOperations Class

RecommendationsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

RecommendationsOperations

Constructor

RecommendationsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

environment_name

str

Required

Name of the app.

hosting_environment_name

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

disable_all_for_web_app

Disable all recommendations for an app.

Description for Disable all recommendations for an app.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

environment_name

str

Required

Site name.

name

str

Required

Rule name.

hosting_environment_name

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Site name.

name

str

Required

Rule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

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.

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

Parameters

name

str

Required

Rule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get_rule_details_by_hosting_environment

Get a recommendation rule for an app.

Description for Get a recommendation rule for an app.

async get_rule_details_by_hosting_environment(resource_group_name: str, hosting_environment_name: str, name: str, update_seen: Optional[bool] = None, recommendation_id: Optional[str] = None, **kwargs: Any) -> azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationRule

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

hosting_environment_name

str

Required

Name of the hosting environment.

name

str

Required

Name of the recommendation.

update_seen

bool

default value: None

Specify <code>true</code> to update the last-seen timestamp of the recommendation object.

recommendation_id

str

default value: None

The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.

cls

callable

A custom type or function that will be passed the direct response

Returns

RecommendationRule, or the result of cls(response)

Return type

RecommendationRule

Exceptions

HttpResponseError

get_rule_details_by_web_app

Get a recommendation rule for an app.

Description for Get a recommendation rule for an app.

async get_rule_details_by_web_app(resource_group_name: str, site_name: str, name: str, update_seen: Optional[bool] = None, recommendation_id: Optional[str] = None, **kwargs: Any) -> azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationRule

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Name of the app.

name

str

Required

Name of the recommendation.

update_seen

bool

default value: None

Specify <code>true</code> to update the last-seen timestamp of the recommendation object.

recommendation_id

str

default value: None

The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.

cls

callable

A custom type or function that will be passed the direct response

Returns

RecommendationRule, or the result of cls(response)

Return type

RecommendationRule

Exceptions

HttpResponseError

list

List all recommendations for a subscription.

Description for List all recommendations for a subscription.

list(featured: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationCollection]

Parameters

featured

bool

default value: None

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

filter

str

default value: None

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].

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecommendationCollection or the result of cls(response)

Return type

AsyncItemPaged[RecommendationCollection]

Exceptions

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: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

hosting_environment_name

str

Required

Name of the hosting environment.

expired_only

bool

default value: None

Specify <code>false</code> to return all recommendations. The default is <code>true</code>, which returns only expired recommendations.

filter

str

default value: None

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].

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecommendationCollection or the result of cls(response)

Return type

AsyncItemPaged[RecommendationCollection]

Exceptions

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: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Name of the app.

expired_only

bool

default value: None

Specify <code>false</code> to return all recommendations. The default is <code>true</code>, which returns only expired recommendations.

filter

str

default value: None

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].

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecommendationCollection or the result of cls(response)

Return type

AsyncItemPaged[RecommendationCollection]

Exceptions

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: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

hosting_environment_name

str

Required

Name of the app.

featured

bool

default value: None

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

filter

str

default value: None

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecommendationCollection or the result of cls(response)

Return type

AsyncItemPaged[RecommendationCollection]

Exceptions

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: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_01.models._models_py3.RecommendationCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Name of the app.

featured

bool

default value: None

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

filter

str

default value: None

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecommendationCollection or the result of cls(response)

Return type

AsyncItemPaged[RecommendationCollection]

Exceptions

HttpResponseError

reset_all_filters

Reset all recommendation opt-out settings for a subscription.

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

async reset_all_filters(**kwargs: Any) -> None

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

environment_name

str

Required

Name of the app.

hosting_environment_name

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

site_name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2021_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2021_01_01\\models\\__init__.py'>