Get-AzSqlDatabaseIndexRecommendation

Module:

Az.Sql

Gets the recommended index operations for a server or database.

Syntax

Get-AzSqlDatabaseIndexRecommendation
   -ServerName <String>
   [-DatabaseName <String>]
   [-TableName <String>]
   [-IndexRecommendationName <String>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzSqlDatabaseIndexRecommendation cmdlet gets the recommended index operations for an Azure SQL Database server or database.

Examples

Example 1: Get index recommendations for all databases on server

Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01"

This command returns index recommendations for all databases on server server01.

Example 2: Get index recommendations for a specific database

Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"

This command returns index recommendations for specific database.

Example 3: Get a single index recommendation by name

Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME"

This command returns single index recommendation by name.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Specifies the name of the database for which this cmdlet gets index recommendations.

Type:	String
Position:	Named
Default value:	None
Required:	False
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 gets.

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

-ResourceGroupName

Specifies the name of the resource group that the server is assigned for. This cmdlet gets index recommendations for a database hosted by this server.

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 gets index recommendations.

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

-TableName

Specifies the name of an Azure SQL table.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

IndexRecommendation

Related Links

• Start-AzSqlDatabaseExecuteIndexRecommendation
• Stop-AzSqlDatabaseExecuteIndexRecommendation