Package version:

Interface RecommendedAction

Database, Server or Elastic Pool Recommended Action.

Hierarchy

Properties

details? errorDetails? estimatedImpact? executeActionDuration? executeActionInitiatedBy? executeActionInitiatedTime? executeActionStartTime? id? implementationDetails? isArchivedAction? isExecutableAction? isRevertableAction? kind? lastRefresh? linkedObjects? location? name? observedImpact? recommendationReason? revertActionDuration? revertActionInitiatedBy? revertActionInitiatedTime? revertActionStartTime? score? state? timeSeries? type? validSince?

Properties

Optional Readonly details

details?: {
    [propertyName: string]: Record<string, unknown>;
}

Gets additional details specific to this recommended action. NOTE: This property will not be serialized. It can only be populated by the server.

Type declaration

  • [propertyName: string]: Record<string, unknown>

Optional Readonly errorDetails

errorDetails?: RecommendedActionErrorInfo

Gets the error details if and why this recommended action is put to error state. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly estimatedImpact

estimatedImpact?: RecommendedActionImpactRecord[]

Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly executeActionDuration

executeActionDuration?: string

Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly executeActionInitiatedBy

executeActionInitiatedBy?: RecommendedActionInitiatedBy

Gets if approval for applying this recommended action was given by user/system. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly executeActionInitiatedTime

executeActionInitiatedTime?: Date

Gets the time when this recommended action was approved for execution. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly executeActionStartTime

executeActionStartTime?: Date

Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly id

id?: string

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

Optional Readonly implementationDetails

implementationDetails?: RecommendedActionImplementationInfo

Gets the implementation details of this recommended action for user to apply it manually. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly isArchivedAction

isArchivedAction?: boolean

Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly isExecutableAction

isExecutableAction?: boolean

Gets if this recommended action is actionable by user NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly isRevertableAction

isRevertableAction?: boolean

Gets if changes applied by this recommended action can be reverted by user NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly kind

kind?: string

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

Optional Readonly lastRefresh

lastRefresh?: Date

Gets time when this recommended action was last refreshed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly linkedObjects

linkedObjects?: string[]

Gets the linked objects, if any. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly location

location?: string

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

Optional Readonly name

name?: string

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

Optional Readonly observedImpact

observedImpact?: RecommendedActionImpactRecord[]

Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly recommendationReason

recommendationReason?: string

Gets the reason for recommending this action. e.g., DuplicateIndex NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly revertActionDuration

revertActionDuration?: string

Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly revertActionInitiatedBy

revertActionInitiatedBy?: RecommendedActionInitiatedBy

Gets if approval for reverting this recommended action was given by user/system. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly revertActionInitiatedTime

revertActionInitiatedTime?: Date

Gets the time when this recommended action was approved for revert. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly revertActionStartTime

revertActionStartTime?: Date

Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly score

score?: number

Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state?: RecommendedActionStateInfo

Gets the info of the current state the recommended action is in.

Optional Readonly timeSeries

timeSeries?: RecommendedActionMetricInfo[]

Gets the time series info of metrics for this recommended action e.g., CPU consumption time series NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly type

type?: string

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

Optional Readonly validSince

validSince?: Date

Gets the time since when this recommended action is valid. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility

Theme

Generated using TypeDoc