Share via


RecommendationRuleProperties interface

RecommendationRule resource specific properties

Properties

actionName

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

bladeName

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

channels

List of available channels that this rule applies.

description

Localized detailed description of the rule.

displayName

UI friendly name of the rule.

extensionName

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

forwardLink

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

isDynamic

True if this is associated with a dynamically added rule

level

Level of impact indicating how critical this rule is.

message

Localized name of the rule (Good for UI).

recommendationId

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.

Value may contain a UUID

recommendationName

Unique name of the rule.

Property Details

actionName

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

actionName?: string

Property Value

string

bladeName

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

bladeName?: string

Property Value

string

channels

List of available channels that this rule applies.

channels?: "All" | "Email" | "Notification" | "Api" | "Webhook"

Property Value

"All" | "Email" | "Notification" | "Api" | "Webhook"

description

Localized detailed description of the rule.

description?: string

Property Value

string

displayName

UI friendly name of the rule.

displayName?: string

Property Value

string

extensionName

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

extensionName?: string

Property Value

string

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

forwardLink?: string

Property Value

string

isDynamic

True if this is associated with a dynamically added rule

isDynamic?: boolean

Property Value

boolean

level

Level of impact indicating how critical this rule is.

level?: "Critical" | "Warning" | "Information" | "NonUrgentSuggestion"

Property Value

"Critical" | "Warning" | "Information" | "NonUrgentSuggestion"

message

Localized name of the rule (Good for UI).

message?: string

Property Value

string

recommendationId

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.

Value may contain a UUID

recommendationId?: string

Property Value

string

recommendationName

Unique name of the rule.

recommendationName?: string

Property Value

string