Share via

SqlPool interface

  • Reference
Package:
@azure/arm-synapse

A SQL Analytics pool

Extends
TrackedResource

Properties

collation

Collation mode
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

Date the SQL pool was created NOTE: This property will not be serialized. It can only be populated by the server.
maxSizeBytes

Maximum size in bytes
provisioningState

Resource state
recoverableDatabaseId

Backup database to restore from
restorePointInTime

Snapshot time to restore
sku

SQL pool SKU
sourceDatabaseDeletionDate

Specifies the time that the sql pool was deleted
sourceDatabaseId

Source database to create from
status

Resource status NOTE: This property will not be serialized. It can only be populated by the server.
storageAccountType

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

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

collation

Collation mode

collation?: string

Property Value

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.

createMode?: string

Property Value

string

creationDate

Date the SQL pool was created NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

maxSizeBytes

Maximum size in bytes

maxSizeBytes?: number

Property Value

number

provisioningState

Resource state

provisioningState?: string

Property Value

string

recoverableDatabaseId

Backup database to restore from

recoverableDatabaseId?: string

Property Value

string

restorePointInTime

Snapshot time to restore

restorePointInTime?: Date

Property Value

Date

sku

SQL pool SKU

sku?: Sku

Property Value

Sku

sourceDatabaseDeletionDate

Specifies the time that the sql pool was deleted

sourceDatabaseDeletionDate?: Date

Property Value

Date

sourceDatabaseId

Source database to create from

sourceDatabaseId?: string

Property Value

string

status

Resource status NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

storageAccountType

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

storageAccountType?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type