Share via


Microsoft.Synapse workspaces/bigDataPools 2021-03-01

Bicep resource definition

The workspaces/bigDataPools resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/bigDataPools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/bigDataPools@2021-03-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    autoPause: {
      delayInMinutes: int
      enabled: bool
    }
    autoScale: {
      enabled: bool
      maxNodeCount: int
      minNodeCount: int
    }
    cacheSize: int
    creationDate: 'string'
    customLibraries: [
      {
        containerName: 'string'
        name: 'string'
        path: 'string'
        type: 'string'
      }
    ]
    defaultSparkLogFolder: 'string'
    dynamicExecutorAllocation: {
      enabled: bool
    }
    isComputeIsolationEnabled: bool
    libraryRequirements: {
      content: 'string'
      filename: 'string'
    }
    nodeCount: int
    nodeSize: 'string'
    nodeSizeFamily: 'string'
    provisioningState: 'string'
    sessionLevelPackagesEnabled: bool
    sparkConfigProperties: {
      content: 'string'
      filename: 'string'
    }
    sparkEventsFolder: 'string'
    sparkVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Synapse/workspaces/bigDataPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: workspaces
properties Big Data pool properties BigDataPoolResourceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

AutoPauseProperties

Name Description Value
delayInMinutes Number of minutes of idle time before the Big Data pool is automatically paused. int
enabled Whether auto-pausing is enabled for the Big Data pool. bool

AutoScaleProperties

Name Description Value
enabled Whether automatic scaling is enabled for the Big Data pool. bool
maxNodeCount The maximum number of nodes the Big Data pool can support. int
minNodeCount The minimum number of nodes the Big Data pool can support. int

BigDataPoolResourceProperties

Name Description Value
autoPause Auto-pausing properties AutoPauseProperties
autoScale Auto-scaling properties AutoScaleProperties
cacheSize The cache size int
creationDate The time when the Big Data pool was created. string
customLibraries List of custom libraries/packages associated with the spark pool. LibraryInfo[]
defaultSparkLogFolder The default folder where Spark logs will be written. string
dynamicExecutorAllocation Dynamic Executor Allocation DynamicExecutorAllocation
isComputeIsolationEnabled Whether compute isolation is required or not. bool
libraryRequirements Library version requirements LibraryRequirements
nodeCount The number of nodes in the Big Data pool. int
nodeSize The level of compute power that each node in the Big Data pool has. 'Large'
'Medium'
'None'
'Small'
'XLarge'
'XXLarge'
'XXXLarge'
nodeSizeFamily The kind of nodes that the Big Data pool provides. 'HardwareAcceleratedFPGA'
'HardwareAcceleratedGPU'
'MemoryOptimized'
'None'
provisioningState The state of the Big Data pool. string
sessionLevelPackagesEnabled Whether session level packages enabled. bool
sparkConfigProperties Spark configuration file to specify additional properties LibraryRequirements
sparkEventsFolder The Spark events folder string
sparkVersion The Apache Spark version. string

DynamicExecutorAllocation

Name Description Value
enabled Indicates whether Dynamic Executor Allocation is enabled or not. bool

LibraryInfo

Name Description Value
containerName Storage blob container name. string
name Name of the library. string
path Storage blob path of library. string
type Type of the library. string

LibraryRequirements

Name Description Value
content The library requirements. string
filename The filename of the library requirements file. string

TrackedResourceTags

Name Description Value

ARM template resource definition

The workspaces/bigDataPools resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/bigDataPools resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/bigDataPools",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoPause": {
      "delayInMinutes": "int",
      "enabled": "bool"
    },
    "autoScale": {
      "enabled": "bool",
      "maxNodeCount": "int",
      "minNodeCount": "int"
    },
    "cacheSize": "int",
    "creationDate": "string",
    "customLibraries": [
      {
        "containerName": "string",
        "name": "string",
        "path": "string",
        "type": "string"
      }
    ],
    "defaultSparkLogFolder": "string",
    "dynamicExecutorAllocation": {
      "enabled": "bool"
    },
    "isComputeIsolationEnabled": "bool",
    "libraryRequirements": {
      "content": "string",
      "filename": "string"
    },
    "nodeCount": "int",
    "nodeSize": "string",
    "nodeSizeFamily": "string",
    "provisioningState": "string",
    "sessionLevelPackagesEnabled": "bool",
    "sparkConfigProperties": {
      "content": "string",
      "filename": "string"
    },
    "sparkEventsFolder": "string",
    "sparkVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Synapse/workspaces/bigDataPools

Name Description Value
apiVersion The api version '2021-03-01'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Big Data pool properties BigDataPoolResourceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Synapse/workspaces/bigDataPools'

AutoPauseProperties

Name Description Value
delayInMinutes Number of minutes of idle time before the Big Data pool is automatically paused. int
enabled Whether auto-pausing is enabled for the Big Data pool. bool

AutoScaleProperties

Name Description Value
enabled Whether automatic scaling is enabled for the Big Data pool. bool
maxNodeCount The maximum number of nodes the Big Data pool can support. int
minNodeCount The minimum number of nodes the Big Data pool can support. int

BigDataPoolResourceProperties

Name Description Value
autoPause Auto-pausing properties AutoPauseProperties
autoScale Auto-scaling properties AutoScaleProperties
cacheSize The cache size int
creationDate The time when the Big Data pool was created. string
customLibraries List of custom libraries/packages associated with the spark pool. LibraryInfo[]
defaultSparkLogFolder The default folder where Spark logs will be written. string
dynamicExecutorAllocation Dynamic Executor Allocation DynamicExecutorAllocation
isComputeIsolationEnabled Whether compute isolation is required or not. bool
libraryRequirements Library version requirements LibraryRequirements
nodeCount The number of nodes in the Big Data pool. int
nodeSize The level of compute power that each node in the Big Data pool has. 'Large'
'Medium'
'None'
'Small'
'XLarge'
'XXLarge'
'XXXLarge'
nodeSizeFamily The kind of nodes that the Big Data pool provides. 'HardwareAcceleratedFPGA'
'HardwareAcceleratedGPU'
'MemoryOptimized'
'None'
provisioningState The state of the Big Data pool. string
sessionLevelPackagesEnabled Whether session level packages enabled. bool
sparkConfigProperties Spark configuration file to specify additional properties LibraryRequirements
sparkEventsFolder The Spark events folder string
sparkVersion The Apache Spark version. string

DynamicExecutorAllocation

Name Description Value
enabled Indicates whether Dynamic Executor Allocation is enabled or not. bool

LibraryInfo

Name Description Value
containerName Storage blob container name. string
name Name of the library. string
path Storage blob path of library. string
type Type of the library. string

LibraryRequirements

Name Description Value
content The library requirements. string
filename The filename of the library requirements file. string

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Azure Synapse Proof-of-Concept

Deploy to Azure
This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools

Terraform (AzAPI provider) resource definition

The workspaces/bigDataPools resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/bigDataPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/bigDataPools@2021-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoPause = {
        delayInMinutes = int
        enabled = bool
      }
      autoScale = {
        enabled = bool
        maxNodeCount = int
        minNodeCount = int
      }
      cacheSize = int
      creationDate = "string"
      customLibraries = [
        {
          containerName = "string"
          name = "string"
          path = "string"
          type = "string"
        }
      ]
      defaultSparkLogFolder = "string"
      dynamicExecutorAllocation = {
        enabled = bool
      }
      isComputeIsolationEnabled = bool
      libraryRequirements = {
        content = "string"
        filename = "string"
      }
      nodeCount = int
      nodeSize = "string"
      nodeSizeFamily = "string"
      provisioningState = "string"
      sessionLevelPackagesEnabled = bool
      sparkConfigProperties = {
        content = "string"
        filename = "string"
      }
      sparkEventsFolder = "string"
      sparkVersion = "string"
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/bigDataPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Big Data pool properties BigDataPoolResourceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Synapse/workspaces/bigDataPools@2021-03-01"

AutoPauseProperties

Name Description Value
delayInMinutes Number of minutes of idle time before the Big Data pool is automatically paused. int
enabled Whether auto-pausing is enabled for the Big Data pool. bool

AutoScaleProperties

Name Description Value
enabled Whether automatic scaling is enabled for the Big Data pool. bool
maxNodeCount The maximum number of nodes the Big Data pool can support. int
minNodeCount The minimum number of nodes the Big Data pool can support. int

BigDataPoolResourceProperties

Name Description Value
autoPause Auto-pausing properties AutoPauseProperties
autoScale Auto-scaling properties AutoScaleProperties
cacheSize The cache size int
creationDate The time when the Big Data pool was created. string
customLibraries List of custom libraries/packages associated with the spark pool. LibraryInfo[]
defaultSparkLogFolder The default folder where Spark logs will be written. string
dynamicExecutorAllocation Dynamic Executor Allocation DynamicExecutorAllocation
isComputeIsolationEnabled Whether compute isolation is required or not. bool
libraryRequirements Library version requirements LibraryRequirements
nodeCount The number of nodes in the Big Data pool. int
nodeSize The level of compute power that each node in the Big Data pool has. 'Large'
'Medium'
'None'
'Small'
'XLarge'
'XXLarge'
'XXXLarge'
nodeSizeFamily The kind of nodes that the Big Data pool provides. 'HardwareAcceleratedFPGA'
'HardwareAcceleratedGPU'
'MemoryOptimized'
'None'
provisioningState The state of the Big Data pool. string
sessionLevelPackagesEnabled Whether session level packages enabled. bool
sparkConfigProperties Spark configuration file to specify additional properties LibraryRequirements
sparkEventsFolder The Spark events folder string
sparkVersion The Apache Spark version. string

DynamicExecutorAllocation

Name Description Value
enabled Indicates whether Dynamic Executor Allocation is enabled or not. bool

LibraryInfo

Name Description Value
containerName Storage blob container name. string
name Name of the library. string
path Storage blob path of library. string
type Type of the library. string

LibraryRequirements

Name Description Value
content The library requirements. string
filename The filename of the library requirements file. string

TrackedResourceTags

Name Description Value