RecommendedAction interface

Gets additional details specific to this recommended action.

details?: Record<string, string>

Property Value

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

errorDetails?: RecommendedActionErrorInfo

Property Value

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

estimatedImpact?: RecommendedActionImpactRecord[]

Property Value

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

executeActionDuration?: string

Property Value

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

executeActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

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

executeActionInitiatedTime?: Date

Property Value

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

executeActionStartTime?: Date

Property Value

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

implementationDetails?: RecommendedActionImplementationInfo

Property Value

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

Gets if this recommended action is actionable by user

isExecutableAction?: boolean

Property Value

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

isRevertableAction?: boolean

Property Value

Resource kind.

kind?: string

Property Value

Gets time when this recommended action was last refreshed.

lastRefresh?: Date

Property Value

Gets the linked objects, if any.

linkedObjects?: string[]

Property Value

Resource location.

location?: string

Property Value

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

observedImpact?: RecommendedActionImpactRecord[]

Property Value

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

recommendationReason?: string

Property Value

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

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

revertActionInitiatedBy?: RecommendedActionInitiatedBy

Property Value

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

revertActionInitiatedTime?: Date

Property Value

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

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

score?: number

Property Value

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

state?: RecommendedActionStateInfo

Property Value

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

timeSeries?: RecommendedActionMetricInfo[]

Property Value

Gets the time since when this recommended action is valid.

validSince?: Date

Property Value

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

Inherited From ProxyResource.id

The name of the resource

name?: string

Property Value

Inherited From ProxyResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

Inherited From ProxyResource.type