SqlPoolsOperations Class

SqlPoolsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Constructor

SqlPoolsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

begin_create	Create SQL pool. Create a SQL pool.
begin_delete	Delete SQL pool. Delete a SQL pool.
begin_pause	Pause SQL pool. Pause a SQL pool.
begin_resume	Resume SQL pool. Resume a SQL pool.
get	Get SQL pool. Get SQL pool properties.
list_by_workspace	List SQL pools. List all SQL pools.
rename	Rename a SQL pool. Rename a SQL pool.
update	Update SQL pool. Apply a partial update to a SQL pool.

begin_create

Create SQL pool.

Create a SQL pool.

begin_create(resource_group_name: str, workspace_name: str, sql_pool_name: str, sql_pool_info: '_models.SqlPool', **kwargs: Any) -> LROPoller['_models.SqlPool']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
sql_pool_info Required	SqlPool The SQL pool to create.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[SqlPool]	An instance of LROPoller that returns either SqlPool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete SQL pool.

Delete a SQL pool.

begin_delete(resource_group_name: str, workspace_name: str, sql_pool_name: str, **kwargs: Any) -> LROPoller[object]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[object]	An instance of LROPoller that returns either object or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_pause

Pause SQL pool.

Pause a SQL pool.

begin_pause(resource_group_name: str, workspace_name: str, sql_pool_name: str, **kwargs: Any) -> LROPoller[object]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[object]	An instance of LROPoller that returns either object or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_resume

Resume SQL pool.

Resume a SQL pool.

begin_resume(resource_group_name: str, workspace_name: str, sql_pool_name: str, **kwargs: Any) -> LROPoller[object]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[object]	An instance of LROPoller that returns either object or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get SQL pool.

Get SQL pool properties.

get(resource_group_name: str, workspace_name: str, sql_pool_name: str, **kwargs: Any) -> _models.SqlPool

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SqlPool	SqlPool, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_workspace

List SQL pools.

List all SQL pools.

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) -> Iterable['_models.SqlPoolInfoListResult']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[SqlPoolInfoListResult]	An iterator like instance of either SqlPoolInfoListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

rename

Rename a SQL pool.

Rename a SQL pool.

rename(resource_group_name: str, workspace_name: str, sql_pool_name: str, parameters: '_models.ResourceMoveDefinition', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
parameters Required	ResourceMoveDefinition The resource move definition for renaming this Sql pool.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update SQL pool.

Apply a partial update to a SQL pool.

update(resource_group_name: str, workspace_name: str, sql_pool_name: str, sql_pool_info: '_models.SqlPoolPatchInfo', **kwargs: Any) -> '_models.SqlPool' | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
sql_pool_info Required	SqlPoolPatchInfo The updated SQL pool properties.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SqlPool, None	SqlPool, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.synapse.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv264\\Lib\\site-packages\\azure\\mgmt\\synapse\\models\\__init__.py'>