IRecommendedIndexOperations Interface

Definition

Represents all the operations for managing recommended indexes on Azure SQL Databases. Contains operations to retrieve recommended index and update state.

public interface IRecommendedIndexOperations
type IRecommendedIndexOperations = interface
Public Interface IRecommendedIndexOperations

Methods

GetAsync(String, String, String, String, String, String, CancellationToken)

Returns details on recommended index.

UpdateAsync(String, String, String, String, String, String, RecommendedIndexUpdateParameters, CancellationToken)

We execute or cancel index operations by updating index state. Allowed state transitions are :Active -> Pending

  • Start index creation processPending -> Active
  • Cancel index creationActive/Pending -> Ignored
  • Ignore index recommendation so it will no longer show in active recommendationsIgnored -> Active - Restore index recommendationSuccess -> Pending Revert - Revert index that has been createdPending Revert -> Revert Canceled - Cancel index revert operation

Extension Methods

Get(IRecommendedIndexOperations, String, String, String, String, String, String)

Returns details on recommended index.

GetAsync(IRecommendedIndexOperations, String, String, String, String, String, String)

Returns details on recommended index.

Update(IRecommendedIndexOperations, String, String, String, String, String, String, RecommendedIndexUpdateParameters)

We execute or cancel index operations by updating index state. Allowed state transitions are :Active -> Pending

  • Start index creation processPending -> Active
  • Cancel index creationActive/Pending -> Ignored
  • Ignore index recommendation so it will no longer show in active recommendationsIgnored -> Active - Restore index recommendationSuccess -> Pending Revert - Revert index that has been createdPending Revert -> Revert Canceled - Cancel index revert operation
UpdateAsync(IRecommendedIndexOperations, String, String, String, String, String, String, RecommendedIndexUpdateParameters)

We execute or cancel index operations by updating index state. Allowed state transitions are :Active -> Pending

  • Start index creation processPending -> Active
  • Cancel index creationActive/Pending -> Ignored
  • Ignore index recommendation so it will no longer show in active recommendationsIgnored -> Active - Restore index recommendationSuccess -> Pending Revert - Revert index that has been createdPending Revert -> Revert Canceled - Cancel index revert operation

Applies to