Set-XdrAzureDataExplorerConnection
SYNOPSIS
Configures Azure Data Explorer connection settings for export cmdlets.
SYNTAX
Discover (Default)
Set-XdrAzureDataExplorerConnection [-SubscriptionId <String[]>] [-ClusterName <String>]
[-DatabaseName <String>] [-TenantId <String>] [-ManagedIdentityClientId <String>] [-RequestTimeout <Int32>]
[-NonInteractive] [-AllowPartialDiscovery] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Explicit
Set-XdrAzureDataExplorerConnection -ClusterUri <Uri> -Database <String> [-IngestionUri <Uri>]
[-TenantId <String>] [-ManagedIdentityClientId <String>] [-AccessToken <String>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Stores the Azure Data Explorer cluster, ingestion endpoint, database, and auth settings used by Export-XdrAzureDataExplorer and Get-XdrAzureDataExplorerIngestionStatus.
When ClusterUri and Database are omitted, the cmdlet auto-discovers accessible clusters, prompts you to choose a cluster when multiple matches exist, and then prompts you to choose a database when the selected cluster has more than one available database.
If IngestionUri is omitted, the cmdlet derives it from the cluster URI by using the standard `ingest-<cluster>` hostname convention.
EXAMPLES
EXAMPLE 1
Set-XdrAzureDataExplorerConnection -ClusterUri "https://mycluster.westeurope.kusto.windows.net" -Database "Investigations"
Configures the connection and derives the ingestion endpoint automatically.
EXAMPLE 2
Set-XdrAzureDataExplorerConnection
Discovers accessible clusters, prompts for a cluster if more than one is available, and prompts for a database if the chosen cluster has more than one database.
EXAMPLE 3
Set-XdrAzureDataExplorerConnection -ClusterName 'nm-test-cluster' -DatabaseName 'Investigations' -NonInteractive
Discovers a single matching cluster and database without prompting. If multiple matches remain, the cmdlet throws instead of waiting for user input.
EXAMPLE 4
$token = az account get-access-token --resource https://api.kusto.windows.net --query accessToken -o tsv
Set-XdrAzureDataExplorerConnection -ClusterUri "https://mycluster.westeurope.kusto.windows.net" -Database "Investigations" -AccessToken $token
Configures the connection with an explicit bearer token.
PARAMETERS
-ClusterUri
The Azure Data Explorer cluster URI. You can supply either the engine endpoint or the ingestion endpoint. If omitted, the cmdlet discovers accessible clusters and prompts for a selection when needed.
Type: Uri
Parameter Sets: Explicit
Aliases: Cluster
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Database
The database name to target for table bootstrap and queued ingestion.
Type: String
Parameter Sets: Explicit
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SubscriptionId
Optional subscription IDs used to narrow cluster discovery when ClusterUri is omitted.
Type: String[]
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClusterName
Optional cluster name filter used during discovery when ClusterUri is omitted. Wildcards are supported.
Type: String
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-DatabaseName
Optional database name filter used during discovery when ClusterUri is omitted. Wildcards are supported.
Type: String
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-IngestionUri
Optional explicit data ingestion URI. If omitted, it is derived from ClusterUri.
Type: Uri
Parameter Sets: Explicit
Aliases: DataIngestionUri
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
Optional tenant ID used when obtaining a token through Az.Accounts or Azure CLI.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ManagedIdentityClientId
Optional user-assigned managed identity client ID for IMDS token acquisition.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccessToken
Optional Azure Data Explorer access token to use directly instead of acquiring a token dynamically. This applies only when ClusterUri and Database are supplied explicitly.
Type: String
Parameter Sets: Explicit
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestTimeout
Optional HTTP timeout for discovery requests when ClusterUri is omitted. Default is 60 seconds.
Type: Int32
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
-NonInteractive
Prevents interactive cluster or database prompts during discovery. If discovery is ambiguous, the cmdlet throws and asks you to narrow the match or specify the connection explicitly.
Type: SwitchParameter
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AllowPartialDiscovery
Allows automatic connection selection when one or more discovery providers or database enumeration requests failed. By default, discovery fails closed rather than selecting from an incomplete result set.
Type: SwitchParameter
Parameter Sets: Discover
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs without updating the module's Azure Data Explorer connection settings.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts for confirmation before updating the module's Azure Data Explorer connection settings.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.