Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

getBigDataPool

A Big Data pool API Version: 2021-03-01.

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>

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]

func LookupBigDataPool(ctx *Context, args *LookupBigDataPoolArgs, opts ...InvokeOption) (*LookupBigDataPoolResult, error)
func LookupBigDataPoolOutput(ctx *Context, args *LookupBigDataPoolOutputArgs, opts ...InvokeOption) LookupBigDataPoolResultOutput

> 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)
}

public static CompletableFuture<GetBigDataPoolResult> getBigDataPool(GetBigDataPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:synapse:getBigDataPool
  arguments:
    # arguments dictionary

The following arguments are supported:

BigDataPoolName string: Big Data pool name
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: The name of the workspace

BigDataPoolName string: Big Data pool name
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: The name of the workspace

bigDataPoolName String: Big Data pool name
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: The name of the workspace

bigDataPoolName string: Big Data pool name
resourceGroupName string: The name of the resource group. The name is case insensitive.
workspaceName string: The name of the workspace

big_data_pool_name str: Big Data pool name
resource_group_name str: The name of the resource group. The name is case insensitive.
workspace_name str: The name of the workspace

bigDataPoolName String: Big Data pool name
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: The name of the workspace

getBigDataPool Result

The following output properties are available:

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
CreationDate string: The time when the Big Data pool was created.
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
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.LibraryRequirementsResponse: 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.

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
CreationDate string: The time when the Big Data pool was created.
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
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 LibraryRequirementsResponse: 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.

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
creationDate String: The time when the Big Data pool was created.
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
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 LibraryRequirementsResponse: 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.

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
creationDate string: The time when the Big Data pool was created.
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
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 LibraryRequirementsResponse: 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.

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
creation_date str: The time when the Big Data pool was created.
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_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 LibraryRequirementsResponse: 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.

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
creationDate String: The time when the Big Data pool was created.
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
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.

Enabled bool: Indicates whether Dynamic Executor Allocation is enabled or not.

enabled Boolean: Indicates whether Dynamic Executor Allocation is enabled or not.

enabled boolean: Indicates whether Dynamic Executor Allocation is enabled or not.

enabled bool: Indicates whether Dynamic Executor Allocation is enabled or not.

enabled Boolean: Indicates whether Dynamic Executor Allocation is enabled or not.

LibraryInfoResponse

CreatorId string: Creator Id of the library/package.
ProvisioningStatus string: Provisioning status of the library/package.
UploadedTimestamp 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 string: Creator Id of the library/package.
ProvisioningStatus string: Provisioning status of the library/package.
UploadedTimestamp 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 String: Creator Id of the library/package.
provisioningStatus String: Provisioning status of the library/package.
uploadedTimestamp 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 string: Creator Id of the library/package.
provisioningStatus string: Provisioning status of the library/package.
uploadedTimestamp 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 str: Creator Id of the library/package.
provisioning_status str: Provisioning status of the library/package.
uploaded_timestamp 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 String: Creator Id of the library/package.
provisioningStatus String: Provisioning status of the library/package.
uploadedTimestamp 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 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 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 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 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 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 String: The last update time of the library requirements file.
content String: The library requirements.
filename String: The filename of the library requirements file.

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0