Get-AzureRmSqlDatabaseUpgradeHint

Reference

Module:: AzureRM.Sql

Gets pricing tier hints for a database.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Get-AzureRmSqlDatabaseUpgradeHint
   [-ServerName] <String>
   [-DatabaseName <String>]
   [-ExcludeElasticPoolCandidates <Boolean>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzureRmSqlDatabaseUpgradeHint cmdlet gets pricing tier hints for upgrading an Azure SQL Database. Databases that are still in Web and Business pricing tiers get the hint to upgrade to the new Basic, Standard, or Premium pricing tiers. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.

Examples

Example 1: Get recommendations for all databases on a server

PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01"

This command returns upgrade hints for all databases on the server named Server01.

Example 2: Get recommendations for specific database

PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"

This command returns upgrade hints for a specific database.

Example 3: Get recommendation for all databases that are not in an elastic database pool

PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ExcludeElasticPoolCandidates $True

This command returns upgrade hints for all databases that are not in an elastic database pool.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DatabaseName

Specifies the name of the SQL database for which this cmdlet gets an upgrade hint. If you do not specify a database, this cmdlet gets hints for all databases on the logical server.

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeElasticPoolCandidates

Indicates whether databases in elastic database pools are excluded from the returned recommendations.

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

-ResourceGroupName

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

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

-ServerName

Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint.

Type:	String
Position:	1
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Boolean

Outputs

RecommendedDatabaseProperties