RecommendedActionData Class

Definition

A class representing the RecommendedAction data model. Database, Server or Elastic Pool Recommended Action.

public class RecommendedActionData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.RecommendedActionData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.RecommendedActionData>
type RecommendedActionData = class
    inherit ResourceData
    interface IJsonModel<RecommendedActionData>
    interface IPersistableModel<RecommendedActionData>
Public Class RecommendedActionData
Inherits ResourceData
Implements IJsonModel(Of RecommendedActionData), IPersistableModel(Of RecommendedActionData)
Inheritance
RecommendedActionData
Implements

Constructors

RecommendedActionData()

Initializes a new instance of RecommendedActionData.

Properties

Details

Gets additional details specific to this recommended action.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

ExecuteActionInitiatedOn

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

ExecuteActionStartOn

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

Id

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

(Inherited from ResourceData)
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.

Kind

Resource kind.

LastRefresh

Gets time when this recommended action was last refreshed.

LinkedObjects

Gets the linked objects, if any.

Location

Resource location.

Name

The name of the resource.

(Inherited from ResourceData)
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.

ResourceType

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

(Inherited from ResourceData)
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.

RevertActionInitiatedOn

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

RevertActionStartOn

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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<RecommendedActionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RecommendedActionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RecommendedActionData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RecommendedActionData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RecommendedActionData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to