RecommendationProperties interface

Package:

@azure-rest/arm-appservice

Recommendation resource specific properties

Properties

actionName	Name of action recommended by this object.
bladeName	Deep link to a blade on the portal.
channels	List of channels that this recommendation can apply.
creationTime	Timestamp when this instance was created.
displayName	UI friendly name of the rule (may not be unique).
enabled	True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
endTime	The end time in UTC of a range that the recommendation refers to.
extensionName	Extension name of the portal if exists.
forwardLink	Forward link to an external document associated with the rule.
isDynamic	True if this is associated with a dynamically added rule
level	Level indicating how critical this recommendation can impact.
message	Recommendation text.
nextNotificationTime	When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
notificationExpirationTime	Date and time in UTC when this notification expires.
notifiedTime	Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.
recommendationId	A GUID value that each recommendation object is associated with. Value may contain a UUID
resourceId	Full ARM resource ID string that this recommendation object is associated with.
resourceScope	Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
ruleName	Unique name of the rule.
score	A metric value measured by the rule.
startTime	The beginning time in UTC of a range that the recommendation refers to.
states	The list of states of this recommendation. If it's null then it should be considered "Active".

Property Details

actionName

Name of action recommended by this object.

actionName?: string

Property Value

string

bladeName

Deep link to a blade on the portal.

bladeName?: string

Property Value

string

channels

List of channels that this recommendation can apply.

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

Property Value

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

creationTime

Timestamp when this instance was created.

creationTime?: string | Date

Property Value

string | Date

displayName

UI friendly name of the rule (may not be unique).

displayName?: string

Property Value

string

enabled

True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.

enabled?: number

Property Value

number

endTime

The end time in UTC of a range that the recommendation refers to.

endTime?: string | Date

Property Value

string | Date

extensionName

Extension name of the portal if exists.

extensionName?: string

Property Value

string

forwardLink

Forward link to an external document associated with the rule.

forwardLink?: string

Property Value

string

isDynamic

True if this is associated with a dynamically added rule

isDynamic?: boolean

Property Value

boolean

level

Level indicating how critical this recommendation can impact.

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

Property Value

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

message

Recommendation text.

message?: string

Property Value

string

nextNotificationTime

When to notify this recommendation next in UTC. Null means that this will never be notified anymore.

nextNotificationTime?: string | Date

Property Value

string | Date

notificationExpirationTime

Date and time in UTC when this notification expires.

notificationExpirationTime?: string | Date

Property Value

string | Date

notifiedTime

Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.

notifiedTime?: string | Date

Property Value

string | Date

recommendationId

A GUID value that each recommendation object is associated with.

Value may contain a UUID

recommendationId?: string

Property Value

string

resourceId

Full ARM resource ID string that this recommendation object is associated with.

resourceId?: string

Property Value

string

resourceScope

Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.

resourceScope?: "ServerFarm" | "Subscription" | "WebSite"

Property Value

"ServerFarm" | "Subscription" | "WebSite"

ruleName

Unique name of the rule.

ruleName?: string

Property Value

string

score

A metric value measured by the rule.

score?: number

Property Value

number

startTime

The beginning time in UTC of a range that the recommendation refers to.

startTime?: string | Date

Property Value

string | Date

states

The list of states of this recommendation. If it's null then it should be considered "Active".

states?: string[]

Property Value

string[]