RecommendationsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:recommendations> attribute.
- Inheritance
-
builtins.objectRecommendationsOperations
Constructor
RecommendationsOperations(*args, **kwargs)Methods
| disable_all_for_hosting_environment |
Disable all recommendations for an app. Disable all recommendations for an app. |
| disable_all_for_web_app |
Disable all recommendations for an app. Disable all recommendations for an app. |
| disable_recommendation_for_hosting_environment |
Disables the specific rule for a web site permanently. Disables the specific rule for a web site permanently. |
| disable_recommendation_for_site |
Disables the specific rule for a web site permanently. 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. 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. Get a recommendation rule for an app. |
| get_rule_details_by_web_app |
Get a recommendation rule for an app. Get a recommendation rule for an app. |
| list |
List all recommendations for a subscription. List all recommendations for a subscription. |
| list_history_for_hosting_environment |
Get past recommendations for an app, optionally specified by the time range. 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. 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. Get all recommendations for a hosting environment. |
| list_recommended_rules_for_web_app |
Get all recommendations for an app. Get all recommendations for an app. |
| reset_all_filters |
Reset all recommendation opt-out settings for a subscription. Reset all recommendation opt-out settings for a subscription. |
| reset_all_filters_for_hosting_environment |
Reset all recommendation opt-out settings for an app. Reset all recommendation opt-out settings for an app. |
| reset_all_filters_for_web_app |
Reset all recommendation opt-out settings for an app. Reset all recommendation opt-out settings for an app. |
disable_all_for_hosting_environment
Disable all recommendations for an app.
Disable all recommendations for an app.
disable_all_for_hosting_environment(resource_group_name: str, environment_name: str, hosting_environment_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
environment_name
Required
|
Name of the app. Required. |
|
hosting_environment_name
Required
|
Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
disable_all_for_web_app
Disable all recommendations for an app.
Disable all recommendations for an app.
disable_all_for_web_app(resource_group_name: str, site_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Name of the app. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
disable_recommendation_for_hosting_environment
Disables the specific rule for a web site permanently.
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
environment_name
Required
|
Site name. Required. |
|
name
Required
|
Rule name. Required. |
|
hosting_environment_name
Required
|
Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
disable_recommendation_for_site
Disables the specific rule for a web site permanently.
Disables the specific rule for a web site permanently.
disable_recommendation_for_site(resource_group_name: str, site_name: str, name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Site name. Required. |
|
name
Required
|
Rule name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
disable_recommendation_for_subscription
Disables the specified rule so it will not apply to a subscription in the future.
Disables the specified rule so it will not apply to a subscription in the future.
disable_recommendation_for_subscription(name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
name
Required
|
Rule name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_rule_details_by_hosting_environment
Get a recommendation rule for an app.
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) -> RecommendationRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
hosting_environment_name
Required
|
Name of the hosting environment. Required. |
|
name
Required
|
Name of the recommendation. Required. |
|
update_seen
Required
|
Specify |
|
recommendation_id
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
RecommendationRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_rule_details_by_web_app
Get a recommendation rule for an app.
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) -> RecommendationRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Name of the app. Required. |
|
name
Required
|
Name of the recommendation. Required. |
|
update_seen
Required
|
Specify |
|
recommendation_id
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
RecommendationRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List all recommendations for a subscription.
List all recommendations for a subscription.
list(featured: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Recommendation]Parameters
| Name | Description |
|---|---|
|
featured
Required
|
Specify |
|
filter
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Recommendation or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_history_for_hosting_environment
Get past recommendations for an app, optionally specified by the time range.
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
|
Name of the resource group to which the resource belongs. Required. |
|
hosting_environment_name
Required
|
Name of the hosting environment. Required. |
|
expired_only
Required
|
Specify |
|
filter
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Recommendation or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_history_for_web_app
Get past recommendations for an app, optionally specified by the time range.
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
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Name of the app. Required. |
|
expired_only
Required
|
Specify |
|
filter
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Recommendation or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_recommended_rules_for_hosting_environment
Get all recommendations for a hosting environment.
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
|
Name of the resource group to which the resource belongs. Required. |
|
hosting_environment_name
Required
|
Name of the app. Required. |
|
featured
Required
|
Specify |
|
filter
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Recommendation or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_recommended_rules_for_web_app
Get all recommendations for an app.
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
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Name of the app. Required. |
|
featured
Required
|
Specify |
|
filter
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Recommendation or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
reset_all_filters
Reset all recommendation opt-out settings for a subscription.
Reset all recommendation opt-out settings for a subscription.
reset_all_filters(**kwargs: Any) -> NoneKeyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
reset_all_filters_for_hosting_environment
Reset all recommendation opt-out settings for an app.
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
environment_name
Required
|
Name of the app. Required. |
|
hosting_environment_name
Required
|
Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
reset_all_filters_for_web_app
Reset all recommendation opt-out settings for an app.
Reset all recommendation opt-out settings for an app.
reset_all_filters_for_web_app(resource_group_name: str, site_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
site_name
Required
|
Name of the app. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.web.v2020_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2020_09_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for