azure.mgmt.sql.operations.ManagedInstancesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.sql.operations.ManagedInstancesOperations
name: ManagedInstancesOperations
fullName: azure.mgmt.sql.operations.ManagedInstancesOperations
module: azure.mgmt.sql.operations
inheritances:
- builtins.object
summary: 'ManagedInstancesOperations 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: ManagedInstancesOperations(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.ManagedInstancesOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates or updates a managed instance.
  signature: 'begin_create_or_update(resource_group_name: str, managed_instance_name:
    str, parameters: ''_models.ManagedInstance'', **kwargs: Any) -> LROPoller[''_models.ManagedInstance'']'
  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: managed_instance_name
    description: The name of the managed instance.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The requested managed instance resource state.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.ManagedInstance>
  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 ManagedInstance or the
      result of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.ManagedInstance>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.begin_delete
  name: begin_delete
  summary: Deletes a managed instance.
  signature: 'begin_delete(resource_group_name: str, managed_instance_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: managed_instance_name
    description: The name of the managed instance.
    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.ManagedInstancesOperations.begin_failover
  name: begin_failover
  summary: Failovers a managed instance.
  signature: 'begin_failover(resource_group_name: str, managed_instance_name: str,
    replica_type: str | ''_models.ReplicaType'' | None = None, **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: managed_instance_name
    description: The name of the managed instance to failover.
    isRequired: true
    types:
    - <xref:str>
  - name: replica_type
    description: The type of replica to be failed over.
    defaultValue: None
    types:
    - <xref:str>
    - <xref:azure.mgmt.sql.models.ReplicaType>
  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.ManagedInstancesOperations.begin_update
  name: begin_update
  summary: Updates a managed instance.
  signature: 'begin_update(resource_group_name: str, managed_instance_name: str, parameters:
    ''_models.ManagedInstanceUpdate'', **kwargs: Any) -> LROPoller[''_models.ManagedInstance'']'
  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: managed_instance_name
    description: The name of the managed instance.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The requested managed instance resource state.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.ManagedInstanceUpdate>
  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 ManagedInstance or the
      result of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.ManagedInstance>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.get
  name: get
  summary: Gets a managed instance.
  signature: 'get(resource_group_name: str, managed_instance_name: str, expand: str
    | None = None, **kwargs: Any) -> _models.ManagedInstance'
  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: managed_instance_name
    description: The name of the managed instance.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: The child resources to include in the response.
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagedInstance, or the result of cls(response)
    types:
    - <xref:azure.mgmt.sql.models.ManagedInstance>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.list
  name: list
  summary: Gets a list of all managed instances in the subscription.
  signature: 'list(expand: str | None = None, **kwargs: Any) -> Iterable[''_models.ManagedInstanceListResult'']'
  parameters:
  - name: expand
    description: The child resources to include in the response.
    defaultValue: None
    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 ManagedInstanceListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.ManagedInstanceListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.list_by_instance_pool
  name: list_by_instance_pool
  summary: Gets a list of all managed instances in an instance pool.
  signature: 'list_by_instance_pool(resource_group_name: str, instance_pool_name:
    str, expand: str | None = None, **kwargs: Any) -> Iterable[''_models.ManagedInstanceListResult'']'
  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 instance pool name.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: The child resources to include in the response.
    defaultValue: None
    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 ManagedInstanceListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.ManagedInstanceListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.list_by_managed_instance
  name: list_by_managed_instance
  summary: Get top resource consuming queries of a managed instance.
  signature: 'list_by_managed_instance(resource_group_name: str, managed_instance_name:
    str, number_of_queries: int | None = None, databases: str | None = None, start_time:
    str | None = None, end_time: str | None = None, interval: str | ''_models.QueryTimeGrainType''
    | None = None, aggregation_function: str | ''_models.AggregationFunctionType''
    | None = None, observation_metric: str | ''_models.MetricType'' | None = None,
    **kwargs: Any) -> Iterable[''_models.TopQueriesListResult'']'
  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: managed_instance_name
    description: The name of the managed instance.
    isRequired: true
    types:
    - <xref:str>
  - name: number_of_queries
    description: How many 'top queries' to return. Default is 5.
    defaultValue: None
    types:
    - <xref:int>
  - name: databases
    description: 'Comma separated list of databases to be included into search. All
      DB''s are

      included if this parameter is not specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: start_time
    description: Start time for observed period.
    defaultValue: None
    types:
    - <xref:str>
  - name: end_time
    description: End time for observed period.
    defaultValue: None
    types:
    - <xref:str>
  - name: interval
    description: 'The time step to be used to summarize the metric values. Default
      value is

      PT1H.'
    defaultValue: None
    types:
    - <xref:str>
    - <xref:azure.mgmt.sql.models.QueryTimeGrainType>
  - name: aggregation_function
    description: Aggregation function to be used, default value is 'sum'.
    defaultValue: None
    types:
    - <xref:str>
    - <xref:azure.mgmt.sql.models.AggregationFunctionType>
  - name: observation_metric
    description: Metric to be used for ranking top queries. Default is 'cpu'.
    defaultValue: None
    types:
    - <xref:str>
    - <xref:azure.mgmt.sql.models.MetricType>
  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 TopQueriesListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.TopQueriesListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Gets a list of managed instances in a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, expand: str | None
    = None, **kwargs: Any) -> Iterable[''_models.ManagedInstanceListResult'']'
  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: expand
    description: The child resources to include in the response.
    defaultValue: None
    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 ManagedInstanceListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.ManagedInstanceListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.sql.operations.ManagedInstancesOperations.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'>