Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. SqlPool
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.SqlPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi
pulumi/pulumi-azure-native

    A SQL Analytics pool Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2021-05-01, 2021-06-01-preview.

    Example Usage

    Create a SQL Analytics pool

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlPool = new AzureNative.Synapse.SqlPool("sqlPool", new()
    {
        Collation = "",
        CreateMode = "",
        Location = "Southeast Asia",
        MaxSizeBytes = 0,
        RecoverableDatabaseId = "",
        ResourceGroupName = "ExampleResourceGroup",
        Sku = new AzureNative.Synapse.Inputs.SkuArgs
        {
            Name = "",
            Tier = "",
        },
        SourceDatabaseId = "",
        SqlPoolName = "ExampleSqlPool",
        StorageAccountType = "LRS",
        Tags = null,
        WorkspaceName = "ExampleWorkspace",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewSqlPool(ctx, "sqlPool", &synapse.SqlPoolArgs{
			Collation:             pulumi.String(""),
			CreateMode:            pulumi.String(""),
			Location:              pulumi.String("Southeast Asia"),
			MaxSizeBytes:          pulumi.Float64(0),
			RecoverableDatabaseId: pulumi.String(""),
			ResourceGroupName:     pulumi.String("ExampleResourceGroup"),
			Sku: &synapse.SkuArgs{
				Name: pulumi.String(""),
				Tier: pulumi.String(""),
			},
			SourceDatabaseId:   pulumi.String(""),
			SqlPoolName:        pulumi.String("ExampleSqlPool"),
			StorageAccountType: pulumi.String("LRS"),
			Tags:               nil,
			WorkspaceName:      pulumi.String("ExampleWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.SqlPool;
import com.pulumi.azurenative.synapse.SqlPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sqlPool = new SqlPool("sqlPool", SqlPoolArgs.builder()        
            .collation("")
            .createMode("")
            .location("Southeast Asia")
            .maxSizeBytes(0)
            .recoverableDatabaseId("")
            .resourceGroupName("ExampleResourceGroup")
            .sku(Map.ofEntries(
                Map.entry("name", ""),
                Map.entry("tier", "")
            ))
            .sourceDatabaseId("")
            .sqlPoolName("ExampleSqlPool")
            .storageAccountType("LRS")
            .tags()
            .workspaceName("ExampleWorkspace")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

sql_pool = azure_native.synapse.SqlPool("sqlPool",
    collation="",
    create_mode="",
    location="Southeast Asia",
    max_size_bytes=0,
    recoverable_database_id="",
    resource_group_name="ExampleResourceGroup",
    sku=azure_native.synapse.SkuArgs(
        name="",
        tier="",
    ),
    source_database_id="",
    sql_pool_name="ExampleSqlPool",
    storage_account_type="LRS",
    tags={},
    workspace_name="ExampleWorkspace")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlPool = new azure_native.synapse.SqlPool("sqlPool", {
    collation: "",
    createMode: "",
    location: "Southeast Asia",
    maxSizeBytes: 0,
    recoverableDatabaseId: "",
    resourceGroupName: "ExampleResourceGroup",
    sku: {
        name: "",
        tier: "",
    },
    sourceDatabaseId: "",
    sqlPoolName: "ExampleSqlPool",
    storageAccountType: "LRS",
    tags: {},
    workspaceName: "ExampleWorkspace",
});

    resources:
  sqlPool:
    type: azure-native:synapse:SqlPool
    properties:
      collation:
      createMode:
      location: Southeast Asia
      maxSizeBytes: 0
      recoverableDatabaseId:
      resourceGroupName: ExampleResourceGroup
      sku:
        name:
        tier:
      sourceDatabaseId:
      sqlPoolName: ExampleSqlPool
      storageAccountType: LRS
      tags: {}
      workspaceName: ExampleWorkspace

    Create SqlPool Resource

    new SqlPool(name: string, args: SqlPoolArgs, opts?: CustomResourceOptions);
    @overload
def SqlPool(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            collation: Optional[str] = None,
            create_mode: Optional[Union[str, CreateMode]] = None,
            location: Optional[str] = None,
            max_size_bytes: Optional[float] = None,
            provisioning_state: Optional[str] = None,
            recoverable_database_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            restore_point_in_time: Optional[str] = None,
            sku: Optional[SkuArgs] = None,
            source_database_deletion_date: Optional[str] = None,
            source_database_id: Optional[str] = None,
            sql_pool_name: Optional[str] = None,
            storage_account_type: Optional[Union[str, StorageAccountType]] = None,
            tags: Optional[Mapping[str, str]] = None,
            workspace_name: Optional[str] = None)
@overload
def SqlPool(resource_name: str,
            args: SqlPoolArgs,
            opts: Optional[ResourceOptions] = None)
    func NewSqlPool(ctx *Context, name string, args SqlPoolArgs, opts ...ResourceOption) (*SqlPool, error)
    public SqlPool(string name, SqlPoolArgs args, CustomResourceOptions? opts = null)
    public SqlPool(String name, SqlPoolArgs args)
public SqlPool(String name, SqlPoolArgs args, CustomResourceOptions options)

    type: azure-native:synapse:SqlPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SqlPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SqlPool resource accepts the following input properties:

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WorkspaceName string

    The name of the workspace.

    Collation string

    Collation mode

    CreateMode string | Pulumi.AzureNative.Synapse.CreateMode

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    Location string

    The geo-location where the resource lives

    MaxSizeBytes double

    Maximum size in bytes

    ProvisioningState string

    Resource state

    RecoverableDatabaseId string

    Backup database to restore from

    RestorePointInTime string

    Snapshot time to restore

    Sku Pulumi.AzureNative.Synapse.Inputs.Sku

    SQL pool SKU

    SourceDatabaseDeletionDate string

    Specifies the time that the sql pool was deleted

    SourceDatabaseId string

    Source database to create from

    SqlPoolName string

    SQL pool name

    StorageAccountType string | Pulumi.AzureNative.Synapse.StorageAccountType

    The storage account type used to store backups for this sql pool.

    Tags Dictionary<string, string>

    Resource tags.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WorkspaceName string

    The name of the workspace.

    Collation string

    Collation mode

    CreateMode string | CreateMode

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    Location string

    The geo-location where the resource lives

    MaxSizeBytes float64

    Maximum size in bytes

    ProvisioningState string

    Resource state

    RecoverableDatabaseId string

    Backup database to restore from

    RestorePointInTime string

    Snapshot time to restore

    Sku SkuArgs

    SQL pool SKU

    SourceDatabaseDeletionDate string

    Specifies the time that the sql pool was deleted

    SourceDatabaseId string

    Source database to create from

    SqlPoolName string

    SQL pool name

    StorageAccountType string | StorageAccountType

    The storage account type used to store backups for this sql pool.

    Tags map[string]string

    Resource tags.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    workspaceName String

    The name of the workspace.

    collation String

    Collation mode

    createMode String | CreateMode

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    location String

    The geo-location where the resource lives

    maxSizeBytes Double

    Maximum size in bytes

    provisioningState String

    Resource state

    recoverableDatabaseId String

    Backup database to restore from

    restorePointInTime String

    Snapshot time to restore

    sku Sku

    SQL pool SKU

    sourceDatabaseDeletionDate String

    Specifies the time that the sql pool was deleted

    sourceDatabaseId String

    Source database to create from

    sqlPoolName String

    SQL pool name

    storageAccountType String | StorageAccountType

    The storage account type used to store backups for this sql pool.

    tags Map<String,String>

    Resource tags.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    workspaceName string

    The name of the workspace.

    collation string

    Collation mode

    createMode string | CreateMode

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    location string

    The geo-location where the resource lives

    maxSizeBytes number

    Maximum size in bytes

    provisioningState string

    Resource state

    recoverableDatabaseId string

    Backup database to restore from

    restorePointInTime string

    Snapshot time to restore

    sku Sku

    SQL pool SKU

    sourceDatabaseDeletionDate string

    Specifies the time that the sql pool was deleted

    sourceDatabaseId string

    Source database to create from

    sqlPoolName string

    SQL pool name

    storageAccountType string | StorageAccountType

    The storage account type used to store backups for this sql pool.

    tags {[key: string]: string}

    Resource tags.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    workspace_name str

    The name of the workspace.

    collation str

    Collation mode

    create_mode str | CreateMode

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    location str

    The geo-location where the resource lives

    max_size_bytes float

    Maximum size in bytes

    provisioning_state str

    Resource state

    recoverable_database_id str

    Backup database to restore from

    restore_point_in_time str

    Snapshot time to restore

    sku SkuArgs

    SQL pool SKU

    source_database_deletion_date str

    Specifies the time that the sql pool was deleted

    source_database_id str

    Source database to create from

    sql_pool_name str

    SQL pool name

    storage_account_type str | StorageAccountType

    The storage account type used to store backups for this sql pool.

    tags Mapping[str, str]

    Resource tags.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    workspaceName String

    The name of the workspace.

    collation String

    Collation mode

    createMode String | "Default" | "PointInTimeRestore" | "Recovery" | "Restore"

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    location String

    The geo-location where the resource lives

    maxSizeBytes Number

    Maximum size in bytes

    provisioningState String

    Resource state

    recoverableDatabaseId String

    Backup database to restore from

    restorePointInTime String

    Snapshot time to restore

    sku Property Map

    SQL pool SKU

    sourceDatabaseDeletionDate String

    Specifies the time that the sql pool was deleted

    sourceDatabaseId String

    Source database to create from

    sqlPoolName String

    SQL pool name

    storageAccountType String | "GRS" | "LRS"

    The storage account type used to store backups for this sql pool.

    tags Map<String>

    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlPool resource produces the following output properties:

    CreationDate string

    Date the SQL pool was created

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    Status string

    Resource status

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    CreationDate string

    Date the SQL pool was created

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    Status string

    Resource status

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    creationDate String

    Date the SQL pool was created

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    status String

    Resource status

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    creationDate string

    Date the SQL pool was created

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the resource

    status string

    Resource status

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    creation_date str

    Date the SQL pool was created

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the resource

    status str

    Resource status

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    creationDate String

    Date the SQL pool was created

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    status String

    Resource status

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    CreateMode, CreateModeArgs

    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    Recovery
    Recovery
    Restore
    Restore
    CreateModeDefault
    Default
    CreateModePointInTimeRestore
    PointInTimeRestore
    CreateModeRecovery
    Recovery
    CreateModeRestore
    Restore
    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    Recovery
    Recovery
    Restore
    Restore
    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    Recovery
    Recovery
    Restore
    Restore
    DEFAULT
    Default
    POINT_IN_TIME_RESTORE
    PointInTimeRestore
    RECOVERY
    Recovery
    RESTORE
    Restore
    "Default"
    Default
    "PointInTimeRestore"
    PointInTimeRestore
    "Recovery"
    Recovery
    "Restore"
    Restore

    Sku, SkuArgs

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Name string

    The SKU name

    Tier string

    The service tier

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Name string

    The SKU name

    Tier string

    The service tier

    capacity Integer

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name String

    The SKU name

    tier String

    The service tier

    capacity number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name string

    The SKU name

    tier string

    The service tier

    capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name str

    The SKU name

    tier str

    The service tier

    capacity Number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name String

    The SKU name

    tier String

    The service tier

    SkuResponse, SkuResponseArgs

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Name string

    The SKU name

    Tier string

    The service tier

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Name string

    The SKU name

    Tier string

    The service tier

    capacity Integer

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name String

    The SKU name

    tier String

    The service tier

    capacity number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name string

    The SKU name

    tier string

    The service tier

    capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name str

    The SKU name

    tier str

    The service tier

    capacity Number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    name String

    The SKU name

    tier String

    The service tier

    StorageAccountType, StorageAccountTypeArgs

    GRS
    GRS
    LRS
    LRS
    StorageAccountTypeGRS
    GRS
    StorageAccountTypeLRS
    LRS
    GRS
    GRS
    LRS
    LRS
    GRS
    GRS
    LRS
    LRS
    GRS
    GRS
    LRS
    LRS
    "GRS"
    GRS
    "LRS"
    LRS

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:synapse:SqlPool ExampleSqlPool /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi
    pulumi/pulumi-azure-native