azure-native-v2.synapse.SqlPool
Explore with Pulumi AI
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.
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,
max_size_bytes: Optional[float] = None,
collation: Optional[str] = None,
provisioning_state: Optional[str] = None,
recoverable_database_id: Optional[str] = None,
location: 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,
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
This property is required. string - The unique name of the resource.
- args
This property is required. SqlPoolArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. SqlPoolArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SqlPoolArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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",
MaxSizeBytes = 0,
Collation = "string",
ProvisioningState = "string",
RecoverableDatabaseId = "string",
Location = "string",
RestorePointInTime = "string",
Sku =
{
{ "capacity", 0 },
{ "name", "string" },
{ "tier", "string" },
},
SourceDatabaseDeletionDate = "string",
SourceDatabaseId = "string",
SqlPoolName = "string",
StorageAccountType = "string",
Tags =
{
{ "string", "string" },
},
CreateMode = "string",
});
example, err := synapse.NewSqlPool(ctx, "sqlPoolResource", &synapse.SqlPoolArgs{
ResourceGroupName: "string",
WorkspaceName: "string",
MaxSizeBytes: 0,
Collation: "string",
ProvisioningState: "string",
RecoverableDatabaseId: "string",
Location: "string",
RestorePointInTime: "string",
Sku: map[string]interface{}{
"capacity": 0,
"name": "string",
"tier": "string",
},
SourceDatabaseDeletionDate: "string",
SourceDatabaseId: "string",
SqlPoolName: "string",
StorageAccountType: "string",
Tags: map[string]interface{}{
"string": "string",
},
CreateMode: "string",
})
var sqlPoolResource = new SqlPool("sqlPoolResource", SqlPoolArgs.builder()
.resourceGroupName("string")
.workspaceName("string")
.maxSizeBytes(0)
.collation("string")
.provisioningState("string")
.recoverableDatabaseId("string")
.location("string")
.restorePointInTime("string")
.sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.sourceDatabaseDeletionDate("string")
.sourceDatabaseId("string")
.sqlPoolName("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,
max_size_bytes=0,
collation=string,
provisioning_state=string,
recoverable_database_id=string,
location=string,
restore_point_in_time=string,
sku={
capacity: 0,
name: string,
tier: string,
},
source_database_deletion_date=string,
source_database_id=string,
sql_pool_name=string,
storage_account_type=string,
tags={
string: string,
},
create_mode=string)
const sqlPoolResource = new azure_native.synapse.SqlPool("sqlPoolResource", {
resourceGroupName: "string",
workspaceName: "string",
maxSizeBytes: 0,
collation: "string",
provisioningState: "string",
recoverableDatabaseId: "string",
location: "string",
restorePointInTime: "string",
sku: {
capacity: 0,
name: "string",
tier: "string",
},
sourceDatabaseDeletionDate: "string",
sourceDatabaseId: "string",
sqlPoolName: "string",
storageAccountType: "string",
tags: {
string: "string",
},
createMode: "string",
});
type: azure-native:synapse:SqlPool
properties:
collation: string
createMode: string
location: string
maxSizeBytes: 0
provisioningState: string
recoverableDatabaseId: string
resourceGroupName: string
restorePointInTime: string
sku:
capacity: 0
name: string
tier: string
sourceDatabaseDeletionDate: string
sourceDatabaseId: string
sqlPoolName: 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:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Collation
Changes to this property will trigger replacement.
- Collation mode
- Create
Mode 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.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Max
Size doubleBytes - Maximum size in bytes
- Provisioning
State string - Resource state
- Recoverable
Database stringId - Backup database to restore from
- Restore
Point In Time Changes to this property will trigger replacement.
- Snapshot time to restore
- Sku
Pulumi.
Azure Native. Synapse. Inputs. Sku - SQL pool SKU
- Source
Database Deletion Date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- Source
Database stringId - Source database to create from
- Sql
Pool Name Changes to this property will trigger replacement.
- SQL pool name
- Storage
Account 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.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Collation
Changes to this property will trigger replacement.
- Collation mode
- Create
Mode 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
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Max
Size float64Bytes - Maximum size in bytes
- Provisioning
State string - Resource state
- Recoverable
Database stringId - Backup database to restore from
- Restore
Point In Time Changes to this property will trigger replacement.
- Snapshot time to restore
- Sku
Sku
Args - SQL pool SKU
- Source
Database Deletion Date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- Source
Database stringId - Source database to create from
- Sql
Pool Name Changes to this property will trigger replacement.
- SQL pool name
- Storage
Account string | StorageType Account Type - The storage account type used to store backups for this sql pool.
- map[string]string
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- collation
Changes to this property will trigger replacement.
- Collation mode
- create
Mode 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
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- max
Size DoubleBytes - Maximum size in bytes
- provisioning
State String - Resource state
- recoverable
Database StringId - Backup database to restore from
- restore
Point In Time Changes to this property will trigger replacement.
- Snapshot time to restore
- sku Sku
- SQL pool SKU
- source
Database Deletion Date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- source
Database StringId - Source database to create from
- sql
Pool Name Changes to this property will trigger replacement.
- SQL pool name
- storage
Account String | StorageType Account Type - The storage account type used to store backups for this sql pool.
- Map<String,String>
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- collation
Changes to this property will trigger replacement.
- Collation mode
- create
Mode 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
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- max
Size numberBytes - Maximum size in bytes
- provisioning
State string - Resource state
- recoverable
Database stringId - Backup database to restore from
- restore
Point In Time Changes to this property will trigger replacement.
- Snapshot time to restore
- sku Sku
- SQL pool SKU
- source
Database Deletion Date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- source
Database stringId - Source database to create from
- sql
Pool Name Changes to this property will trigger replacement.
- SQL pool name
- storage
Account string | StorageType Account Type - The storage account type used to store backups for this sql pool.
- {[key: string]: string}
- Resource tags.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- collation
Changes to this property will trigger replacement.
- 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
Changes to this property will trigger replacement.
- 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_ in_ time Changes to this property will trigger replacement.
- Snapshot time to restore
- sku
Sku
Args - SQL pool SKU
- source_
database_ deletion_ date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- source_
database_ strid - Source database to create from
- sql_
pool_ name Changes to this property will trigger replacement.
- SQL pool name
- storage_
account_ str | Storagetype Account Type - The storage account type used to store backups for this sql pool.
- Mapping[str, str]
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- collation
Changes to this property will trigger replacement.
- Collation mode
- create
Mode 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.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- max
Size NumberBytes - Maximum size in bytes
- provisioning
State String - Resource state
- recoverable
Database StringId - Backup database to restore from
- restore
Point In Time Changes to this property will trigger replacement.
- Snapshot time to restore
- sku Property Map
- SQL pool SKU
- source
Database Deletion Date Changes to this property will trigger replacement.
- Specifies the time that the sql pool was deleted
- source
Database StringId - Source database to create from
- sql
Pool Name Changes to this property will trigger replacement.
- SQL pool name
- storage
Account String | "GRS" | "LRS"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:
- Creation
Date 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 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 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 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"
- creation
Date 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
- Point
In Time Restore - PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- Create
Mode Default - Default
- Create
Mode Point In Time Restore - PointInTimeRestore
- Create
Mode Recovery - Recovery
- Create
Mode Restore - Restore
- Default
- Default
- Point
In Time Restore - PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- Default
- Default
- Point
In Time Restore - PointInTimeRestore
- Recovery
- Recovery
- Restore
- Restore
- DEFAULT
- Default
- POINT_IN_TIME_RESTORE
- PointInTimeRestore
- RECOVERY
- Recovery
- RESTORE
- Restore
- "Default"
- Default
- "Point
In Time Restore" - PointInTimeRestore
- "Recovery"
- Recovery
- "Restore"
- Restore
Sku, SkuArgs
SkuResponse, SkuResponseArgs
StorageAccountType, StorageAccountTypeArgs
- GRS
- GRS
- LRS
- LRS
- Storage
Account Type GRS - GRS
- Storage
Account Type LRS - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0