RecommendationRule Class

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.v2020_09_01.models._models_py3.ProxyOnlyResource

RecommendationRule

Constructor

RecommendationRule(*, kind: str | None = None, recommendation_name: str | None = None, display_name: str | None = None, message: str | None = None, recommendation_id: str | None = None, description: str | None = None, action_name: str | None = None, level: str | _models.NotificationLevel | None = None, channels: str | _models.Channels | None = None, is_dynamic: bool | None = None, extension_name: str | None = None, blade_name: str | None = None, forward_link: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
recommendation_name	str Unique name of the rule.
display_name	str UI friendly name of the rule.
message	str Localized name of the rule (Good for UI).
recommendation_id	str 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 Localized detailed description of the rule.
action_name	str Name of action that is recommended by this rule in string.
level	str or NotificationLevel Level of impact indicating how critical this rule is. Known values are: "Critical", "Warning", "Information", and "NonUrgentSuggestion".
channels	str or Channels List of available channels that this rule applies. Known values are: "Notification", "Api", "Email", "Webhook", and "All".
is_dynamic	bool True if this is associated with a dynamically added rule.
extension_name	str Extension name of the portal if exists. Applicable to dynamic rule only.
blade_name	str Deep link to a blade on the portal. Applicable to dynamic rule only.
forward_link	str Forward link to an external document associated with the rule. Applicable to dynamic rule only.

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
type	str Resource type.
system_data	SystemData The system metadata relating to this resource.
recommendation_name	str Unique name of the rule.
display_name	str UI friendly name of the rule.
message	str Localized name of the rule (Good for UI).
recommendation_id	str 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 Localized detailed description of the rule.
action_name	str Name of action that is recommended by this rule in string.
level	str or NotificationLevel Level of impact indicating how critical this rule is. Known values are: "Critical", "Warning", "Information", and "NonUrgentSuggestion".
channels	str or Channels List of available channels that this rule applies. Known values are: "Notification", "Api", "Email", "Webhook", and "All".
category_tags	list[str] The list of category tags that this recommendation rule belongs to.
is_dynamic	bool True if this is associated with a dynamically added rule.
extension_name	str Extension name of the portal if exists. Applicable to dynamic rule only.
blade_name	str Deep link to a blade on the portal. Applicable to dynamic rule only.
forward_link	str Forward link to an external document associated with the rule. Applicable to dynamic rule only.