Edit

Share via


Get-AzureSqlDatabaseServiceObjective

Gets service objectives for an Azure SQL Database server.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

ByConnectionContext (Default)

Get-AzureSqlDatabaseServiceObjective
    -Context <IServerDataServiceContext>
    [-ServiceObjective <ServiceObjective>]
    [-ServiceObjectiveName <String>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

ByServerName

Get-AzureSqlDatabaseServiceObjective
    -ServerName <String>
    [-ServiceObjective <ServiceObjective>]
    [-ServiceObjectiveName <String>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Get-AzureSqlDatabaseServiceObjective cmdlet gets service objectives for an Azure SQL Database server. Service objectives are referred to as performance levels. If you do not specify a service objective, this cmdlet returns all valid service objectives for the specified server.

This cmdlet applies to Basic, Standard, and Premium service tiers.

Examples

Example 1: Get all the service objectives by using a connection context

PS C:\> Get-AzureSqlDatabaseServiceObjective -Context $Context

This command gets all the service objectives for the server that the connection context $Context specifies.

Example 2: Get all the service objectives by using a server name

PS C:\> Get-AzureSqlDatabaseServiceObjective -ServerName "Server01"

This command gets all the service objectives for the server named Server01.

Parameters

-Context

Specifies the connection context of a server.

Parameter properties

Type:IServerDataServiceContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByConnectionContext
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerName

Specifies the name of a server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByServerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServiceObjective

Specifies an object that represents the service objective that this cmdlet gets. Valid values are:

  • Basic: dd6d99bb-f193-4ec1-86f2-43d3bccbc49c
  • Standard (S0): f1173c43-91bd-4aaa-973c-54e79e15235b
  • Standard (S1): 1b1ebd4d-d903-4baa-97f9-4ea675f5e928
  • Standard (S2): 455330e1-00cd-488b-b5fa-177c226f28b7
  • *Standard (S3): 789681b8-ca10-4eb0-bdf2-e0b050601b40
  • Premium (P1): 7203483a-c4fb-4304-9e9f-17c71c904f5d
  • Premium (P1): 7203483a-c4fb-4304-9e9f-17c71c904f5d
  • Premium (P2): a7d1b92d-c987-4375-b54d-2b1d0e0f5bb0
  • Premium (P3): a7c4c615-cfb1-464b-b252-925be0a19446

*Standard (S3) is part of the Latest SQL Database Update V12 (preview).

Parameter properties

Type:ServiceObjective
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceObjectiveName

Specifies the name of a service objective to get. Valid values are: Basic, S0, S1, S2, S3, P1, P2, and P3.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.ServiceObjective

Outputs

IEnumerable