Get-AzSqlCapability

Module:

Az.Sql Module

Gets SQL Database capabilities for the current subscription.

Syntax

FilterResults (Default)

Get-AzSqlCapability
    [-LocationName] <String>
    [-ServerVersionName <String>]
    [-EditionName <String>]
    [-ServiceObjectiveName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DefaultResults

Get-AzSqlCapability
    [-LocationName] <String>
    [-Defaults]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Get-AzSqlCapability cmdlet gets the Azure SQL Database capabilities available on the current subscription for a region. If you specify the ServerVersionName, EditionName, or ServiceObjectiveName parameters, this cmdlet returns the specified values and their predecessors.

Examples

Example 1: Get capabilities for the current subscription for a region

Get-AzSqlCapability -LocationName "Central US"

Location                : Central US
Status                  : Available
SupportedServerVersions : {12.0, 2.0}

This command returns the capabilities for SQL Database instances on the current subscription for the Central US region.

Example 2: Get default capabilities for the current subscription for a region

Get-AzSqlCapability -LocationName "Central US" -Defaults

Location        : Central US
Status          : Available
ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default)

This command returns the default capabilities for SQL Databases on the current subscription in the Central US region.

Example 3: Get details for a service objective

Get-AzSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1"

Location        : Central US
Status          : Available
ExpandedDetails : Version: 12.0 (Available) -> Edition: Standard (Default) -> Service Objective: S1 (Available)
                  Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S1 (Available)

This command gets default capabilities for SQL Databases for the specified service objective on the current subscription.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

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

-Defaults

Indicates that this cmdlet gets only defaults.

Parameter properties

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

Parameter sets

DefaultResults

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

-EditionName

Specifies the name of the database edition for which this cmdlet gets capabilities.

Parameter properties

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

Parameter sets

FilterResults

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

-LocationName

Specifies the name of the Location for which this cmdlet gets capabilities. For more information, see Azure Regionshttp://azure.microsoft.com/en-us/regions/ (http://azure.microsoft.com/en-us/regions/).

Parameter properties

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

Parameter sets

(All)

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

-ServerVersionName

Specifies the name of the server version for which this cmdlet gets capabilities.

Parameter properties

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

Parameter sets

FilterResults

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

-ServiceObjectiveName

Specifies the name of the service objective for which this cmdlet gets capabilities.

Parameter properties

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

Parameter sets

FilterResults

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

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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

String

Outputs

LocationCapabilityModel