你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzSynapseSqlPool
Gets a Synapse Analytics SQL pool.
Syntax
Get-AzSynapseSqlPool
[-ResourceGroupName <String>]
-WorkspaceName <String>
[-Name <String>]
[-Version <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzSynapseSqlPool
[-Name <String>]
[-Version <Int32>]
-WorkspaceObject <PSSynapseWorkspace>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzSynapseSqlPool
[-Version <Int32>]
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSynapseSqlPool cmdlet gets information about an Azure Synapse Analytics SQL pool.
Examples
Example 1
Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace
This command gets all SQL pools under a workspace.
Example 2
Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool
This command gets the SQL pool under workspace ContosoWorkspace with name ContosoSqlPool.
Example 3
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseSqlPool
This command gets all the SQL pools under a workspace through pipeline.
Example 4
Get-AzSynapseSqlPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool"
This command gets the SQL pool 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 pool.
Type: | String |
Aliases: | SqlPoolName |
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 Pool.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Version
[This feature is in a limited preview, initially accessible only to certain subscriptions.] Version of Synapse SQL pool. For example, 2 or 3.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
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 |