Get-FabricSQLDatabase

Retrieves Fabric SQL Database details.

Syntax

Parameter set: WorkspaceId

Get-FabricSQLDatabase -WorkspaceId <guid> [-SQLDatabaseName <string>] [-SQLDatabaseId <guid>]
 [<CommonParameters>]

Parameter set: WorkspaceObject

Get-FabricSQLDatabase -Workspace <Object> [-SQLDatabaseName <string>] [-SQLDatabaseId <guid>]
 [<CommonParameters>]

Description

Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter, all SQL Databases are returned. If you want to retrieve a specific SQLDatabase, you can use the SQLDatabaseName or SQLDatabaseID parameter. These parameters cannot be used together.

Examples

Example 1

Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId.

$FabricSQLDatabaseConfig = @{
    WorkspaceId = '12345678-1234-1234-1234-123456789012'
    SQLDatabaseName = 'MySQLDatabase'
}
Get-FabricSQLDatabase @FabricSQLDatabaseConfig

Example 2

Returns the details of the Fabric SQL Databases in the workspace that is specified by the WorkspaceId.

Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012'

Example 3

Returns the details of the Fabric SQL Database with the ID '12345678-1234-1234-1234-123456789012' from the workspace with the ID '12345678-1234-1234-1234-123456789012'.

Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' -SQLDatabaseId '12345678-1234-1234-1234-123456789012'

Example 4

Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace.

Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase

Parameters

Name	Type	Req.	Pos.	Pipeline	Description
-Workspace	object	✓Required	Named	Value	The workspace object. This is a mandatory parameter for the 'WorkspaceObject' parameter set and can be pipelined into the function. The object can be easily retrieved by Get-FabricWorkspace function.
-WorkspaceId	guid	✓Required	Named	–	Id of the Fabric Workspace for which the SQL Databases should be retrieved. The value for WorkspaceId is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'.
-SQLDatabaseIdalias: Id	guid		Named	–	The Id of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseName. The value for SQLDatabaseID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'.
-SQLDatabaseNamealias: Name, DisplayName	string		Named	–	The name of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.