Get-AzSynapseSqlDatabase

Module:

Az.Synapse

This feature is in a limited preview, initially accessible only to certain subscriptions. Gets a Synapse Analytics SQL database.

Syntax

Get-AzSynapseSqlDatabase
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseSqlDatabase
   [-Name <String>]
   -WorkspaceObject <PSSynapseWorkspace>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseSqlDatabase
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

[This feature is in a limited preview, initially accessible only to certain subscriptions.] The Get-AzSynapseSqlDatabase cmdlet gets information about an Azure Synapse Analytics SQL database.

Examples

Example 1

Get-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace

This command gets all SQL databases under a workspace.

Example 2

Get-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase

This command gets the SQL database under workspace ContosoWorkspace with name ContosoSqlDatabase.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseSqlDatabase

This command gets all the SQL databases under a workspace through pipeline.

Example 4

Get-AzSynapseSqlDatabase -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlDatabases/ContosoSqlDatabase"

This command gets the SQL database with the specified resource ID.

Parameters

-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

-Name

Name of Synapse SQL Database.

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

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse SQL Database.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

Outputs

PSSynapseSqlDatabase