Azure Native
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:
- Big
Data stringPool Name Big Data pool name
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace
- Big
Data stringPool Name Big Data pool name
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace
- big
Data StringPool Name Big Data pool name
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace
- big
Data stringPool Name Big Data pool name
- resource
Group stringName The name of the resource group. The name is case insensitive.
- workspace
Name string The name of the workspace
- big_
data_ strpool_ name Big Data pool name
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- workspace_
name str The name of the workspace
- big
Data StringPool Name Big Data pool name
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name 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}
- Last
Succeeded stringTimestamp 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"
- Auto
Pause Pulumi.Azure Native. Synapse. Outputs. Auto Pause Properties Response Auto-pausing properties
- Auto
Scale Pulumi.Azure Native. Synapse. Outputs. Auto Scale Properties Response Auto-scaling properties
- Cache
Size int The cache size
- Creation
Date string The time when the Big Data pool was created.
- Custom
Libraries List<Pulumi.Azure Native. Synapse. Outputs. Library Info Response> List of custom libraries/packages associated with the spark pool.
- Default
Spark stringLog Folder The default folder where Spark logs will be written.
- Dynamic
Executor Pulumi.Allocation Azure Native. Synapse. Outputs. Dynamic Executor Allocation Response Dynamic Executor Allocation
- Is
Compute boolIsolation Enabled Whether compute isolation is required or not.
- Library
Requirements Pulumi.Azure Native. Synapse. Outputs. Library Requirements Response Library version requirements
- Node
Count int The number of nodes in the Big Data pool.
- Node
Size string The level of compute power that each node in the Big Data pool has.
- Node
Size stringFamily The kind of nodes that the Big Data pool provides.
- Provisioning
State string The state of the Big Data pool.
- Session
Level boolPackages Enabled Whether session level packages enabled.
- Spark
Config Pulumi.Properties Azure Native. Synapse. Outputs. Library Requirements Response Spark configuration file to specify additional properties
- Spark
Events stringFolder The Spark events folder
- Spark
Version string The Apache Spark version.
- Dictionary<string, string>
Resource tags.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Last
Succeeded stringTimestamp 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"
- Auto
Pause AutoPause Properties Response Auto-pausing properties
- Auto
Scale AutoScale Properties Response Auto-scaling properties
- Cache
Size int The cache size
- Creation
Date string The time when the Big Data pool was created.
- Custom
Libraries []LibraryInfo Response List of custom libraries/packages associated with the spark pool.
- Default
Spark stringLog Folder The default folder where Spark logs will be written.
- Dynamic
Executor DynamicAllocation Executor Allocation Response Dynamic Executor Allocation
- Is
Compute boolIsolation Enabled Whether compute isolation is required or not.
- Library
Requirements LibraryRequirements Response Library version requirements
- Node
Count int The number of nodes in the Big Data pool.
- Node
Size string The level of compute power that each node in the Big Data pool has.
- Node
Size stringFamily The kind of nodes that the Big Data pool provides.
- Provisioning
State string The state of the Big Data pool.
- Session
Level boolPackages Enabled Whether session level packages enabled.
- Spark
Config LibraryProperties Requirements Response Spark configuration file to specify additional properties
- Spark
Events stringFolder The Spark events folder
- Spark
Version string The Apache Spark version.
- map[string]string
Resource tags.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Succeeded StringTimestamp 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"
- auto
Pause AutoPause Properties Response Auto-pausing properties
- auto
Scale AutoScale Properties Response Auto-scaling properties
- cache
Size Integer The cache size
- creation
Date String The time when the Big Data pool was created.
- custom
Libraries List<LibraryInfo Response> List of custom libraries/packages associated with the spark pool.
- default
Spark StringLog Folder The default folder where Spark logs will be written.
- dynamic
Executor DynamicAllocation Executor Allocation Response Dynamic Executor Allocation
- is
Compute BooleanIsolation Enabled Whether compute isolation is required or not.
- library
Requirements LibraryRequirements Response Library version requirements
- node
Count Integer The number of nodes in the Big Data pool.
- node
Size String The level of compute power that each node in the Big Data pool has.
- node
Size StringFamily The kind of nodes that the Big Data pool provides.
- provisioning
State String The state of the Big Data pool.
- session
Level BooleanPackages Enabled Whether session level packages enabled.
- spark
Config LibraryProperties Requirements Response Spark configuration file to specify additional properties
- spark
Events StringFolder The Spark events folder
- spark
Version String The Apache Spark version.
- Map<String,String>
Resource tags.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Succeeded stringTimestamp 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"
- auto
Pause AutoPause Properties Response Auto-pausing properties
- auto
Scale AutoScale Properties Response Auto-scaling properties
- cache
Size number The cache size
- creation
Date string The time when the Big Data pool was created.
- custom
Libraries LibraryInfo Response[] List of custom libraries/packages associated with the spark pool.
- default
Spark stringLog Folder The default folder where Spark logs will be written.
- dynamic
Executor DynamicAllocation Executor Allocation Response Dynamic Executor Allocation
- is
Compute booleanIsolation Enabled Whether compute isolation is required or not.
- library
Requirements LibraryRequirements Response Library version requirements
- node
Count number The number of nodes in the Big Data pool.
- node
Size string The level of compute power that each node in the Big Data pool has.
- node
Size stringFamily The kind of nodes that the Big Data pool provides.
- provisioning
State string The state of the Big Data pool.
- session
Level booleanPackages Enabled Whether session level packages enabled.
- spark
Config LibraryProperties Requirements Response Spark configuration file to specify additional properties
- spark
Events stringFolder The Spark events folder
- spark
Version string The Apache Spark version.
- {[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_ strtimestamp 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 AutoPause Properties Response Auto-pausing properties
- auto_
scale AutoScale Properties Response Auto-scaling properties
- cache_
size int The cache size
- creation_
date str The time when the Big Data pool was created.
- custom_
libraries Sequence[LibraryInfo Response] List of custom libraries/packages associated with the spark pool.
- default_
spark_ strlog_ folder The default folder where Spark logs will be written.
- dynamic_
executor_ Dynamicallocation Executor Allocation Response Dynamic Executor Allocation
- is_
compute_ boolisolation_ enabled Whether compute isolation is required or not.
- library_
requirements LibraryRequirements Response 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_ strfamily The kind of nodes that the Big Data pool provides.
- provisioning_
state str The state of the Big Data pool.
- session_
level_ boolpackages_ enabled Whether session level packages enabled.
- spark_
config_ Libraryproperties Requirements Response Spark configuration file to specify additional properties
- spark_
events_ strfolder The Spark events folder
- spark_
version str The Apache Spark version.
- Mapping[str, str]
Resource tags.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Succeeded StringTimestamp 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"
- auto
Pause Property Map Auto-pausing properties
- auto
Scale Property Map Auto-scaling properties
- cache
Size Number The cache size
- creation
Date String The time when the Big Data pool was created.
- custom
Libraries List<Property Map> List of custom libraries/packages associated with the spark pool.
- default
Spark StringLog Folder The default folder where Spark logs will be written.
- dynamic
Executor Property MapAllocation Dynamic Executor Allocation
- is
Compute BooleanIsolation Enabled Whether compute isolation is required or not.
- library
Requirements Property Map Library version requirements
- node
Count Number The number of nodes in the Big Data pool.
- node
Size String The level of compute power that each node in the Big Data pool has.
- node
Size StringFamily The kind of nodes that the Big Data pool provides.
- provisioning
State String The state of the Big Data pool.
- session
Level BooleanPackages Enabled Whether session level packages enabled.
- spark
Config Property MapProperties Spark configuration file to specify additional properties
- spark
Events StringFolder The Spark events folder
- spark
Version String The Apache Spark version.
- Map<String>
Resource tags.
Supporting Types
AutoPausePropertiesResponse
- Delay
In intMinutes 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.
- Delay
In intMinutes 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.
- delay
In IntegerMinutes 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 numberMinutes 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_ intminutes 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.
- delay
In NumberMinutes 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.
- Max
Node intCount The maximum number of nodes the Big Data pool can support.
- Min
Node intCount 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 intCount The maximum number of nodes the Big Data pool can support.
- Min
Node intCount The minimum number of nodes the Big Data pool can support.
- enabled Boolean
Whether automatic scaling is enabled for the Big Data pool.
- max
Node IntegerCount The maximum number of nodes the Big Data pool can support.
- min
Node IntegerCount The minimum number of nodes the Big Data pool can support.
- enabled boolean
Whether automatic scaling is enabled for the Big Data pool.
- max
Node numberCount The maximum number of nodes the Big Data pool can support.
- min
Node numberCount 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_ intcount The maximum number of nodes the Big Data pool can support.
- min_
node_ intcount The minimum number of nodes the Big Data pool can support.
- enabled Boolean
Whether automatic scaling is enabled for the Big Data pool.
- max
Node NumberCount The maximum number of nodes the Big Data pool can support.
- min
Node NumberCount 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
- Creator
Id string Creator Id of the library/package.
- Provisioning
Status string Provisioning status of the library/package.
- Uploaded
Timestamp string The last update time of the library.
- Container
Name 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 string Creator Id of the library/package.
- Provisioning
Status string Provisioning status of the library/package.
- Uploaded
Timestamp string The last update time of the library.
- Container
Name 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 String Creator Id of the library/package.
- provisioning
Status String Provisioning status of the library/package.
- uploaded
Timestamp String The last update time of the library.
- container
Name 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 string Creator Id of the library/package.
- provisioning
Status string Provisioning status of the library/package.
- uploaded
Timestamp string The last update time of the library.
- container
Name 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.
- creator
Id String Creator Id of the library/package.
- provisioning
Status String Provisioning status of the library/package.
- uploaded
Timestamp String The last update time of the library.
- container
Name 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
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0