Get-AzureSqlDatabase

Reference

Module:: Azure

Retrieves one or more databases.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

Get-AzureSqlDatabase
   -ConnectionContext <IServerDataServiceContext>
   [-Database <Database>]
   [-DatabaseName <String>]
   [-RestorableDropped]
   [-RestorableDroppedDatabase <RestorableDroppedDatabase>]
   [-DatabaseDeletionDate <DateTime>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Get-AzureSqlDatabase
   -ServerName <String>
   [-Database <Database>]
   [-DatabaseName <String>]
   [-RestorableDropped]
   [-RestorableDroppedDatabase <RestorableDroppedDatabase>]
   [-DatabaseDeletionDate <DateTime>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureSqlDatabase cmdlet retrieves one or more instances of an Azure SQL Database from an Azure SQL Database server. You can specify the server with an Azure SQL Database server connection context that you create using the New-AzureSqlDatabaseServerContext cmdlet. Or, if you specify the Azure SQL Database server name, the cmdlet uses the current Azure subscription information to authenticate the request to access the server.

If you do not specify a database, the Get-AzureSqlDatabase cmdlet returns all databases from the specified server.

Retrieving restorable dropped databases:

Retrieve restorable dropped databases by using the RestorableDropped parameter. To return all restorable dropped databases use the RestorableDropped parameter without DatabaseName and DatabaseDeletionDate. To return a specific restorable dropped database use the RestorableDropped parameter with the DatabaseName and DatabaseDeletionDate parameters. When retrieving a specific restorable dropped database by using the DatabaseName parameter you must also include the DatabaseDeletionDate parameter and the specified DatabaseDeletionDate value must include milliseconds to match the desired database.

The Get-AzureSqlDatabase cmdlet returns either all restorable dropped databases on a server, or one specific database that matches both DatabaseName and DatabaseDeletionDate. To return restorable dropped databases that satisfy different criteria, such as all restorable dropped databases of a specific name, you must return all restorable dropped databases, and then filter the results on the client.

Examples

Example 1: Retrieve all databases on a server

PS C:\> Get-AzureSqlDatabase -ServerName "lpqd0zbr8y"

This command retrieves all databases on the server named lpqd0zbr8y.

Example 2: Retrieve all restorable dropped databases on a server

PS C:\> Get-AzureSqlDatabase -ServerName "lpqd0zbr8y" -RestorableDropped

This command retrieves all restorable dropped databases on the server named lpqd0zbr8y.

Example 3: Retrieve a database from a server specified by a connection context

PS C:\> $Database01 = Get-AzureSqlDatabase -ConnectionContext $Context -DatabaseName "Database01"

This command retrieves database named Database01 from the server specified by the connection context $Context.

Example 4: Store a database object in a variable

PS C:\> $Database01 = Get-AzureSqlDatabase -ServerName "lpqd0zbr8y" -DatabaseName "Database01"

This command retrieves database named Database01 from the server named lpqd0zbr8y. The command stores the database object in the $Database01 variable.

Example 5: Retrieve a restorable dropped database

PS C:\> $DroppedDB = Get-AzureSqlDatabase -ServerName "lpqd0zbr8y" -DatabaseName "Database01" -DatabaseDeletionDate "2012-11-09T22:59:43.000Z" -RestorableDropped

This command retrieves the restorable dropped database named Database01 that was deleted on 11/9/2012 from the server named lpqd0zbr8y. This command stores the results in the $DroppedDB variable.

Example 6: Retrieve all restorable dropped databases on a server and filter the results

PS C:\> Get-AzureSqlDatabase -ServerName "lpqd0zbr8y" -RestorableDropped | Where-Object {$_.Name -eq "ContactDB"}

This command retrieves all restorable dropped databases on the server named lpqd0zbr8y, and then filters the results to only the databases named ContactDB.

Parameters

-ConnectionContext

Specifies the connection context of a server from which to retrieve a database.

Type:	IServerDataServiceContext
Aliases:	Context
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Database

Specifies an object that represents the database that this cmdlet retrieves.

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

-DatabaseDeletionDate

Specifies the date and time of a deletion. If you specify the RestorableDropped parameter, specify this parameter to retrieve a restorable dropped database based on the deletion date and time.

The DatabaseDeletionDate parameter must include milliseconds to match the time of the desired database. Specifying a value without milliseconds results in the database not being found.

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

-DatabaseName

Specifies the name of the database that this cmdlet retrieves.

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

-Profile

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

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

-RestorableDropped

Indicates that this cmdlet returns RestorableDroppedDatabase objects instead of Database objects. You can use the DatabaseDeletionDate parameter to select a specific restorable dropped database.

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

-RestorableDroppedDatabase

Specifies an object that represents the restorable dropped database that this cmdlet retrieves.

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

-ServerName

Specifies the name of the server that contains the database that this cmdlet retrieves. The cmdlet uses the current Azure subscription to access the server.

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

Inputs

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.Database

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.RestorableDroppedDatabase

Outputs

IEnumerable\<Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.Database\>

This cmdlet returns a Database object if you do not specify the RestorableDropped parameter.

IEnumerable\<Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.RestorableDroppedDatabase\>

This cmdlet returns a RestorableDroppedDatabase object if you specify the RestorableDropped parameter.