azure.mgmt.sql.operations.ElasticPoolsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.sql.operations.ElasticPoolsOperations
name: ElasticPoolsOperations
fullName: azure.mgmt.sql.operations.ElasticPoolsOperations
module: azure.mgmt.sql.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
  syntax: ElasticPoolsOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates or updates an elastic pool.
  signature: 'begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name:
    str, parameters: ''_models.ElasticPool'', **kwargs: Any) -> LROPoller[''_models.ElasticPool'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The elastic pool parameters.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.ElasticPool>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either ElasticPool or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.ElasticPool>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.begin_delete
  name: begin_delete
  summary: Deletes an elastic pool.
  signature: 'begin_delete(resource_group_name: str, server_name: str, elastic_pool_name:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.begin_failover
  name: begin_failover
  summary: Failovers an elastic pool.
  signature: 'begin_failover(resource_group_name: str, server_name: str, elastic_pool_name:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool to failover.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.begin_update
  name: begin_update
  summary: Updates an elastic pool.
  signature: 'begin_update(resource_group_name: str, server_name: str, elastic_pool_name:
    str, parameters: ''_models.ElasticPoolUpdate'', **kwargs: Any) -> LROPoller[''_models.ElasticPool'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The elastic pool update parameters.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.ElasticPoolUpdate>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either ElasticPool or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.ElasticPool>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.get
  name: get
  summary: Gets an elastic pool.
  signature: 'get(resource_group_name: str, server_name: str, elastic_pool_name: str,
    **kwargs: Any) -> _models.ElasticPool'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ElasticPool, or the result of cls(response)
    types:
    - <xref:azure.mgmt.sql.models.ElasticPool>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.list_by_server
  name: list_by_server
  summary: Gets all elastic pools in a server.
  signature: 'list_by_server(resource_group_name: str, server_name: str, skip: int
    | None = None, **kwargs: Any) -> Iterable[''_models.ElasticPoolListResult'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: skip
    description: The number of elements in the collection to skip.
    defaultValue: None
    types:
    - <xref:int>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ElasticPoolListResult or the
      result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.ElasticPoolListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.list_metric_definitions
  name: list_metric_definitions
  summary: Returns elastic pool metric definitions.
  signature: 'list_metric_definitions(resource_group_name: str, server_name: str,
    elastic_pool_name: str, **kwargs: Any) -> Iterable[''_models.MetricDefinitionListResult'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either MetricDefinitionListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.MetricDefinitionListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.list_metrics
  name: list_metrics
  summary: Returns elastic pool  metrics.
  signature: 'list_metrics(resource_group_name: str, server_name: str, elastic_pool_name:
    str, filter: str, **kwargs: Any) -> Iterable[''_models.MetricListResult'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: elastic_pool_name
    description: The name of the elastic pool.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: An OData filter expression that describes a subset of metrics to
      return.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either MetricListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.MetricListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.sql.operations.ElasticPoolsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>