Get-AzSqlDatabase

Reference

Module:: Az.Sql

Gets one or more databases.

Syntax

Get-AzSqlDatabase
   [[-DatabaseName] <String>]
   [-ExpandKeyList]
   [-KeysFilter <String>]
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.

Examples

Example 1: Get all databases on a server

Get-AzSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01"

ResourceGroupName				         : resourcegroup01
ServerName						           : server01
DatabaseName					           : master
Location						             : Central US
DatabaseId						           : a2a7f2db-7526-4d86-a7b2-36276ee10dc6
Edition							             : None
CollationName					           : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				         : 
MaxSizeBytes					           : 5368709120
Status							             : Online
CreationDate					           : 7/3/2015 7:32:44 AM
CurrentServiceObjectiveId		     : c99ac918-dbea-463f-a475-16ec020fdc12
CurrentServiceObjectiveName		   : System1
RequestedServiceObjectiveId		   : c99ac918-dbea-463f-a475-16ec020fdc12
RequestedServiceObjectiveName	   : 
ElasticPoolName					         : 
EarliestRestoreDate				       : 
Tags							               :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo

ResourceGroupName				         : resourcegroup01
ServerName						           : server01
DatabaseName                     : database01
Location						             : Central US
DatabaseId						           : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition							             : Standard
CollationName					           : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				         : 
MaxSizeBytes					           : 268435456000
Status							             : Online
CreationDate					           : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		     : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		   : S0
RequestedServiceObjectiveId		   : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	   : 
ElasticPoolName					         : 
EarliestRestoreDate				       : 
Tags							               :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo

This command gets all databases on the server named server01.

Example 2: Get a database by name on a server

Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02"

ResourceGroupName				         : resourcegroup01
ServerName						           : server01
DatabaseName					           : database02
Location						             : Central US
DatabaseId						           : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition							             : Standard
CollationName					           : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				         : 
MaxSizeBytes					           : 268435456000
Status							             : Online
CreationDate					           : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		     : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		   : S0
RequestedServiceObjectiveId		   : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	   : 
ElasticPoolName                  : 
EarliestRestoreDate				       : 
Tags							               :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo

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

Example 3: Get all databases on a server using filtering

Get-AzSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database*"

ResourceGroupName				         : resourcegroup01
ServerName						           : server01
DatabaseName					           : database01
Location						             : Central US
DatabaseId						           : a2a7f2db-7526-4d86-a7b2-36276ee10dc6
Edition							             : None
CollationName				             : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				         : 
MaxSizeBytes					           : 5368709120
Status							             : Online
CreationDate					           : 7/3/2015 7:32:44 AM
CurrentServiceObjectiveId		     : c99ac918-dbea-463f-a475-16ec020fdc12
CurrentServiceObjectiveName		   : System1
RequestedServiceObjectiveId		   : c99ac918-dbea-463f-a475-16ec020fdc12
RequestedServiceObjectiveName	   : 
ElasticPoolName					         : 
EarliestRestoreDate				       : 
Tags							               : 
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo

ResourceGroupName				         : resourcegroup01
ServerName						           : server01
DatabaseName					           : database02
Location                         : Central US
DatabaseId					             : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition						               : Standard
CollationName					           : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				         : 
MaxSizeBytes					           : 268435456000
Status							             : Online
CreationDate					           : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		     : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		   : S0
RequestedServiceObjectiveId		   : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	   : 
ElasticPoolName					         : 
EarliestRestoreDate				       : 
Tags                             :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo

This command gets all databases on the server named server01 that start with "database".

Example 4: Get a database with TDE AKV keys on a server using expand keys parameter.

Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList

ResourceGroupName				 : resourcegroup01
ServerName						 : server01
DatabaseName					 : database02
Location						 : Central US
DatabaseId						 : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition							 : Standard
CollationName					 : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				 : 
MaxSizeBytes					 : 268435456000
Status							 : Online
CreationDate					 : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		 : S0
RequestedServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	 : 
ElasticPoolName                  : 
EarliestRestoreDate				 : 
Tags							 :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo
Identity                         : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity
EncryptionProtector              : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
Keys                             : {[https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901, Microsoft.Azure.Management.Sql.Models.DatabaseKey], 
                                    [https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109, Microsoft.Azure.Management.Sql.Models.DatabaseKey]}
FederatedClientId                :

This command gets all the TDE AKV keys configured on the database.

Example 5: Get a database with TDE AKV keys on a server using expand keys and filter by date

Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList -KeysFilter "1/13/2022"

ResourceGroupName				 : resourcegroup01
ServerName						 : server01
DatabaseName					 : database02
Location						 : Central US
DatabaseId						 : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition							 : Standard
CollationName					 : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				 : 
MaxSizeBytes					 : 268435456000
Status							 : Online
CreationDate					 : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		 : S0
RequestedServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	 : 
ElasticPoolName                  : 
EarliestRestoreDate				 : 
Tags							 :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo
Identity                         : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity
EncryptionProtector              : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
Keys                             : {[https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901, Microsoft.Azure.Management.Sql.Models.DatabaseKey], 
                                    [https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109, Microsoft.Azure.Management.Sql.Models.DatabaseKey]}
FederatedClientId                :

This command gets a database configured with TDE CMK keys

Example 6: Get a database with TDE AKV keys on a server using expand keys and filter as 'current'

Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList -KeysFilter "current"

ResourceGroupName				 : resourcegroup01
ServerName						 : server01
DatabaseName					 : database02
Location						 : Central US
DatabaseId						 : a1e6bd1a-735a-4d48-8b98-afead5ef1218
Edition							 : Standard
CollationName					 : SQL_Latin1_General_CP1_CI_AS
CatalogCollation				 : 
MaxSizeBytes					 : 268435456000
Status							 : Online
CreationDate					 : 7/3/2015 7:33:37 AM
CurrentServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
CurrentServiceObjectiveName		 : S0
RequestedServiceObjectiveId		 : f1173c43-91bd-4aaa-973c-54e79e15235b
RequestedServiceObjectiveName	 : 
ElasticPoolName                  : 
EarliestRestoreDate				 : 
Tags							 :
CurrentBackupStorageRedundancy	 : Geo
RequestedBackupStorageRedundancy : Geo
Identity                         : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity
EncryptionProtector              : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
Keys                             : 
FederatedClientId                :

This command gets a database configured with TDE CMK keys with filter as 'current'

Example 7: Get a database configured with preferred enclave type as VBS

Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02"

ResourceGroupName             : ResourceGroup01
ServerName                    : Server01
DatabaseName                  : Database02
Location                      : Central US
DatabaseId                    : 34d9d561-42a7-484e-bf05-62ddef8000ab
Edition                       : GeneralPurpose
CollationName                 : SQL_Latin1_General_CP1_CI_AS
CatalogCollation              :
MaxSizeBytes                  : 268435456000
Status                        : Online
CreationDate                  : 8/26/2015 10:04:29 PM
CurrentServiceObjectiveName   : GP_Gen5_2
RequestedServiceObjectiveName :
ElasticPoolName               :
EarliestRestoreDate           :
LicenseType                   : LicenseIncluded
Tags                          :
EnableLedger                  : False
PreferredEnclaveType          : VBS

This command gets a database configured with VBS enclave

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Specifies the name of the database to retrieve.

Type:	String
Aliases:	Name
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpandKeyList

Flag to be used to view all the AKV keys in a database.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeysFilter

Timestamp filter to Get AKV keys

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of the resource group to which the database server is assigned.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerName

Specifies the name of the server to which the database is assigned.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

AzureSqlDatabaseModel

Collaborate with us on GitHub

The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.

Azure PowerShell feedback

Azure PowerShell is an open source project. Select a link to provide feedback:

Open a documentation issue Provide product feedback

Connect, code, and grow

Share via

Syntax

Description

Examples

Example 1: Get all databases on a server

Example 2: Get a database by name on a server

Example 3: Get all databases on a server using filtering

Example 4: Get a database with TDE AKV keys on a server using expand keys parameter.

Example 5: Get a database with TDE AKV keys on a server using expand keys and filter by date

Example 6: Get a database with TDE AKV keys on a server using expand keys and filter as 'current'

Example 7: Get a database configured with preferred enclave type as VBS

Parameters

-Confirm

-DatabaseName

-DefaultProfile

-ExpandKeyList

-KeysFilter

-ResourceGroupName

-ServerName

-WhatIf

Inputs

Outputs

Share via

Get-AzSqlDatabase

Syntax

Description

Examples

Example 1: Get all databases on a server

Example 2: Get a database by name on a server

Example 3: Get all databases on a server using filtering

Example 4: Get a database with TDE AKV keys on a server using expand keys parameter.

Example 5: Get a database with TDE AKV keys on a server using expand keys and filter by date

Example 6: Get a database with TDE AKV keys on a server using expand keys and filter as 'current'

Example 7: Get a database configured with preferred enclave type as VBS

Parameters

-Confirm

-DatabaseName

-DefaultProfile

-ExpandKeyList

-KeysFilter

-ResourceGroupName

-ServerName

-WhatIf

Inputs

Outputs

Related Links