ElasticPoolsOperations Class
ElasticPoolsOperations 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.objectElasticPoolsOperations
Constructor
ElasticPoolsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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.
begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: _models.ElasticPool, **kwargs: Any) -> LROPoller[_models.ElasticPool]Parameters
- resource_group_name
- 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.
- 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 ElasticPool or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes an elastic pool.
begin_delete(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- resource_group_name
- 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.
- 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_failover
Failovers an elastic pool.
begin_failover(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- resource_group_name
- 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.
- 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 elastic pool.
begin_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: _models.ElasticPoolUpdate, **kwargs: Any) -> LROPoller[_models.ElasticPool]Parameters
- resource_group_name
- 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.
- 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 ElasticPool or the result of cls(response)
Return type
Exceptions
get
Gets an elastic pool.
get(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> _models.ElasticPoolParameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ElasticPool, or the result of cls(response)
Return type
Exceptions
list_by_server
Gets all elastic pools in a server.
list_by_server(resource_group_name: str, server_name: str, skip: Optional[int] = None, **kwargs: Any) -> Iterable[_models.ElasticPoolListResult]Parameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ElasticPoolListResult or the result of cls(response)
Return type
Exceptions
list_metric_definitions
Returns elastic pool metric definitions.
list_metric_definitions(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) -> Iterable[_models.MetricDefinitionListResult]Parameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either MetricDefinitionListResult or the result of cls(response)
Return type
Exceptions
list_metrics
Returns elastic pool metrics.
list_metrics(resource_group_name: str, server_name: str, elastic_pool_name: str, filter: str, **kwargs: Any) -> Iterable[_models.MetricListResult]Parameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either MetricListResult 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'>Feedback
Submit and view feedback for