azure-native.synapse.SqlPool
Explore with Pulumi AI
A SQL Analytics pool API Version: 2021-03-01.
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 (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse"
	"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 * 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",
});
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")
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
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,
            resource_group_name: Optional[str] = None,
            workspace_name: Optional[str] = None,
            restore_point_in_time: Optional[str] = None,
            sku: Optional[SkuArgs] = None,
            max_size_bytes: Optional[float] = None,
            provisioning_state: Optional[str] = None,
            recoverable_database_id: Optional[str] = None,
            creation_date: Optional[str] = None,
            collation: Optional[str] = None,
            location: Optional[str] = None,
            source_database_id: Optional[str] = None,
            sql_pool_name: Optional[str] = None,
            status: Optional[str] = None,
            storage_account_type: Optional[Union[str, StorageAccountType]] = None,
            tags: Optional[Mapping[str, str]] = None,
            create_mode: Optional[Union[str, CreateMode]] = 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.
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 AzureNative.Synapse.SqlPool("sqlPoolResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    RestorePointInTime = "string",
    Sku = 
    {
        { "capacity", 0 },
        { "name", "string" },
        { "tier", "string" },
    },
    MaxSizeBytes = 0,
    ProvisioningState = "string",
    RecoverableDatabaseId = "string",
    CreationDate = "string",
    Collation = "string",
    Location = "string",
    SourceDatabaseId = "string",
    SqlPoolName = "string",
    Status = "string",
    StorageAccountType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    CreateMode = "string",
});
example, err := synapse.NewSqlPool(ctx, "sqlPoolResource", &synapse.SqlPoolArgs{
	ResourceGroupName:  "string",
	WorkspaceName:      "string",
	RestorePointInTime: "string",
	Sku: map[string]interface{}{
		"capacity": 0,
		"name":     "string",
		"tier":     "string",
	},
	MaxSizeBytes:          0,
	ProvisioningState:     "string",
	RecoverableDatabaseId: "string",
	CreationDate:          "string",
	Collation:             "string",
	Location:              "string",
	SourceDatabaseId:      "string",
	SqlPoolName:           "string",
	Status:                "string",
	StorageAccountType:    "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	CreateMode: "string",
})
var sqlPoolResource = new SqlPool("sqlPoolResource", SqlPoolArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .restorePointInTime("string")
    .sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .maxSizeBytes(0)
    .provisioningState("string")
    .recoverableDatabaseId("string")
    .creationDate("string")
    .collation("string")
    .location("string")
    .sourceDatabaseId("string")
    .sqlPoolName("string")
    .status("string")
    .storageAccountType("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .createMode("string")
    .build());
sql_pool_resource = azure_native.synapse.SqlPool("sqlPoolResource",
    resource_group_name=string,
    workspace_name=string,
    restore_point_in_time=string,
    sku={
        capacity: 0,
        name: string,
        tier: string,
    },
    max_size_bytes=0,
    provisioning_state=string,
    recoverable_database_id=string,
    creation_date=string,
    collation=string,
    location=string,
    source_database_id=string,
    sql_pool_name=string,
    status=string,
    storage_account_type=string,
    tags={
        string: string,
    },
    create_mode=string)
const sqlPoolResource = new azure_native.synapse.SqlPool("sqlPoolResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    restorePointInTime: "string",
    sku: {
        capacity: 0,
        name: "string",
        tier: "string",
    },
    maxSizeBytes: 0,
    provisioningState: "string",
    recoverableDatabaseId: "string",
    creationDate: "string",
    collation: "string",
    location: "string",
    sourceDatabaseId: "string",
    sqlPoolName: "string",
    status: "string",
    storageAccountType: "string",
    tags: {
        string: "string",
    },
    createMode: "string",
});
type: azure-native:synapse:SqlPool
properties:
    collation: string
    createMode: string
    creationDate: string
    location: string
    maxSizeBytes: 0
    provisioningState: string
    recoverableDatabaseId: string
    resourceGroupName: string
    restorePointInTime: string
    sku:
        capacity: 0
        name: string
        tier: string
    sourceDatabaseId: string
    sqlPoolName: string
    status: string
    storageAccountType: string
    tags:
        string: string
    workspaceName: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SqlPool resource accepts the following input properties:
- ResourceGroup stringName 
- 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.Azure Native. Synapse. Create Mode 
- 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. 
- CreationDate string
- Date the SQL pool was created
- Location string
- The geo-location where the resource lives
- MaxSize doubleBytes 
- Maximum size in bytes
- ProvisioningState string
- Resource state
- RecoverableDatabase stringId 
- Backup database to restore from
- RestorePoint stringIn Time 
- Snapshot time to restore
- Sku
Pulumi.Azure Native. Synapse. Inputs. Sku 
- SQL pool SKU
- SourceDatabase stringId 
- Source database to create from
- SqlPool stringName 
- SQL pool name
- Status string
- Resource status
- StorageAccount string | Pulumi.Type Azure Native. Synapse. Storage Account Type 
- The storage account type used to store backups for this sql pool.
- Dictionary<string, string>
- Resource tags.
- ResourceGroup stringName 
- 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. 
- CreationDate string
- Date the SQL pool was created
- Location string
- The geo-location where the resource lives
- MaxSize float64Bytes 
- Maximum size in bytes
- ProvisioningState string
- Resource state
- RecoverableDatabase stringId 
- Backup database to restore from
- RestorePoint stringIn Time 
- Snapshot time to restore
- Sku
SkuArgs 
- SQL pool SKU
- SourceDatabase stringId 
- Source database to create from
- SqlPool stringName 
- SQL pool name
- Status string
- Resource status
- StorageAccount string | StorageType Account Type 
- The storage account type used to store backups for this sql pool.
- map[string]string
- Resource tags.
- resourceGroup StringName 
- 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. 
- creationDate String
- Date the SQL pool was created
- location String
- The geo-location where the resource lives
- maxSize DoubleBytes 
- Maximum size in bytes
- provisioningState String
- Resource state
- recoverableDatabase StringId 
- Backup database to restore from
- restorePoint StringIn Time 
- Snapshot time to restore
- sku Sku
- SQL pool SKU
- sourceDatabase StringId 
- Source database to create from
- sqlPool StringName 
- SQL pool name
- status String
- Resource status
- storageAccount String | StorageType Account Type 
- The storage account type used to store backups for this sql pool.
- Map<String,String>
- Resource tags.
- resourceGroup stringName 
- 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. 
- creationDate string
- Date the SQL pool was created
- location string
- The geo-location where the resource lives
- maxSize numberBytes 
- Maximum size in bytes
- provisioningState string
- Resource state
- recoverableDatabase stringId 
- Backup database to restore from
- restorePoint stringIn Time 
- Snapshot time to restore
- sku Sku
- SQL pool SKU
- sourceDatabase stringId 
- Source database to create from
- sqlPool stringName 
- SQL pool name
- status string
- Resource status
- storageAccount string | StorageType Account Type 
- The storage account type used to store backups for this sql pool.
- {[key: string]: string}
- Resource tags.
- resource_group_ strname 
- 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. 
- creation_date str
- Date the SQL pool was created
- location str
- The geo-location where the resource lives
- max_size_ floatbytes 
- Maximum size in bytes
- provisioning_state str
- Resource state
- recoverable_database_ strid 
- Backup database to restore from
- restore_point_ strin_ time 
- Snapshot time to restore
- sku
SkuArgs 
- SQL pool SKU
- source_database_ strid 
- Source database to create from
- sql_pool_ strname 
- SQL pool name
- status str
- Resource status
- storage_account_ str | Storagetype Account Type 
- The storage account type used to store backups for this sql pool.
- Mapping[str, str]
- Resource tags.
- resourceGroup StringName 
- 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" | "PointIn Time Restore" | "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. 
- creationDate String
- Date the SQL pool was created
- location String
- The geo-location where the resource lives
- maxSize NumberBytes 
- Maximum size in bytes
- provisioningState String
- Resource state
- recoverableDatabase StringId 
- Backup database to restore from
- restorePoint StringIn Time 
- Snapshot time to restore
- sku Property Map
- SQL pool SKU
- sourceDatabase StringId 
- Source database to create from
- sqlPool StringName 
- SQL pool name
- status String
- Resource status
- storageAccount String | "GRS" | "LRS" | "ZRS"Type 
- The storage account type used to store backups for this sql pool.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the SqlPool resource produces the following output properties:
Supporting Types
CreateMode, CreateModeArgs    
- Default
- Default
- PointIn Time Restore 
- PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- CreateMode Default 
- Default
- CreateMode Point In Time Restore 
- PointInTimeRestore
- CreateMode Recovery 
- Recovery
- CreateMode Restore 
- Restore
- Default
- Default
- PointIn Time Restore 
- PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- Default
- Default
- PointIn Time Restore 
- PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- DEFAULT
- Default
- POINT_IN_TIME_RESTORE
- PointInTimeRestore
- RECOVERY
- Recovery
- RESTORE
- Restore
- "Default"
- Default
- "PointIn Time Restore" 
- PointInTimeRestore
- "Recovery"
- Recovery
- "Restore"
- Restore
Sku, SkuArgs  
SkuResponse, SkuResponseArgs    
StorageAccountType, StorageAccountTypeArgs      
- GRS
- GRS
- LRS
- LRS
- ZRS
- ZRS
- StorageAccount Type GRS 
- GRS
- StorageAccount Type LRS 
- LRS
- StorageAccount Type ZRS 
- ZRS
- GRS
- GRS
- LRS
- LRS
- ZRS
- ZRS
- GRS
- GRS
- LRS
- LRS
- ZRS
- ZRS
- GRS
- GRS
- LRS
- LRS
- ZRS
- ZRS
- "GRS"
- GRS
- "LRS"
- LRS
- "ZRS"
- ZRS
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:synapse:SqlPool ExampleSqlPool /subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0