Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
Returns an attached database configuration.
Syntax
Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
-KustoPoolName <String>
-ResourceGroupName <String>
-WorkspaceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSynapseKustoPoolAttachedDatabaseConfiguration
-AttachedDatabaseConfigurationName <String>
-KustoPoolName <String>
-ResourceGroupName <String>
-WorkspaceName <String>
[-SubscriptionId <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 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 |
-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
Outputs
IAttachedDatabaseConfiguration
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
Azure PowerShell
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for