Get-AzureSqlDatabase

Updated: September 1, 2015

Get-AzureSqlDatabase

Gets one or more Azure SQL databases.

Syntax

Parameter Set: Default
Get-AzureSqlDatabase [-ResourceGroupName] <System.String> [-ServerName] <System.String> [[-DatabaseName] <System.String> ] [-Profile <Microsoft.Azure.Common.Authentication.Models.AzureProfile> ] 




Detailed Description

The Get-AzureSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server.

Parameters

-DatabaseName<System.String>

Specifies the name of the database to retrieve.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-Profile<Microsoft.Azure.Common.Authentication.Models.AzureProfile>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ResourceGroupName<System.String>

Specifies the name of the resource group of the server that contains the database.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-ServerName<System.String>

Specifies the name of the server the database is in.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

Notes

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

Examples

Example 1: Get all databases on a server

This command gets all databases on the server named Server01.


PS C:\> Get-AzureSqlDatabase -ResourceGroupName "ResourceGroup11" -ServerName "Server01"

Example 2: Get a database by name on a server

This command gets a database named Database02 from a server named Server01.


PS C:\> Get-AzureSqlDatabase -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database02"

Related topics

Show: