Get-​Azure​Rm​Sql​Server

Returns information about SQL Database servers.

Syntax

Get-AzureRmSqlServer
   [-ResourceGroupName] <String>
   [[-ServerName] <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Get-AzureRmSqlServer cmdlet returns information about one or more Azure SQL Database servers. Specify the name of a server to see information for only that server.

Examples

Example 1: Get all instances of SQL Server assigned to a resource group

PS C:\>Get-AzureRmSqlServer -ResourceGroupName "ResourceGroup01"
ResourceGroupName        : resourcegroup01
ServerName               : server01
Location                 : Central US
SqlAdministratorLogin    : adminLoginSqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     : 

ResourceGroupName        : resourcegroup01
ServerName               : server02
Location                 : West US
SqlAdministratorLogin    : adminLogin
SqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     :

This command gets information about all the Azure SQL Database servers assigned to the resource group ResourceGroup01.

Example 2: Get information about an Azure SQL Database server

PS C:\>Get-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01"
ResourceGroupName        : resourcegroup01
ServerName               : server01
Location                 : Central US
SqlAdministratorLogin    : adminLogin
SqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     :

This command gets information about the Azure SQL Database server named Server01.

Example 3: Get all instances of SQL Server in the subscription

PS C:\>Get-AzureRmResourceGroup | Get-AzureRmSqlServer
ResourceGroupName        : resourcegroup01
ServerName               : server01
Location                 : Central US
SqlAdministratorLogin    : adminLogin
SqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     : 

ResourceGroupName        : resourcegroup01
ServerName               : server02
Location                 : West US
SqlAdministratorLogin    : adminLogin
SqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     : 

ResourceGroupName        : resourcegroup02
ServerName               : server03
Location                 : East US
SqlAdministratorLogin    : adminLogin
SqlAdministratorPassword : 
ServerVersion            : 12.0
Tags                     :

This command gets information about all the Azure SQL Database servers in the current subscription.

Required Parameters

-ResourceGroupName

Specifies the name of the resource group to which servers are assigned.

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

Optional 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
-ServerName

Specifies the name of the server that this cmdlet gets.

Type:String
Aliases:Name
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
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

Outputs

Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel