Skip to content

Latest commit

 

History

History
132 lines (96 loc) · 3.32 KB

Stop-AzSqlDatabaseExecuteIndexRecommendation.md

File metadata and controls

132 lines (96 loc) · 3.32 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
Az.Sql
4D2E0956-FBFA-43CC-ABE3-A6CBB9409263
2.0.0

Stop-AzSqlDatabaseExecuteIndexRecommendation

SYNOPSIS

Stops the workflow that runs a recommended index operation.

SYNTAX

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

DESCRIPTION

The Stop-AzSqlDatabaseExecuteIndexRecommendation cmdlet stops the workflow that runs a recommended index operation.

EXAMPLES

Example 1: Stop running an index recommendation

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

This command stops running an index recommendation.

PARAMETERS

-DatabaseName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-IndexRecommendationName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServerName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Sql.Model.IndexRecommendation

NOTES

RELATED LINKS

Get-AzSqlDatabaseIndexRecommendation

Start-AzSqlDatabaseExecuteIndexRecommendation

SQL Database Documentation