Class RecommendedIndex

Represents a database recommended index.

Inheritance
Object
Resource
ProxyResource
RecommendedIndex
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Sql.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class RecommendedIndex : Microsoft.Azure.Management.Sql.Models.ProxyResource

Constructors

RecommendedIndex()

Initializes a new instance of the RecommendedIndex class.

Declaration
public RecommendedIndex ();

RecommendedIndex(String, String, String, Nullable<RecommendedIndexAction>, Nullable<RecommendedIndexState>, Nullable<DateTime>, Nullable<DateTime>, Nullable<RecommendedIndexType>, String, String, IList<String>, IList<String>, String, IList<OperationImpact>, IList<OperationImpact>)

Initializes a new instance of the RecommendedIndex class.

Declaration
public RecommendedIndex (string id = null, string name = null, string type = null, Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexAction> action = null, Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexState> state = null, Nullable<DateTime> created = null, Nullable<DateTime> lastModified = null, Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexType> indexType = null, string schema = null, string table = null, System.Collections.Generic.IList<string> columns = null, System.Collections.Generic.IList<string> includedColumns = null, string indexScript = null, System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Models.OperationImpact> estimatedImpact = null, System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Models.OperationImpact> reportedImpact = null);
Parameters
String id

Resource ID.
String name

Resource name.
String type

Resource type.
Nullable<RecommendedIndexAction> action

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: 'Create', 'Drop', 'Rebuild'
Nullable<RecommendedIndexState> state

The current recommendation state. Possible values include: 'Active', 'Pending', 'Executing', 'Verifying', 'Pending Revert', 'Reverting', 'Reverted', 'Ignored', 'Expired', 'Blocked', 'Success'
Nullable<DateTime> created

The UTC datetime showing when this resource was created (ISO8601 format).
Nullable<DateTime> lastModified

The UTC datetime of when was this resource last changed (ISO8601 format).
Nullable<RecommendedIndexType> indexType

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: 'CLUSTERED', 'NONCLUSTERED', 'COLUMNSTORE', 'CLUSTERED COLUMNSTORE'
String schema

The schema where table to build index over resides
String table

The table on which to build index.
IList<String> columns

Columns over which to build index
IList<String> includedColumns

The list of column names to be included in the index
String indexScript

The full build index script
IList<OperationImpact> estimatedImpact

The estimated impact of doing recommended index action.
IList<OperationImpact> reportedImpact

The values reported after index action is complete.

Properties

Action

Gets the proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: 'Create', 'Drop', 'Rebuild'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.action")]
public Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexAction> Action { get; }
Property Value
Nullable<RecommendedIndexAction>

Columns

Gets columns over which to build index

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.columns")]
public System.Collections.Generic.IList<string> Columns { get; }
Property Value
IList<String>

Created

Gets the UTC datetime showing when this resource was created (ISO8601 format).

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.created")]
public Nullable<DateTime> Created { get; }
Property Value
Nullable<DateTime>

EstimatedImpact

Gets the estimated impact of doing recommended index action.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.estimatedImpact")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Models.OperationImpact> EstimatedImpact { get; }
Property Value
IList<OperationImpact>

IncludedColumns

Gets the list of column names to be included in the index

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.includedColumns")]
public System.Collections.Generic.IList<string> IncludedColumns { get; }
Property Value
IList<String>

IndexScript

Gets the full build index script

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.indexScript")]
public string IndexScript { get; }
Property Value
String

IndexType

Gets the type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: 'CLUSTERED', 'NONCLUSTERED', 'COLUMNSTORE', 'CLUSTERED COLUMNSTORE'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.indexType")]
public Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexType> IndexType { get; }
Property Value
Nullable<RecommendedIndexType>

LastModified

Gets the UTC datetime of when was this resource last changed (ISO8601 format).

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.lastModified")]
public Nullable<DateTime> LastModified { get; }
Property Value
Nullable<DateTime>

ReportedImpact

Gets the values reported after index action is complete.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.reportedImpact")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Models.OperationImpact> ReportedImpact { get; }
Property Value
IList<OperationImpact>

Schema

Gets the schema where table to build index over resides

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.schema")]
public string Schema { get; }
Property Value
String

State

Gets the current recommendation state. Possible values include: 'Active', 'Pending', 'Executing', 'Verifying', 'Pending Revert', 'Reverting', 'Reverted', 'Ignored', 'Expired', 'Blocked', 'Success'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]
public Nullable<Microsoft.Azure.Management.Sql.Models.RecommendedIndexState> State { get; }
Property Value
Nullable<RecommendedIndexState>

Table

Gets the table on which to build index.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.table")]
public string Table { get; }
Property Value
String