Get-AzSynapseKustoPoolAttachedDatabaseConfiguration

Module:

Az.Synapse

Returns an attached database configuration.

Syntax

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
   -KustoPoolName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
   -AttachedDatabaseConfigurationName <String>
   -KustoPoolName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
   -InputObject <ISynapseIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns an attached database configuration.

Examples

Example 1: List all the AttachedDatabaseConfigurations in a kusto pool

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool

Name                                               Type                                                                   Location
----                                               ----                                                                   --------
testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2

The above command lists all the AttachedDatabaseConfigurations in the kusto pool "testfollowerkustopool".

Example 2: Get a specific AttachedDatabaseConfiguration in a kusto pool

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration

Name                                               Type                                                                   Location
----                                               ----                                                                   --------
testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2

The above command returns the AttachedDatabaseConfigurations named "followerconfiguration" in the cluster "testfollowerkustopool".

Parameters

-AttachedDatabaseConfigurationName

The name of the attached database configuration.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

-KustoPoolName

The name of the Kusto pool.

Type:	String
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

IAttachedDatabaseConfiguration