Az.SqlServer PowerShell Cmdlets

This reference provides documentation for the Az.SqlServer set of PowerShell cmdlets used to manage Azure SQL Server resources.

Overview

The Az.SqlServer module includes cmdlets to create, retrieve, update, and delete SQL Server instances. All cmdlets follow the standard Azure PowerShell naming convention: Verb-AzSqlServer.

Cmdlet Summary

Get-AzSqlServer

Retrieves a specific SQL Server or lists all servers within a subscription or resource group.

Syntax

Get-AzSqlServer [-ResourceGroupName <String>] [-ServerName <String>] []

Parameters

• -ResourceGroupName (String, optional): The name of the resource group.
• -ServerName (String, optional): The name of the SQL Server.

Example

# List all SQL servers in a resource group
Get-AzSqlServer -ResourceGroupName "MyResourceGroup"

# Get a specific server
Get-AzSqlServer -ResourceGroupName "MyResourceGroup" -ServerName "myserver"

New-AzSqlServer

Creates a new Azure SQL Server.

Syntax

New-AzSqlServer -ResourceGroupName <String> -ServerName <String> -Location <String> -AdministratorLogin <String> -AdministratorLoginPassword <SecureString> []

Parameters

• -ResourceGroupName (String, required)
• -ServerName (String, required)
• -Location (String, required)
• -AdministratorLogin (String, required)
• -AdministratorLoginPassword (SecureString, required)

Example

# Prompt for password securely
$pwd = Read-Host -AsSecureString -Prompt "Enter admin password"

# Create a new server
New-AzSqlServer -ResourceGroupName "MyRG" `
               -ServerName "mynewserver" `
               -Location "EastUS" `
               -AdministratorLogin "sqladmin" `
               -AdministratorLoginPassword $pwd

Set-AzSqlServer

Updates properties of an existing Azure SQL Server.

Syntax

Set-AzSqlServer -ResourceGroupName <String> -ServerName <String> [-AdministratorLoginPassword <SecureString>] []

Example

# Change the admin password
$newPwd = Read-Host -AsSecureString -Prompt "New admin password"

Set-AzSqlServer -ResourceGroupName "MyRG" `
                -ServerName "myserver" `
                -AdministratorLoginPassword $newPwd

Remove-AzSqlServer

Deletes a SQL Server from Azure.

Syntax

Remove-AzSqlServer -ResourceGroupName <String> -ServerName <String> [-Force] []

Example

# Delete a server with confirmation
Remove-AzSqlServer -ResourceGroupName "MyRG" -ServerName "myserver"

# Delete without prompting
Remove-AzSqlServer -ResourceGroupName "MyRG" -ServerName "myserver" -Force

Related Topics

• Az.SqlDatabase cmdlets
• Az.SqlFirewallRule cmdlets
• Official Az.Sql module documentation