Feedback Edit

RecommendationRule Class

  • Reference

Represents a recommendation rule that the recommendation engine can perform.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.web.v2021_02_01.models._models_py3.ProxyOnlyResource
RecommendationRule

Constructor

RecommendationRule(*, kind: Optional[str] = None, recommendation_name: Optional[str] = None, display_name: Optional[str] = None, message: Optional[str] = None, recommendation_id: Optional[str] = None, description: Optional[str] = None, action_name: Optional[str] = None, level: Optional[Union[str, azure.mgmt.web.v2021_02_01.models._web_site_management_client_enums.NotificationLevel]] = None, channels: Optional[Union[str, azure.mgmt.web.v2021_02_01.models._web_site_management_client_enums.Channels]] = None, is_dynamic: Optional[bool] = None, extension_name: Optional[str] = None, blade_name: Optional[str] = None, forward_link: Optional[str] = None, **kwargs)

Parameters

kind
str
Required

Kind of resource.

recommendation_name
str
Required

Unique name of the rule.

display_name
str
Required

UI friendly name of the rule.

message
str
Required

Localized name of the rule (Good for UI).

recommendation_id
str
Required

Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

description
str
Required

Localized detailed description of the rule.

action_name
str
Required

Name of action that is recommended by this rule in string.

level
str or NotificationLevel
Required

Level of impact indicating how critical this rule is. Possible values include: "Critical", "Warning", "Information", "NonUrgentSuggestion".

channels
str or Channels
Required

List of available channels that this rule applies. Possible values include: "Notification", "Api", "Email", "Webhook", "All".

is_dynamic
bool
Required

True if this is associated with a dynamically added rule.

extension_name
str
Required

Extension name of the portal if exists. Applicable to dynamic rule only.

blade_name
str
Required

Deep link to a blade on the portal. Applicable to dynamic rule only.

forward_link
str
Required

Forward link to an external document associated with the rule. Applicable to dynamic rule only.

Variables

id
str

Resource Id.

name
str

Resource Name.

type
str

Resource type.

category_tags
list[str]

The list of category tags that this recommendation rule belongs to.