Interface SqlPool
public interface SqlPool
An immutable client-side representation of SqlPool.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the SqlPool definition.static interface
The SqlPool definition stages.static interface
The template for SqlPool update.static interface
The SqlPool update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the collation property: Collation mode.Gets the createMode property: Specifies the mode of sql pool creation.Gets the creationDate property: Date the SQL pool was created.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.synapse.fluent.models.SqlPoolInner object.location()
Gets the location property: The geo-location where the resource lives.Gets the maxSizeBytes property: Maximum size in bytes.name()
Gets the name property: The name of the resource.pause()
Pause SQL poolpause
(com.azure.core.util.Context context) Pause SQL poolGets the provisioningState property: Resource state.Gets the recoverableDatabaseId property: Backup database to restore from.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.void
rename
(ResourceMoveDefinition parameters) Rename a SQL poolcom.azure.core.http.rest.Response<Void>
renameWithResponse
(ResourceMoveDefinition parameters, com.azure.core.util.Context context) Rename a SQL poolGets the name of the resource group.Gets the restorePointInTime property: Snapshot time to restore.resume()
Resume SQL poolresume
(com.azure.core.util.Context context) Resume SQL poolsku()
Gets the sku property: SkuGets the sourceDatabaseDeletionDate property: Specifies the time that the sql pool was deleted.Gets the sourceDatabaseId property: Source database to create from.status()
Gets the status property: Resource status.Gets the storageAccountType property: The storage account type used to store backups for this sql pool.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the SqlPool resource.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
sku
Sku sku()Gets the sku property: SkuSQL pool SKU.
- Returns:
- the sku value.
-
maxSizeBytes
Long maxSizeBytes()Gets the maxSizeBytes property: Maximum size in bytes.- Returns:
- the maxSizeBytes value.
-
collation
String collation()Gets the collation property: Collation mode.- Returns:
- the collation value.
-
sourceDatabaseId
String sourceDatabaseId()Gets the sourceDatabaseId property: Source database to create from.- Returns:
- the sourceDatabaseId value.
-
recoverableDatabaseId
String recoverableDatabaseId()Gets the recoverableDatabaseId property: Backup database to restore from.- Returns:
- the recoverableDatabaseId value.
-
provisioningState
String provisioningState()Gets the provisioningState property: Resource state.- Returns:
- the provisioningState value.
-
status
String status()Gets the status property: Resource status.- Returns:
- the status value.
-
restorePointInTime
OffsetDateTime restorePointInTime()Gets the restorePointInTime property: Snapshot time to restore.- Returns:
- the restorePointInTime value.
-
createMode
CreateMode createMode()Gets the createMode property: 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.
- Returns:
- the createMode value.
-
creationDate
OffsetDateTime creationDate()Gets the creationDate property: Date the SQL pool was created.- Returns:
- the creationDate value.
-
storageAccountType
StorageAccountType storageAccountType()Gets the storageAccountType property: The storage account type used to store backups for this sql pool.- Returns:
- the storageAccountType value.
-
sourceDatabaseDeletionDate
OffsetDateTime sourceDatabaseDeletionDate()Gets the sourceDatabaseDeletionDate property: Specifies the time that the sql pool was deleted.- Returns:
- the sourceDatabaseDeletionDate value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
SqlPoolInner innerModel()Gets the inner com.azure.resourcemanager.synapse.fluent.models.SqlPoolInner object.- Returns:
- the inner object.
-
update
SqlPool.Update update()Begins update for the SqlPool resource.- Returns:
- the stage of resource update.
-
refresh
SqlPool refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
pause
SqlPool pause()Pause SQL poolPause a SQL pool.
- Returns:
- sQL pool.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
pause
Pause SQL poolPause a SQL pool.
- Parameters:
context
- The context to associate with this operation.- Returns:
- sQL pool.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
resume
SqlPool resume()Resume SQL poolResume a SQL pool.
- Returns:
- sQL pool.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
resume
Resume SQL poolResume a SQL pool.
- Parameters:
context
- The context to associate with this operation.- Returns:
- sQL pool.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
renameWithResponse
com.azure.core.http.rest.Response<Void> renameWithResponse(ResourceMoveDefinition parameters, com.azure.core.util.Context context) Rename a SQL poolRename a SQL pool.
- Parameters:
parameters
- The resource move definition for renaming this Sql pool.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
rename
Rename a SQL poolRename a SQL pool.
- Parameters:
parameters
- The resource move definition for renaming this Sql pool.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-