Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getBigDataPool
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getBigDataPool

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Big Data pool.

Uses Azure REST API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-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 getBigDataPool

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 getBigDataPool(args: GetBigDataPoolArgs, opts?: InvokeOptions): Promise<GetBigDataPoolResult>
function getBigDataPoolOutput(args: GetBigDataPoolOutputArgs, opts?: InvokeOptions): Output<GetBigDataPoolResult>
Copy
def get_big_data_pool(big_data_pool_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBigDataPoolResult
def get_big_data_pool_output(big_data_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[GetBigDataPoolResult]
Copy
func LookupBigDataPool(ctx *Context, args *LookupBigDataPoolArgs, opts ...InvokeOption) (*LookupBigDataPoolResult, error)
func LookupBigDataPoolOutput(ctx *Context, args *LookupBigDataPoolOutputArgs, opts ...InvokeOption) LookupBigDataPoolResultOutput
Copy

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

public static class GetBigDataPool 
{
    public static Task<GetBigDataPoolResult> InvokeAsync(GetBigDataPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetBigDataPoolResult> Invoke(GetBigDataPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBigDataPoolResult> getBigDataPool(GetBigDataPoolArgs args, InvokeOptions options)
public static Output<GetBigDataPoolResult> getBigDataPool(GetBigDataPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getBigDataPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BigDataPoolName
This property is required.
Changes to this property will trigger replacement.
string
Big Data pool name
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.
BigDataPoolName
This property is required.
Changes to this property will trigger replacement.
string
Big Data pool name
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.
bigDataPoolName
This property is required.
Changes to this property will trigger replacement.
String
Big Data pool name
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.
bigDataPoolName
This property is required.
Changes to this property will trigger replacement.
string
Big Data pool name
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.
big_data_pool_name
This property is required.
Changes to this property will trigger replacement.
str
Big Data pool name
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.
bigDataPoolName
This property is required.
Changes to this property will trigger replacement.
String
Big Data pool name
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.

getBigDataPool Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreationDate string
The time when the Big Data pool was created.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastSucceededTimestamp string
The time when the Big Data pool was updated successfully.
Location string
The geo-location where the resource lives
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AutoPause Pulumi.AzureNative.Synapse.Outputs.AutoPausePropertiesResponse
Auto-pausing properties
AutoScale Pulumi.AzureNative.Synapse.Outputs.AutoScalePropertiesResponse
Auto-scaling properties
CacheSize int
The cache size
CustomLibraries List<Pulumi.AzureNative.Synapse.Outputs.LibraryInfoResponse>
List of custom libraries/packages associated with the spark pool.
DefaultSparkLogFolder string
The default folder where Spark logs will be written.
DynamicExecutorAllocation Pulumi.AzureNative.Synapse.Outputs.DynamicExecutorAllocationResponse
Dynamic Executor Allocation
IsAutotuneEnabled bool
Whether autotune is required or not.
IsComputeIsolationEnabled bool
Whether compute isolation is required or not.
LibraryRequirements Pulumi.AzureNative.Synapse.Outputs.LibraryRequirementsResponse
Library version requirements
NodeCount int
The number of nodes in the Big Data pool.
NodeSize string
The level of compute power that each node in the Big Data pool has.
NodeSizeFamily string
The kind of nodes that the Big Data pool provides.
ProvisioningState string
The state of the Big Data pool.
SessionLevelPackagesEnabled bool
Whether session level packages enabled.
SparkConfigProperties Pulumi.AzureNative.Synapse.Outputs.SparkConfigPropertiesResponse
Spark configuration file to specify additional properties
SparkEventsFolder string
The Spark events folder
SparkVersion string
The Apache Spark version.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
CreationDate string
The time when the Big Data pool was created.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastSucceededTimestamp string
The time when the Big Data pool was updated successfully.
Location string
The geo-location where the resource lives
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AutoPause AutoPausePropertiesResponse
Auto-pausing properties
AutoScale AutoScalePropertiesResponse
Auto-scaling properties
CacheSize int
The cache size
CustomLibraries []LibraryInfoResponse
List of custom libraries/packages associated with the spark pool.
DefaultSparkLogFolder string
The default folder where Spark logs will be written.
DynamicExecutorAllocation DynamicExecutorAllocationResponse
Dynamic Executor Allocation
IsAutotuneEnabled bool
Whether autotune is required or not.
IsComputeIsolationEnabled bool
Whether compute isolation is required or not.
LibraryRequirements LibraryRequirementsResponse
Library version requirements
NodeCount int
The number of nodes in the Big Data pool.
NodeSize string
The level of compute power that each node in the Big Data pool has.
NodeSizeFamily string
The kind of nodes that the Big Data pool provides.
ProvisioningState string
The state of the Big Data pool.
SessionLevelPackagesEnabled bool
Whether session level packages enabled.
SparkConfigProperties SparkConfigPropertiesResponse
Spark configuration file to specify additional properties
SparkEventsFolder string
The Spark events folder
SparkVersion string
The Apache Spark version.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationDate String
The time when the Big Data pool was created.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastSucceededTimestamp String
The time when the Big Data pool was updated successfully.
location String
The geo-location where the resource lives
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
autoPause AutoPausePropertiesResponse
Auto-pausing properties
autoScale AutoScalePropertiesResponse
Auto-scaling properties
cacheSize Integer
The cache size
customLibraries List<LibraryInfoResponse>
List of custom libraries/packages associated with the spark pool.
defaultSparkLogFolder String
The default folder where Spark logs will be written.
dynamicExecutorAllocation DynamicExecutorAllocationResponse
Dynamic Executor Allocation
isAutotuneEnabled Boolean
Whether autotune is required or not.
isComputeIsolationEnabled Boolean
Whether compute isolation is required or not.
libraryRequirements LibraryRequirementsResponse
Library version requirements
nodeCount Integer
The number of nodes in the Big Data pool.
nodeSize String
The level of compute power that each node in the Big Data pool has.
nodeSizeFamily String
The kind of nodes that the Big Data pool provides.
provisioningState String
The state of the Big Data pool.
sessionLevelPackagesEnabled Boolean
Whether session level packages enabled.
sparkConfigProperties SparkConfigPropertiesResponse
Spark configuration file to specify additional properties
sparkEventsFolder String
The Spark events folder
sparkVersion String
The Apache Spark version.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
creationDate string
The time when the Big Data pool was created.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastSucceededTimestamp string
The time when the Big Data pool was updated successfully.
location string
The geo-location where the resource lives
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
autoPause AutoPausePropertiesResponse
Auto-pausing properties
autoScale AutoScalePropertiesResponse
Auto-scaling properties
cacheSize number
The cache size
customLibraries LibraryInfoResponse[]
List of custom libraries/packages associated with the spark pool.
defaultSparkLogFolder string
The default folder where Spark logs will be written.
dynamicExecutorAllocation DynamicExecutorAllocationResponse
Dynamic Executor Allocation
isAutotuneEnabled boolean
Whether autotune is required or not.
isComputeIsolationEnabled boolean
Whether compute isolation is required or not.
libraryRequirements LibraryRequirementsResponse
Library version requirements
nodeCount number
The number of nodes in the Big Data pool.
nodeSize string
The level of compute power that each node in the Big Data pool has.
nodeSizeFamily string
The kind of nodes that the Big Data pool provides.
provisioningState string
The state of the Big Data pool.
sessionLevelPackagesEnabled boolean
Whether session level packages enabled.
sparkConfigProperties SparkConfigPropertiesResponse
Spark configuration file to specify additional properties
sparkEventsFolder string
The Spark events folder
sparkVersion string
The Apache Spark version.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
creation_date str
The time when the Big Data pool was created.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_succeeded_timestamp str
The time when the Big Data pool was updated successfully.
location str
The geo-location where the resource lives
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
auto_pause AutoPausePropertiesResponse
Auto-pausing properties
auto_scale AutoScalePropertiesResponse
Auto-scaling properties
cache_size int
The cache size
custom_libraries Sequence[LibraryInfoResponse]
List of custom libraries/packages associated with the spark pool.
default_spark_log_folder str
The default folder where Spark logs will be written.
dynamic_executor_allocation DynamicExecutorAllocationResponse
Dynamic Executor Allocation
is_autotune_enabled bool
Whether autotune is required or not.
is_compute_isolation_enabled bool
Whether compute isolation is required or not.
library_requirements LibraryRequirementsResponse
Library version requirements
node_count int
The number of nodes in the Big Data pool.
node_size str
The level of compute power that each node in the Big Data pool has.
node_size_family str
The kind of nodes that the Big Data pool provides.
provisioning_state str
The state of the Big Data pool.
session_level_packages_enabled bool
Whether session level packages enabled.
spark_config_properties SparkConfigPropertiesResponse
Spark configuration file to specify additional properties
spark_events_folder str
The Spark events folder
spark_version str
The Apache Spark version.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationDate String
The time when the Big Data pool was created.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastSucceededTimestamp String
The time when the Big Data pool was updated successfully.
location String
The geo-location where the resource lives
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
autoPause Property Map
Auto-pausing properties
autoScale Property Map
Auto-scaling properties
cacheSize Number
The cache size
customLibraries List<Property Map>
List of custom libraries/packages associated with the spark pool.
defaultSparkLogFolder String
The default folder where Spark logs will be written.
dynamicExecutorAllocation Property Map
Dynamic Executor Allocation
isAutotuneEnabled Boolean
Whether autotune is required or not.
isComputeIsolationEnabled Boolean
Whether compute isolation is required or not.
libraryRequirements Property Map
Library version requirements
nodeCount Number
The number of nodes in the Big Data pool.
nodeSize String
The level of compute power that each node in the Big Data pool has.
nodeSizeFamily String
The kind of nodes that the Big Data pool provides.
provisioningState String
The state of the Big Data pool.
sessionLevelPackagesEnabled Boolean
Whether session level packages enabled.
sparkConfigProperties Property Map
Spark configuration file to specify additional properties
sparkEventsFolder String
The Spark events folder
sparkVersion String
The Apache Spark version.
tags Map<String>
Resource tags.

Supporting Types

AutoPausePropertiesResponse

DelayInMinutes int
Number of minutes of idle time before the Big Data pool is automatically paused.
Enabled bool
Whether auto-pausing is enabled for the Big Data pool.
DelayInMinutes int
Number of minutes of idle time before the Big Data pool is automatically paused.
Enabled bool
Whether auto-pausing is enabled for the Big Data pool.
delayInMinutes Integer
Number of minutes of idle time before the Big Data pool is automatically paused.
enabled Boolean
Whether auto-pausing is enabled for the Big Data pool.
delayInMinutes number
Number of minutes of idle time before the Big Data pool is automatically paused.
enabled boolean
Whether auto-pausing is enabled for the Big Data pool.
delay_in_minutes int
Number of minutes of idle time before the Big Data pool is automatically paused.
enabled bool
Whether auto-pausing is enabled for the Big Data pool.
delayInMinutes Number
Number of minutes of idle time before the Big Data pool is automatically paused.
enabled Boolean
Whether auto-pausing is enabled for the Big Data pool.

AutoScalePropertiesResponse

Enabled bool
Whether automatic scaling is enabled for the Big Data pool.
MaxNodeCount int
The maximum number of nodes the Big Data pool can support.
MinNodeCount int
The minimum number of nodes the Big Data pool can support.
Enabled bool
Whether automatic scaling is enabled for the Big Data pool.
MaxNodeCount int
The maximum number of nodes the Big Data pool can support.
MinNodeCount int
The minimum number of nodes the Big Data pool can support.
enabled Boolean
Whether automatic scaling is enabled for the Big Data pool.
maxNodeCount Integer
The maximum number of nodes the Big Data pool can support.
minNodeCount Integer
The minimum number of nodes the Big Data pool can support.
enabled boolean
Whether automatic scaling is enabled for the Big Data pool.
maxNodeCount number
The maximum number of nodes the Big Data pool can support.
minNodeCount number
The minimum number of nodes the Big Data pool can support.
enabled bool
Whether automatic scaling is enabled for the Big Data pool.
max_node_count int
The maximum number of nodes the Big Data pool can support.
min_node_count int
The minimum number of nodes the Big Data pool can support.
enabled Boolean
Whether automatic scaling is enabled for the Big Data pool.
maxNodeCount Number
The maximum number of nodes the Big Data pool can support.
minNodeCount Number
The minimum number of nodes the Big Data pool can support.

DynamicExecutorAllocationResponse

Enabled bool
Indicates whether Dynamic Executor Allocation is enabled or not.
MaxExecutors int
The maximum number of executors alloted
MinExecutors int
The minimum number of executors alloted
Enabled bool
Indicates whether Dynamic Executor Allocation is enabled or not.
MaxExecutors int
The maximum number of executors alloted
MinExecutors int
The minimum number of executors alloted
enabled Boolean
Indicates whether Dynamic Executor Allocation is enabled or not.
maxExecutors Integer
The maximum number of executors alloted
minExecutors Integer
The minimum number of executors alloted
enabled boolean
Indicates whether Dynamic Executor Allocation is enabled or not.
maxExecutors number
The maximum number of executors alloted
minExecutors number
The minimum number of executors alloted
enabled bool
Indicates whether Dynamic Executor Allocation is enabled or not.
max_executors int
The maximum number of executors alloted
min_executors int
The minimum number of executors alloted
enabled Boolean
Indicates whether Dynamic Executor Allocation is enabled or not.
maxExecutors Number
The maximum number of executors alloted
minExecutors Number
The minimum number of executors alloted

LibraryInfoResponse

CreatorId This property is required. string
Creator Id of the library/package.
ProvisioningStatus This property is required. string
Provisioning status of the library/package.
UploadedTimestamp This property is required. string
The last update time of the library.
ContainerName string
Storage blob container name.
Name string
Name of the library.
Path string
Storage blob path of library.
Type string
Type of the library.
CreatorId This property is required. string
Creator Id of the library/package.
ProvisioningStatus This property is required. string
Provisioning status of the library/package.
UploadedTimestamp This property is required. string
The last update time of the library.
ContainerName string
Storage blob container name.
Name string
Name of the library.
Path string
Storage blob path of library.
Type string
Type of the library.
creatorId This property is required. String
Creator Id of the library/package.
provisioningStatus This property is required. String
Provisioning status of the library/package.
uploadedTimestamp This property is required. String
The last update time of the library.
containerName String
Storage blob container name.
name String
Name of the library.
path String
Storage blob path of library.
type String
Type of the library.
creatorId This property is required. string
Creator Id of the library/package.
provisioningStatus This property is required. string
Provisioning status of the library/package.
uploadedTimestamp This property is required. string
The last update time of the library.
containerName string
Storage blob container name.
name string
Name of the library.
path string
Storage blob path of library.
type string
Type of the library.
creator_id This property is required. str
Creator Id of the library/package.
provisioning_status This property is required. str
Provisioning status of the library/package.
uploaded_timestamp This property is required. str
The last update time of the library.
container_name str
Storage blob container name.
name str
Name of the library.
path str
Storage blob path of library.
type str
Type of the library.
creatorId This property is required. String
Creator Id of the library/package.
provisioningStatus This property is required. String
Provisioning status of the library/package.
uploadedTimestamp This property is required. String
The last update time of the library.
containerName String
Storage blob container name.
name String
Name of the library.
path String
Storage blob path of library.
type String
Type of the library.

LibraryRequirementsResponse

Time This property is required. string
The last update time of the library requirements file.
Content string
The library requirements.
Filename string
The filename of the library requirements file.
Time This property is required. string
The last update time of the library requirements file.
Content string
The library requirements.
Filename string
The filename of the library requirements file.
time This property is required. String
The last update time of the library requirements file.
content String
The library requirements.
filename String
The filename of the library requirements file.
time This property is required. string
The last update time of the library requirements file.
content string
The library requirements.
filename string
The filename of the library requirements file.
time This property is required. str
The last update time of the library requirements file.
content str
The library requirements.
filename str
The filename of the library requirements file.
time This property is required. String
The last update time of the library requirements file.
content String
The library requirements.
filename String
The filename of the library requirements file.

SparkConfigPropertiesResponse

Time This property is required. string
The last update time of the spark config properties file.
ConfigurationType string
The type of the spark config properties file.
Content string
The spark config properties.
Filename string
The filename of the spark config properties file.
Time This property is required. string
The last update time of the spark config properties file.
ConfigurationType string
The type of the spark config properties file.
Content string
The spark config properties.
Filename string
The filename of the spark config properties file.
time This property is required. String
The last update time of the spark config properties file.
configurationType String
The type of the spark config properties file.
content String
The spark config properties.
filename String
The filename of the spark config properties file.
time This property is required. string
The last update time of the spark config properties file.
configurationType string
The type of the spark config properties file.
content string
The spark config properties.
filename string
The filename of the spark config properties file.
time This property is required. str
The last update time of the spark config properties file.
configuration_type str
The type of the spark config properties file.
content str
The spark config properties.
filename str
The filename of the spark config properties file.
time This property is required. String
The last update time of the spark config properties file.
configurationType String
The type of the spark config properties file.
content String
The spark config properties.
filename String
The filename of the spark config properties file.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native