Get-XdrAzureDataExplorerCluster
SYNOPSIS
Discovers accessible Azure Data Explorer clusters and databases.
SYNTAX
Get-XdrAzureDataExplorerCluster [[-SubscriptionId] <String[]>] [[-ClusterName] <String>]
[[-DatabaseName] <String>] [-IncludeDatabases] [[-TenantId] <String>] [[-ManagedIdentityClientId] <String>]
[[-AccessToken] <String>] [[-RequestTimeout] <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Enumerates Azure Data Explorer (Microsoft.Kusto) clusters visible to the current Azure auth context through Azure Resource Manager, and also includes Azure Data Explorer free clusters exposed through the web control plane. When requested, it also lists databases for each cluster so you can quickly bootstrap Set-XdrAzureDataExplorerConnection without hunting for portal details manually.
Authentication uses the module's standard Azure token flow: explicit token, Az.Accounts, Azure CLI, browser-derived ESTS bridge, or managed identity.
Each returned cluster includes DiscoveryStatus metadata. IsComplete is false when a provider or requested database enumeration failed, and Failures identifies the provider, scope, and error. Partial results are returned with a warning. Supplying -SubscriptionId intentionally scopes discovery to Azure Resource Manager and does not count skipped free-cluster discovery as a failure.
EXAMPLES
EXAMPLE 1
Get-XdrAzureDataExplorerCluster
Lists Azure Data Explorer clusters visible to the current Azure auth context, including accessible free clusters.
EXAMPLE 2
Get-XdrAzureDataExplorerCluster -IncludeDatabases
Lists clusters together with their databases.
EXAMPLE 3
Get-XdrAzureDataExplorerCluster -ClusterName 'my*' -DatabaseName 'Investigations'
Finds clusters whose names match "my*" and includes only databases matching "Investigations".
PARAMETERS
-SubscriptionId
Optional subscription IDs to query. When omitted, all accessible subscriptions are enumerated.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClusterName
Optional cluster name filter. Wildcards are supported.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-DatabaseName
Optional database name filter. Wildcards are supported and imply -IncludeDatabases.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-IncludeDatabases
Includes Azure Data Explorer databases for each returned cluster.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
Optional tenant ID used during Azure token acquisition.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ManagedIdentityClientId
Optional user-assigned managed identity client ID for token acquisition via IMDS.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccessToken
Optional explicit Azure Resource Manager bearer token.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestTimeout
Optional HTTP timeout for discovery requests. Default is 60 seconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
The ProgressAction parameter is a common parameter, not a cmdlet parameter. For more information, see about_CommonParameters.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.