azure.mgmt.sql.operations.InstancePoolsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.sql.operations.InstancePoolsOperations
name: InstancePoolsOperations
fullName: azure.mgmt.sql.operations.InstancePoolsOperations
module: azure.mgmt.sql.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
  syntax: InstancePoolsOperations(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.InstancePoolsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates or updates an instance pool.
  signature: 'begin_create_or_update(resource_group_name: str, instance_pool_name:
    str, parameters: ''_models.InstancePool'', **kwargs: Any) -> LROPoller[''_models.InstancePool'']'
  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: instance_pool_name
    description: The name of the instance pool to be created or updated.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The requested instance pool resource state.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.InstancePool>
  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 InstancePool or the
      result of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.InstancePool>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.InstancePoolsOperations.begin_delete
  name: begin_delete
  summary: Deletes an instance pool.
  signature: 'begin_delete(resource_group_name: str, instance_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: instance_pool_name
    description: The name of the instance pool to be deleted.
    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.InstancePoolsOperations.begin_update
  name: begin_update
  summary: Updates an instance pool.
  signature: 'begin_update(resource_group_name: str, instance_pool_name: str, parameters:
    ''_models.InstancePoolUpdate'', **kwargs: Any) -> LROPoller[''_models.InstancePool'']'
  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: instance_pool_name
    description: The name of the instance pool to be updated.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The requested instance pool resource state.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.InstancePoolUpdate>
  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 InstancePool or the
      result of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.InstancePool>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.InstancePoolsOperations.get
  name: get
  summary: Gets an instance pool.
  signature: 'get(resource_group_name: str, instance_pool_name: str, **kwargs: Any)
    -> _models.InstancePool'
  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: instance_pool_name
    description: The name of the instance pool to be retrieved.
    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: InstancePool, or the result of cls(response)
    types:
    - <xref:azure.mgmt.sql.models.InstancePool>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.InstancePoolsOperations.list
  name: list
  summary: Gets a list of all instance pools in the subscription.
  signature: 'list(**kwargs: Any) -> Iterable[''_models.InstancePoolListResult'']'
  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 InstancePoolListResult or the
      result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.InstancePoolListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.InstancePoolsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Gets a list of instance pools in the resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[''_models.InstancePoolListResult'']'
  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>
  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 InstancePoolListResult or the
      result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.InstancePoolListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.sql.operations.InstancePoolsOperations.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'>