Share via

RecommendedAction interface

  • Reference
Package:
@azure/arm-sql

Database, Server or Elastic Pool Recommended Action.

Extends
ProxyResource

Properties

details

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

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

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

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

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

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

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

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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
isExecutableAction

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

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

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

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

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

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

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

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

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

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

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

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

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.
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 NOTE: This property will not be serialized. It can only be populated by the server.
validSince

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.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
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

details

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

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

Property Value

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

errorDetails

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.

errorDetails?: RecommendedActionErrorInfo

Property Value

RecommendedActionErrorInfo

estimatedImpact

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.

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 NOTE: This property will not be serialized. It can only be populated by the server.

executeActionDuration?: string

Property Value

string

executeActionInitiatedBy

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.

executeActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

RecommendedActionInitiatedBy

executeActionInitiatedTime

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.

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 NOTE: This property will not be serialized. It can only be populated by the server.

executeActionStartTime?: Date

Property Value

Date

implementationDetails

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.

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. NOTE: This property will not be serialized. It can only be populated by the server.

isArchivedAction?: boolean

Property Value

boolean

isExecutableAction

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

isExecutableAction?: boolean

Property Value

boolean

isRevertableAction

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.

isRevertableAction?: boolean

Property Value

boolean

kind

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

kind?: string

Property Value

string

lastRefresh

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

lastRefresh?: Date

Property Value

Date

linkedObjects

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

linkedObjects?: string[]

Property Value

string[]

location

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

location?: string

Property Value

string

observedImpact

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.

observedImpact?: RecommendedActionImpactRecord[]

Property Value

RecommendedActionImpactRecord[]

recommendationReason

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.

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. NOTE: This property will not be serialized. It can only be populated by the server.

revertActionDuration?: string

Property Value

string

revertActionInitiatedBy

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.

revertActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

RecommendedActionInitiatedBy

revertActionInitiatedTime

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.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

timeSeries?: RecommendedActionMetricInfo[]

Property Value

RecommendedActionMetricInfo[]

validSince

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.

validSince?: Date

Property Value

Date

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 ProxyResource.id

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 ProxyResource.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 ProxyResource.type