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

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

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

resource_group_name
str
Required

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
str
Required

The name of the instance pool to be created or updated.

parameters
InstancePool
Required

The requested instance pool resource state.

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

An instance of LROPoller that returns either InstancePool or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes an instance pool.

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the instance pool to be deleted.

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

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

resource_group_name
str
Required

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
str
Required

The name of the instance pool to be updated.

parameters
InstancePoolUpdate
Required

The requested instance pool resource state.

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

An instance of LROPoller that returns either InstancePool or the result of cls(response)

Return type

Exceptions

get

Gets an instance pool.

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the instance pool to be retrieved.

cls
callable

A custom type or function that will be passed the direct response

Returns

InstancePool, or the result of cls(response)

Return type

Exceptions

list

Gets a list of all instance pools in the subscription.

list(**kwargs: Any) -> Iterable[_models.InstancePoolListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either InstancePoolListResult or the result of cls(response)

Return type

Exceptions

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

resource_group_name
str
Required

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

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either InstancePoolListResult or the result of cls(response)

Return type

Exceptions

Attributes

models

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