Get-AzSynapseKustoPoolDatabasePrincipalAssignment
Gets a Kusto pool database principalAssignment.
Syntax
Get-AzSynapseKustoPoolDatabasePrincipalAssignment
-DatabaseName <String>
-KustoPoolName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSynapseKustoPoolDatabasePrincipalAssignment
-DatabaseName <String>
-KustoPoolName <String>
-PrincipalAssignmentName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSynapseKustoPoolDatabasePrincipalAssignment
-InputObject <ISynapseIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets a Kusto pool database principalAssignment.
Examples
Example 1: List all PrincipalAssignments in a kusto database by name
Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase
Name Type
---- ----
testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments
testws/testkustopool/mykustodatabase/kustoprincipal2 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments
The above command returns all PrincipalAssignments in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg".
Example 2: Get a specific PrincipalAssignment in a kusto database by name
Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1
Name Type
---- ----
testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments
The above command returns a PrincipalAssignment named "kustoprincipal1" in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg".
Parameters
-DatabaseName
The name of the database in the Kusto pool.
Type: | String |
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 |
-PrincipalAssignmentName
The name of the Kusto principalAssignment.
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
Azure PowerShell