1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. SqlPool

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.synapse.SqlPool

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages a Synapse SQL Pool.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "examplestorageacc",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        accountKind: "BlobStorage",
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
        name: "example",
        storageAccountId: exampleAccount.id,
    });
    const exampleWorkspace = new azure.synapse.Workspace("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
        sqlAdministratorLogin: "sqladminuser",
        sqlAdministratorLoginPassword: "H@Sh1CoR3!",
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleSqlPool = new azure.synapse.SqlPool("example", {
        name: "examplesqlpool",
        synapseWorkspaceId: exampleWorkspace.id,
        skuName: "DW100c",
        createMode: "Default",
        storageAccountType: "GRS",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.storage.Account("example",
        name="examplestorageacc",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS",
        account_kind="BlobStorage")
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
        name="example",
        storage_account_id=example_account.id)
    example_workspace = azure.synapse.Workspace("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
        sql_administrator_login="sqladminuser",
        sql_administrator_login_password="H@Sh1CoR3!",
        identity={
            "type": "SystemAssigned",
        })
    example_sql_pool = azure.synapse.SqlPool("example",
        name="examplesqlpool",
        synapse_workspace_id=example_workspace.id,
        sku_name="DW100c",
        create_mode="Default",
        storage_account_type="GRS")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplestorageacc"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    			AccountKind:            pulumi.String("BlobStorage"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
    			Name:             pulumi.String("example"),
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
    			Name:                            pulumi.String("example"),
    			ResourceGroupName:               example.Name,
    			Location:                        example.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = synapse.NewSqlPool(ctx, "example", &synapse.SqlPoolArgs{
    			Name:               pulumi.String("examplesqlpool"),
    			SynapseWorkspaceId: exampleWorkspace.ID(),
    			SkuName:            pulumi.String("DW100c"),
    			CreateMode:         pulumi.String("Default"),
    			StorageAccountType: pulumi.String("GRS"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplestorageacc",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "BlobStorage",
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
        {
            Name = "example",
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleSqlPool = new Azure.Synapse.SqlPool("example", new()
        {
            Name = "examplesqlpool",
            SynapseWorkspaceId = exampleWorkspace.Id,
            SkuName = "DW100c",
            CreateMode = "Default",
            StorageAccountType = "GRS",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.storage.DataLakeGen2Filesystem;
    import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
    import com.pulumi.azure.synapse.Workspace;
    import com.pulumi.azure.synapse.WorkspaceArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
    import com.pulumi.azure.synapse.SqlPool;
    import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("examplestorageacc")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .accountKind("BlobStorage")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
                .name("example")
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleSqlPool = new SqlPool("exampleSqlPool", SqlPoolArgs.builder()
                .name("examplesqlpool")
                .synapseWorkspaceId(exampleWorkspace.id())
                .skuName("DW100c")
                .createMode("Default")
                .storageAccountType("GRS")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplestorageacc
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
          accountKind: BlobStorage
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        name: example
        properties:
          name: example
          storageAccountId: ${exampleAccount.id}
      exampleWorkspace:
        type: azure:synapse:Workspace
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          identity:
            type: SystemAssigned
      exampleSqlPool:
        type: azure:synapse:SqlPool
        name: example
        properties:
          name: examplesqlpool
          synapseWorkspaceId: ${exampleWorkspace.id}
          skuName: DW100c
          createMode: Default
          storageAccountType: GRS
    

    Create SqlPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SqlPool(name: string, args: SqlPoolArgs, opts?: CustomResourceOptions);
    @overload
    def SqlPool(resource_name: str,
                args: SqlPoolArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def SqlPool(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                sku_name: Optional[str] = None,
                synapse_workspace_id: Optional[str] = None,
                collation: Optional[str] = None,
                create_mode: Optional[str] = None,
                data_encrypted: Optional[bool] = None,
                geo_backup_policy_enabled: Optional[bool] = None,
                name: Optional[str] = None,
                recovery_database_id: Optional[str] = None,
                restore: Optional[SqlPoolRestoreArgs] = None,
                storage_account_type: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = 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:synapse:SqlPool
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sqlPoolResource = new Azure.Synapse.SqlPool("sqlPoolResource", new()
    {
        SkuName = "string",
        SynapseWorkspaceId = "string",
        Collation = "string",
        CreateMode = "string",
        DataEncrypted = false,
        GeoBackupPolicyEnabled = false,
        Name = "string",
        RecoveryDatabaseId = "string",
        Restore = new Azure.Synapse.Inputs.SqlPoolRestoreArgs
        {
            PointInTime = "string",
            SourceDatabaseId = "string",
        },
        StorageAccountType = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := synapse.NewSqlPool(ctx, "sqlPoolResource", &synapse.SqlPoolArgs{
    	SkuName:                pulumi.String("string"),
    	SynapseWorkspaceId:     pulumi.String("string"),
    	Collation:              pulumi.String("string"),
    	CreateMode:             pulumi.String("string"),
    	DataEncrypted:          pulumi.Bool(false),
    	GeoBackupPolicyEnabled: pulumi.Bool(false),
    	Name:                   pulumi.String("string"),
    	RecoveryDatabaseId:     pulumi.String("string"),
    	Restore: &synapse.SqlPoolRestoreArgs{
    		PointInTime:      pulumi.String("string"),
    		SourceDatabaseId: pulumi.String("string"),
    	},
    	StorageAccountType: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var sqlPoolResource = new SqlPool("sqlPoolResource", SqlPoolArgs.builder()
        .skuName("string")
        .synapseWorkspaceId("string")
        .collation("string")
        .createMode("string")
        .dataEncrypted(false)
        .geoBackupPolicyEnabled(false)
        .name("string")
        .recoveryDatabaseId("string")
        .restore(SqlPoolRestoreArgs.builder()
            .pointInTime("string")
            .sourceDatabaseId("string")
            .build())
        .storageAccountType("string")
        .tags(Map.of("string", "string"))
        .build());
    
    sql_pool_resource = azure.synapse.SqlPool("sqlPoolResource",
        sku_name="string",
        synapse_workspace_id="string",
        collation="string",
        create_mode="string",
        data_encrypted=False,
        geo_backup_policy_enabled=False,
        name="string",
        recovery_database_id="string",
        restore={
            "pointInTime": "string",
            "sourceDatabaseId": "string",
        },
        storage_account_type="string",
        tags={
            "string": "string",
        })
    
    const sqlPoolResource = new azure.synapse.SqlPool("sqlPoolResource", {
        skuName: "string",
        synapseWorkspaceId: "string",
        collation: "string",
        createMode: "string",
        dataEncrypted: false,
        geoBackupPolicyEnabled: false,
        name: "string",
        recoveryDatabaseId: "string",
        restore: {
            pointInTime: "string",
            sourceDatabaseId: "string",
        },
        storageAccountType: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:synapse:SqlPool
    properties:
        collation: string
        createMode: string
        dataEncrypted: false
        geoBackupPolicyEnabled: false
        name: string
        recoveryDatabaseId: string
        restore:
            pointInTime: string
            sourceDatabaseId: string
        skuName: string
        storageAccountType: string
        synapseWorkspaceId: string
        tags:
            string: string
    

    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:

    SkuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    SynapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    Collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    CreateMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    DataEncrypted bool
    Is transparent data encryption enabled?
    GeoBackupPolicyEnabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    Name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    RecoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    Restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    StorageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    SkuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    SynapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    Collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    CreateMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    DataEncrypted bool
    Is transparent data encryption enabled?
    GeoBackupPolicyEnabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    Name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    RecoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    Restore SqlPoolRestoreArgs
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    StorageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    Tags map[string]string
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    skuName String
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    synapseWorkspaceId String
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    collation String
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode String
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted Boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled Boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name String
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    storageAccountType String
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    skuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    synapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    storageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    sku_name str
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    synapse_workspace_id str
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    collation str
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    create_mode str
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    data_encrypted bool
    Is transparent data encryption enabled?
    geo_backup_policy_enabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name str
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recovery_database_id str
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestoreArgs
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    storage_account_type str
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    skuName String
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    synapseWorkspaceId String
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    collation String
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode String
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted Boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled Boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name String
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore Property Map
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    storageAccountType String
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    tags Map<String>
    A mapping of tags which should be assigned to the Synapse SQL Pool.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlPool Resource

    Get an existing SqlPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SqlPoolState, opts?: CustomResourceOptions): SqlPool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            collation: Optional[str] = None,
            create_mode: Optional[str] = None,
            data_encrypted: Optional[bool] = None,
            geo_backup_policy_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            recovery_database_id: Optional[str] = None,
            restore: Optional[SqlPoolRestoreArgs] = None,
            sku_name: Optional[str] = None,
            storage_account_type: Optional[str] = None,
            synapse_workspace_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> SqlPool
    func GetSqlPool(ctx *Context, name string, id IDInput, state *SqlPoolState, opts ...ResourceOption) (*SqlPool, error)
    public static SqlPool Get(string name, Input<string> id, SqlPoolState? state, CustomResourceOptions? opts = null)
    public static SqlPool get(String name, Output<String> id, SqlPoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    CreateMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    DataEncrypted bool
    Is transparent data encryption enabled?
    GeoBackupPolicyEnabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    Name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    RecoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    Restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    SkuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    StorageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    SynapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    Collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    CreateMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    DataEncrypted bool
    Is transparent data encryption enabled?
    GeoBackupPolicyEnabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    Name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    RecoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    Restore SqlPoolRestoreArgs
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    SkuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    StorageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    SynapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    collation String
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode String
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted Boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled Boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name String
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    skuName String
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    storageAccountType String
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    synapseWorkspaceId String
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    collation string
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode string
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name string
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestore
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    skuName string
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    storageAccountType string
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    synapseWorkspaceId string
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    collation str
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    create_mode str
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    data_encrypted bool
    Is transparent data encryption enabled?
    geo_backup_policy_enabled bool
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name str
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recovery_database_id str
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore SqlPoolRestoreArgs
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    sku_name str
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    storage_account_type str
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    synapse_workspace_id str
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Synapse SQL Pool.
    collation String
    The name of the collation to use with this pool, only applicable when create_mode is set to Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new Synapse SQL Pool to be created.
    createMode String
    Specifies how to create the SQL Pool. Valid values are: Default, Recovery or PointInTimeRestore. Must be Default to create a new database. Defaults to Default. Changing this forces a new Synapse SQL Pool to be created.
    dataEncrypted Boolean
    Is transparent data encryption enabled?
    geoBackupPolicyEnabled Boolean
    Is geo-backup policy enabled? Possible values include true or false. Defaults to true.
    name String
    The name which should be used for this Synapse SQL Pool. Changing this forces a new Synapse SQL Pool to be created.
    recoveryDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when create_mode is set to Recovery. Changing this forces a new Synapse SQL Pool to be created.
    restore Property Map
    A restore block as defined below. Only applicable when create_mode is set to PointInTimeRestore. Changing this forces a new Synapse SQL Pool to be created.
    skuName String
    Specifies the SKU Name for this Synapse SQL Pool. Possible values are DW100c, DW200c, DW300c, DW400c, DW500c, DW1000c, DW1500c, DW2000c, DW2500c, DW3000c, DW5000c, DW6000c, DW7500c, DW10000c, DW15000c or DW30000c.
    storageAccountType String
    The storage account type that will be used to store backups for this Synapse SQL Pool. Possible values are LRS or GRS. Changing this forces a new Synapse SQL Pool to be created. Defaults to GRS.
    synapseWorkspaceId String
    The ID of Synapse Workspace within which this SQL Pool should be created. Changing this forces a new Synapse SQL Pool to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Synapse SQL Pool.

    Supporting Types

    SqlPoolRestore, SqlPoolRestoreArgs

    PointInTime string
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    SourceDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.
    PointInTime string
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    SourceDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.
    pointInTime String
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    sourceDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.
    pointInTime string
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    sourceDatabaseId string
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.
    point_in_time str
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    source_database_id str
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.
    pointInTime String
    Specifies the Snapshot time to restore formatted as an RFC3339 date string. Changing this forces a new Synapse SQL Pool to be created.
    sourceDatabaseId String
    The ID of the Synapse SQL Pool or SQL Database which is to restore. Changing this forces a new Synapse SQL Pool to be created.

    Import

    Synapse SQL Pool can be imported using the resource id, e.g.

    $ pulumi import azure:synapse/sqlPool:SqlPool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/sqlPools/sqlPool1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi