Share via

RecommendedAction Class

  • Reference

Database, Server or Elastic Pool Recommended Action.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.sql.models._models_py3.ProxyResource
RecommendedAction

Constructor

RecommendedAction(*, state: RecommendedActionStateInfo | None = None, **kwargs)

Parameters

Name Description
state
Required
RecommendedActionStateInfo

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

Keyword-Only Parameters

Name Description
state
Required

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
kind
str

Resource kind.
location
str

Resource location.
recommendation_reason
str

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

Gets the time since when this recommended action is valid.
last_refresh
datetime

Gets time when this recommended action was last refreshed.
is_executable_action
bool

Gets if this recommended action is actionable by user.
is_revertable_action
bool

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

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

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

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

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

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

Gets if approval for applying this recommended action was given by user/system. Possible values include: "User", "System".
execute_action_initiated_time
datetime

Gets the time when this recommended action was approved for execution.
revert_action_initiated_by
str or RecommendedActionInitiatedBy

Gets if approval for reverting this recommended action was given by user/system. Possible values include: "User", "System".
revert_action_initiated_time
datetime

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

Gets the impact of this recommended action. Possible values are 1 - Low impact, 2

  • Medium Impact and 3 - High Impact.
implementation_details
RecommendedActionImplementationInfo

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

Gets the error details if and why this recommended action is put to error state.
estimated_impact
list[RecommendedActionImpactRecord]

Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change.
observed_impact
list[RecommendedActionImpactRecord]

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

Gets the time series info of metrics for this recommended action e.g., CPU consumption time series.
linked_objects
list[str]

Gets the linked objects, if any.
details
dict[str, any]

Gets additional details specific to this recommended action.