InstancePoolsOperations Class

InstancePoolsOperations 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.

Inheritance

builtins.object

InstancePoolsOperations

Constructor

InstancePoolsOperations(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_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.

begin_create_or_update(resource_group_name: str, instance_pool_name: str, parameters: '_models.InstancePool', **kwargs: Any) -> LROPoller['_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.
instance_pool_name Required	str The name of the instance pool to be created or updated.
parameters Required	InstancePool The requested instance pool resource state.

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 By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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[InstancePool]	An instance of LROPoller that returns either InstancePool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an instance pool.

begin_delete(resource_group_name: str, instance_pool_name: str, **kwargs: Any) -> LROPoller[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.
instance_pool_name Required	str The name of the instance pool to be deleted.

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 By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an instance pool.

begin_update(resource_group_name: str, instance_pool_name: str, parameters: '_models.InstancePoolUpdate', **kwargs: Any) -> LROPoller['_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.
instance_pool_name Required	str The name of the instance pool to be updated.
parameters Required	InstancePoolUpdate The requested instance pool resource state.

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 By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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[InstancePool]	An instance of LROPoller that returns either InstancePool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets an instance pool.

get(resource_group_name: str, instance_pool_name: str, **kwargs: Any) -> _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.
instance_pool_name Required	str The name of the instance pool to be retrieved.

Keyword-Only Parameters

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

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) -> Iterable['_models.InstancePoolListResult']

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[InstancePoolListResult]	An iterator like instance of either InstancePoolListResult 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) -> Iterable['_models.InstancePoolListResult']

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.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>