Start-AzSqlDatabaseExecuteIndexRecommendation

  • Reference
Module:
Az.Sql

Starts the workflow that runs a recommended index operation.

Syntax

Start-AzSqlDatabaseExecuteIndexRecommendation
     -ServerName <String>
     -DatabaseName <String>
     -IndexRecommendationName <String>
     [-ResourceGroupName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Description

The Start-AzSqlDatabaseExecuteIndexRecommendation cmdlet starts the workflow that runs a recommended index operation for an Azure SQL Database.

Examples

Example 1: Run an index recommendation

Start-AzSqlDatabaseExecuteIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME"

This command runs an index recommendation.

Parameters

-DatabaseName

Specifies the name of the database for which this cmdlet starts the workflow.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IndexRecommendationName

Specifies the name of the index recommendation that this cmdlet runs.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group to which the server is assigned.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the server that hosts the database for which this cmdlet starts a workflow.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

IndexRecommendation