RecommendationRule interface

  • Reference
Package:
@azure/arm-appservice-profile-2020-09-01-hybrid

Represents a recommendation rule that the recommendation engine can perform.

Extends
ProxyOnlyResource

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.
categoryTags

The list of category tags that this recommendation rule belongs to. NOTE: This property will not be serialized. It can only be populated by the server.
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.
recommendationName

Unique name of the rule.

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

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

categoryTags

The list of category tags that this recommendation rule belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

categoryTags?: string[]

Property Value

string[]

channels

List of available channels that this rule applies.

channels?: Channels

Property Value

Channels

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?: NotificationLevel

Property Value

NotificationLevel

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.

recommendationId?: string

Property Value

string

recommendationName

Unique name of the rule.

recommendationName?: string

Property Value

string

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type