Start-AzureRmSqlDatabaseExecuteIndexRecommendation

Reference

Module:: AzureRM.Sql

Starts the workflow that runs a recommended index operation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: Run an index recommendation

PS C:\>Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "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:	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