ElasticPoolsOperations Class

ElasticPoolsOperations async 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
ElasticPoolsOperations

Constructor

ElasticPoolsOperations(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 elastic pool.

begin_delete

Deletes an elastic pool.

begin_failover

Failovers an elastic pool.

begin_update

Updates an elastic pool.

get

Gets an elastic pool.

list_by_server

Gets all elastic pools in a server.

list_metric_definitions

Returns elastic pool metric definitions.

list_metrics

Returns elastic pool metrics.

begin_create_or_update

Creates or updates an elastic pool.

async begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: ElasticPool, **kwargs: Any) -> AsyncLROPoller[ElasticPool]

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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

parameters
Required

The elastic pool parameters.

Keyword-Only Parameters

Name Description
cls

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

By default, your polling method will be AsyncARMPolling. 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

An instance of AsyncLROPoller that returns either ElasticPool or the result of cls(response)

Exceptions

Type Description

begin_delete

Deletes an elastic pool.

async begin_delete(resource_group_name: str, server_name: str, elastic_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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

Keyword-Only Parameters

Name Description
cls

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

By default, your polling method will be AsyncARMPolling. 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

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

Exceptions

Type Description

begin_failover

Failovers an elastic pool.

async begin_failover(resource_group_name: str, server_name: str, elastic_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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool to failover.

Keyword-Only Parameters

Name Description
cls

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

By default, your polling method will be AsyncARMPolling. 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

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

Exceptions

Type Description

begin_update

Updates an elastic pool.

async begin_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: ElasticPoolUpdate, **kwargs: Any) -> AsyncLROPoller[ElasticPool]

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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

parameters
Required

The elastic pool update parameters.

Keyword-Only Parameters

Name Description
cls

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

By default, your polling method will be AsyncARMPolling. 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

An instance of AsyncLROPoller that returns either ElasticPool or the result of cls(response)

Exceptions

Type Description

get

Gets an elastic pool.

async get(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> ElasticPool

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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

ElasticPool, or the result of cls(response)

Exceptions

Type Description

list_by_server

Gets all elastic pools in a server.

list_by_server(resource_group_name: str, server_name: str, skip: int | None = None, **kwargs: Any) -> AsyncIterable[ElasticPoolListResult]

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.

server_name
Required
str

The name of the server.

skip
int

The number of elements in the collection to skip.

Default value: None

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

list_metric_definitions

Returns elastic pool metric definitions.

list_metric_definitions(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> AsyncIterable[MetricDefinitionListResult]

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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

list_metrics

Returns elastic pool metrics.

list_metrics(resource_group_name: str, server_name: str, elastic_pool_name: str, filter: str, **kwargs: Any) -> AsyncIterable[MetricListResult]

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.

server_name
Required
str

The name of the server.

elastic_pool_name
Required
str

The name of the elastic pool.

filter
Required
str

An OData filter expression that describes a subset of metrics to return.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

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'>