RecommendedActionProperties interface

Package:
@azure/arm-sql

Properties for a Database, Server or Elastic Pool Recommended Action.

Properties

details

Gets additional details specific to this recommended action.
errorDetails

Gets the error details if and why this recommended action is put to error state.
estimatedImpact

Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
executeActionDuration

Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
executeActionInitiatedBy

Gets if approval for applying this recommended action was given by user/system.
executeActionInitiatedTime

Gets the time when this recommended action was approved for execution.
executeActionStartTime

Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
implementationDetails

Gets the implementation details of this recommended action for user to apply it manually.
isArchivedAction

Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
isExecutableAction

Gets if this recommended action is actionable by user
isRevertableAction

Gets if changes applied by this recommended action can be reverted by user
lastRefresh

Gets time when this recommended action was last refreshed.
linkedObjects

Gets the linked objects, if any.
observedImpact

Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
recommendationReason

Gets the reason for recommending this action. e.g., DuplicateIndex
revertActionDuration

Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
revertActionInitiatedBy

Gets if approval for reverting this recommended action was given by user/system.
revertActionInitiatedTime

Gets the time when this recommended action was approved for revert.
revertActionStartTime

Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
score

Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
state

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

Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
validSince

Gets the time since when this recommended action is valid.

Property Details

details

Gets additional details specific to this recommended action.

details?: Record<string, string>

Property Value

Record<string, string>

errorDetails

Gets the error details if and why this recommended action is put to error state.

errorDetails?: RecommendedActionErrorInfo

Property Value

RecommendedActionErrorInfo

estimatedImpact

Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change

estimatedImpact?: RecommendedActionImpactRecord[]

Property Value

RecommendedActionImpactRecord[]

executeActionDuration

Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation

executeActionDuration?: string

Property Value

string

executeActionInitiatedBy

Gets if approval for applying this recommended action was given by user/system.

executeActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

RecommendedActionInitiatedBy

executeActionInitiatedTime

Gets the time when this recommended action was approved for execution.

executeActionInitiatedTime?: Date

Property Value

Date

executeActionStartTime

Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time

executeActionStartTime?: Date

Property Value

Date

implementationDetails

Gets the implementation details of this recommended action for user to apply it manually.

implementationDetails?: RecommendedActionImplementationInfo

Property Value

RecommendedActionImplementationInfo

isArchivedAction

Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.

isArchivedAction?: boolean

Property Value

boolean

isExecutableAction

Gets if this recommended action is actionable by user

isExecutableAction?: boolean

Property Value

boolean

isRevertableAction

Gets if changes applied by this recommended action can be reverted by user

isRevertableAction?: boolean

Property Value

boolean

lastRefresh

Gets time when this recommended action was last refreshed.

lastRefresh?: Date

Property Value

Date

linkedObjects

Gets the linked objects, if any.

linkedObjects?: string[]

Property Value

string[]

observedImpact

Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change

observedImpact?: RecommendedActionImpactRecord[]

Property Value

RecommendedActionImpactRecord[]

recommendationReason

Gets the reason for recommending this action. e.g., DuplicateIndex

recommendationReason?: string

Property Value

string

revertActionDuration

Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.

revertActionDuration?: string

Property Value

string

revertActionInitiatedBy

Gets if approval for reverting this recommended action was given by user/system.

revertActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

RecommendedActionInitiatedBy

revertActionInitiatedTime

Gets the time when this recommended action was approved for revert.

revertActionInitiatedTime?: Date

Property Value

Date

revertActionStartTime

Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.

revertActionStartTime?: Date

Property Value

Date

score

Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact

score?: number

Property Value

number

state

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

state: RecommendedActionStateInfo

Property Value

RecommendedActionStateInfo

timeSeries

Gets the time series info of metrics for this recommended action e.g., CPU consumption time series

timeSeries?: RecommendedActionMetricInfo[]

Property Value

RecommendedActionMetricInfo[]

validSince

Gets the time since when this recommended action is valid.

validSince?: Date

Property Value

Date