InstancePoolsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:instance_pools> attribute.

Constructor

InstancePoolsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an instance pool.
begin_delete	Deletes an instance pool.
begin_update	Updates an instance pool.
get	Gets an instance pool.
list	Gets a list of all instance pools in the subscription.
list_by_resource_group	Gets a list of instance pools in the resource group.

begin_create_or_update

Creates or updates an instance pool.

async begin_create_or_update(resource_group_name: str, instance_pool_name: str, parameters: _models.InstancePool, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.InstancePool]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
instance_pool_name Required	str The name of the instance pool to be created or updated. Required.
parameters Required	InstancePool or IO[bytes] The requested instance pool resource state. Is either a InstancePool type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an instance pool.

async begin_delete(resource_group_name: str, instance_pool_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
instance_pool_name Required	str The name of the instance pool to be deleted. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an instance pool.

async begin_update(resource_group_name: str, instance_pool_name: str, parameters: _models.InstancePoolUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.InstancePool]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
instance_pool_name Required	str The name of the instance pool to be updated. Required.
parameters Required	InstancePoolUpdate or IO[bytes] The requested instance pool resource state. Is either a InstancePoolUpdate type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets an instance pool.

async get(resource_group_name: str, instance_pool_name: str, **kwargs: Any) -> InstancePool

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
instance_pool_name Required	str The name of the instance pool to be retrieved. Required.

Returns

Type	Description
InstancePool	InstancePool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of all instance pools in the subscription.

list(**kwargs: Any) -> AsyncItemPaged[InstancePool]

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets a list of instance pools in the resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncItemPaged[InstancePool]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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