Get-AzureRmSqlElasticPoolRecommendation

Gets elastic pool recommendations.

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

Get-AzureRmSqlElasticPoolRecommendation
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzureRmSqlElasticPoolRecommendation cmdlet gets elastic pool recommendations for a server. These recommendations include the following values:

  • DatabaseCollection. Collection of database names that belong to the pool.
  • DatabaseDtuMin. Data Transmission Unit (DTU) guarantee for databases in the elastic pool. -- DatabaseDtuMax. DTU cap for databases in the elastic pool.
  • Dtu. DTU guarantee for the elastic pool.
  • StorageMb. Storage in megabytes for the elastic pool.
  • Edition. Edition for the elastic pool. The acceptable values for this parameter are: Basic, Standard, and Premium.
  • IncludeAllDatabases. Indicates whether to all databases in the elastic pool are returned.
  • Name. Name of the elastic pool.

Examples

Example 1: Get recommendations for a server

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

This command gets the elastic pool recommendations for the server named Server01.

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

-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

-ResourceGroupName

Specifies 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 name of the server for which this cmdlet gets recommendations.

Type:String
Position:1
Default value:None
Required:True
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

UpgradeRecommendedElasticPoolProperties