Edit

Get-AzSynapseKustoPool

  • Reference
Module:
Az.Synapse

Gets a Kusto pool.

Syntax

Get-AzSynapseKustoPool
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSynapseKustoPool
   -Name <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSynapseKustoPool
   -InputObject <ISynapseIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a Kusto pool.

Examples

Example 1: List all Kusto pools in a workspace

Get-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws

Location  Name                     Type                                    Etag
--------  ----                     ----                                    ----
East US 2 testws/testnewkustopool  Microsoft.Synapse/workspaces/kustoPools 
East US 2 testws/testnewkustopool1 Microsoft.Synapse/workspaces/kustoPools

The above command lists all Kusto pools in the resource group "testrg".

Example 2: Get a specific Kusto pool by name

Get-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool

Location  Name                    Type                                    Etag
--------  ----                    ----                                    ----
East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools

The above command returns the Kusto pool named "testnewkustopool" in the resource group "testrg".

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the Kusto pool.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

The name of the workspace

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

Inputs

ISynapseIdentity

Outputs

IKustoPool

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISynapseIdentity>: Identity Parameter

  • [AttachedDatabaseConfigurationName <String>]: The name of the attached database configuration.
  • [DataConnectionName <String>]: The name of the data connection.
  • [DatabaseName <String>]: The name of the database in the Kusto pool.
  • [Id <String>]: Resource identity path
  • [KustoPoolName <String>]: The name of the Kusto pool.
  • [Location <String>]: The name of Azure region.
  • [PrincipalAssignmentName <String>]: The name of the Kusto principalAssignment.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [WorkspaceName <String>]: The name of the workspace