RecommendationRuleProperties Class

RecommendationRule resource specific properties.

Constructor

RecommendationRuleProperties(*args: Any, **kwargs: Any)

Variables

Name Description
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

Level of impact indicating how critical this rule is. Known values are: "Critical", "Warning", "Information", and "NonUrgentSuggestion".

channels

List of available channels that this rule applies. Known values are: "Notification", "Api", "Email", "Webhook", and "All".

category_tags

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

is_dynamic

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.

Attributes

action_name

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

action_name: str | None

blade_name

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

blade_name: str | None

category_tags

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

category_tags: list[str] | None

channels

"Notification", "Api", "Email", "Webhook", and "All".

channels: str | _models.Channels | None

description

Localized detailed description of the rule.

description: str | None

display_name

UI friendly name of the rule.

display_name: str | None

extension_name

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

extension_name: str | None

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

forward_link: str | None

is_dynamic

True if this is associated with a dynamically added rule.

is_dynamic: bool | None

level

"Critical", "Warning", "Information", and "NonUrgentSuggestion".

level: str | _models.NotificationLevel | None

message

Localized name of the rule (Good for UI).

message: str | None

recommendation_id

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.

recommendation_id: str | None

recommendation_name

Unique name of the rule.

recommendation_name: str | None