Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getKustoPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getKustoPool

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a Kusto pool.

Uses Azure REST API version 2021-06-01-preview.

Other available API versions: 2021-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Using getKustoPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKustoPool(args: GetKustoPoolArgs, opts?: InvokeOptions): Promise<GetKustoPoolResult>
function getKustoPoolOutput(args: GetKustoPoolOutputArgs, opts?: InvokeOptions): Output<GetKustoPoolResult>
Copy
def get_kusto_pool(kusto_pool_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKustoPoolResult
def get_kusto_pool_output(kusto_pool_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   workspace_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKustoPoolResult]
Copy
func LookupKustoPool(ctx *Context, args *LookupKustoPoolArgs, opts ...InvokeOption) (*LookupKustoPoolResult, error)
func LookupKustoPoolOutput(ctx *Context, args *LookupKustoPoolOutputArgs, opts ...InvokeOption) LookupKustoPoolResultOutput
Copy

> Note: This function is named LookupKustoPool in the Go SDK.

public static class GetKustoPool 
{
    public static Task<GetKustoPoolResult> InvokeAsync(GetKustoPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetKustoPoolResult> Invoke(GetKustoPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKustoPoolResult> getKustoPool(GetKustoPoolArgs args, InvokeOptions options)
public static Output<GetKustoPoolResult> getKustoPool(GetKustoPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getKustoPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
kusto_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto pool.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getKustoPool Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DataIngestionUri string
The Kusto Pool data ingestion URI.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LanguageExtensions Pulumi.AzureNative.Synapse.Outputs.LanguageExtensionsListResponse
List of the Kusto Pool's language extensions.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
Sku Pulumi.AzureNative.Synapse.Outputs.AzureSkuResponse
The SKU of the kusto pool.
State string
The state of the resource.
StateReason string
The reason for the Kusto Pool's current state.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uri string
The Kusto Pool URI.
EnablePurge bool
A boolean value that indicates if the purge operations are enabled.
EnableStreamingIngest bool
A boolean value that indicates if the streaming ingest is enabled.
OptimizedAutoscale Pulumi.AzureNative.Synapse.Outputs.OptimizedAutoscaleResponse
Optimized auto scale definition.
Tags Dictionary<string, string>
Resource tags.
WorkspaceUID string
The workspace unique identifier.
AzureApiVersion string
The Azure API version of the resource.
DataIngestionUri string
The Kusto Pool data ingestion URI.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LanguageExtensions LanguageExtensionsListResponse
List of the Kusto Pool's language extensions.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
Sku AzureSkuResponse
The SKU of the kusto pool.
State string
The state of the resource.
StateReason string
The reason for the Kusto Pool's current state.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uri string
The Kusto Pool URI.
EnablePurge bool
A boolean value that indicates if the purge operations are enabled.
EnableStreamingIngest bool
A boolean value that indicates if the streaming ingest is enabled.
OptimizedAutoscale OptimizedAutoscaleResponse
Optimized auto scale definition.
Tags map[string]string
Resource tags.
WorkspaceUID string
The workspace unique identifier.
azureApiVersion String
The Azure API version of the resource.
dataIngestionUri String
The Kusto Pool data ingestion URI.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
languageExtensions LanguageExtensionsListResponse
List of the Kusto Pool's language extensions.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
sku AzureSkuResponse
The SKU of the kusto pool.
state String
The state of the resource.
stateReason String
The reason for the Kusto Pool's current state.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri String
The Kusto Pool URI.
enablePurge Boolean
A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest Boolean
A boolean value that indicates if the streaming ingest is enabled.
optimizedAutoscale OptimizedAutoscaleResponse
Optimized auto scale definition.
tags Map<String,String>
Resource tags.
workspaceUID String
The workspace unique identifier.
azureApiVersion string
The Azure API version of the resource.
dataIngestionUri string
The Kusto Pool data ingestion URI.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
languageExtensions LanguageExtensionsListResponse
List of the Kusto Pool's language extensions.
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The provisioned state of the resource.
sku AzureSkuResponse
The SKU of the kusto pool.
state string
The state of the resource.
stateReason string
The reason for the Kusto Pool's current state.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri string
The Kusto Pool URI.
enablePurge boolean
A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest boolean
A boolean value that indicates if the streaming ingest is enabled.
optimizedAutoscale OptimizedAutoscaleResponse
Optimized auto scale definition.
tags {[key: string]: string}
Resource tags.
workspaceUID string
The workspace unique identifier.
azure_api_version str
The Azure API version of the resource.
data_ingestion_uri str
The Kusto Pool data ingestion URI.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
language_extensions LanguageExtensionsListResponse
List of the Kusto Pool's language extensions.
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The provisioned state of the resource.
sku AzureSkuResponse
The SKU of the kusto pool.
state str
The state of the resource.
state_reason str
The reason for the Kusto Pool's current state.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri str
The Kusto Pool URI.
enable_purge bool
A boolean value that indicates if the purge operations are enabled.
enable_streaming_ingest bool
A boolean value that indicates if the streaming ingest is enabled.
optimized_autoscale OptimizedAutoscaleResponse
Optimized auto scale definition.
tags Mapping[str, str]
Resource tags.
workspace_uid str
The workspace unique identifier.
azureApiVersion String
The Azure API version of the resource.
dataIngestionUri String
The Kusto Pool data ingestion URI.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
languageExtensions Property Map
List of the Kusto Pool's language extensions.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
sku Property Map
The SKU of the kusto pool.
state String
The state of the resource.
stateReason String
The reason for the Kusto Pool's current state.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri String
The Kusto Pool URI.
enablePurge Boolean
A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest Boolean
A boolean value that indicates if the streaming ingest is enabled.
optimizedAutoscale Property Map
Optimized auto scale definition.
tags Map<String>
Resource tags.
workspaceUID String
The workspace unique identifier.

Supporting Types

AzureSkuResponse

Name This property is required. string
SKU name.
Size This property is required. string
SKU size.
Capacity int
The number of instances of the cluster.
Name This property is required. string
SKU name.
Size This property is required. string
SKU size.
Capacity int
The number of instances of the cluster.
name This property is required. String
SKU name.
size This property is required. String
SKU size.
capacity Integer
The number of instances of the cluster.
name This property is required. string
SKU name.
size This property is required. string
SKU size.
capacity number
The number of instances of the cluster.
name This property is required. str
SKU name.
size This property is required. str
SKU size.
capacity int
The number of instances of the cluster.
name This property is required. String
SKU name.
size This property is required. String
SKU size.
capacity Number
The number of instances of the cluster.

LanguageExtensionResponse

LanguageExtensionName string
The language extension name.
LanguageExtensionName string
The language extension name.
languageExtensionName String
The language extension name.
languageExtensionName string
The language extension name.
language_extension_name str
The language extension name.
languageExtensionName String
The language extension name.

LanguageExtensionsListResponse

Value []LanguageExtensionResponse
The list of language extensions.
value List<LanguageExtensionResponse>
The list of language extensions.
value LanguageExtensionResponse[]
The list of language extensions.
value Sequence[LanguageExtensionResponse]
The list of language extensions.
value List<Property Map>
The list of language extensions.

OptimizedAutoscaleResponse

IsEnabled This property is required. bool
A boolean value that indicate if the optimized autoscale feature is enabled or not.
Maximum This property is required. int
Maximum allowed instances count.
Minimum This property is required. int
Minimum allowed instances count.
Version This property is required. int
The version of the template defined, for instance 1.
IsEnabled This property is required. bool
A boolean value that indicate if the optimized autoscale feature is enabled or not.
Maximum This property is required. int
Maximum allowed instances count.
Minimum This property is required. int
Minimum allowed instances count.
Version This property is required. int
The version of the template defined, for instance 1.
isEnabled This property is required. Boolean
A boolean value that indicate if the optimized autoscale feature is enabled or not.
maximum This property is required. Integer
Maximum allowed instances count.
minimum This property is required. Integer
Minimum allowed instances count.
version This property is required. Integer
The version of the template defined, for instance 1.
isEnabled This property is required. boolean
A boolean value that indicate if the optimized autoscale feature is enabled or not.
maximum This property is required. number
Maximum allowed instances count.
minimum This property is required. number
Minimum allowed instances count.
version This property is required. number
The version of the template defined, for instance 1.
is_enabled This property is required. bool
A boolean value that indicate if the optimized autoscale feature is enabled or not.
maximum This property is required. int
Maximum allowed instances count.
minimum This property is required. int
Minimum allowed instances count.
version This property is required. int
The version of the template defined, for instance 1.
isEnabled This property is required. Boolean
A boolean value that indicate if the optimized autoscale feature is enabled or not.
maximum This property is required. Number
Maximum allowed instances count.
minimum This property is required. Number
Minimum allowed instances count.
version This property is required. Number
The version of the template defined, for instance 1.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native