azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
name: ServerAdministratorsOperations
fullName: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations
module: azure.mgmt.rdbms.postgresql.operations
inheritances:
- builtins.object
summary: 'ServerAdministratorsOperations 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: ServerAdministratorsOperations(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.rdbms.postgresql.operations.ServerAdministratorsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: 'Creates or update active directory administrator on an existing server.
    The update action will

    overwrite the existing administrator.'
  signature: 'begin_create_or_update(resource_group_name: str, server_name: str, properties:
    ''_models.ServerAdministratorResource'', **kwargs: Any) -> LROPoller[''_models.ServerAdministratorResource'']'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. The name is case insensitive.
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: properties
    description: 'The required parameters for creating or updating an AAD server

      administrator.'
    isRequired: true
    types:
    - <xref:azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource>
  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 ServerAdministratorResource
      or the result of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations.begin_delete
  name: begin_delete
  summary: Deletes server active directory administrator.
  signature: 'begin_delete(resource_group_name: str, server_name: str, **kwargs: Any)
    -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. The name is case insensitive.
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    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.rdbms.postgresql.operations.ServerAdministratorsOperations.get
  name: get
  summary: Gets information about a AAD server administrator.
  signature: 'get(resource_group_name: str, server_name: str, **kwargs: Any) -> _models.ServerAdministratorResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. The name is case insensitive.
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    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: ServerAdministratorResource, or the result of cls(response)
    types:
    - <xref:azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations.list
  name: list
  summary: Returns a list of server Administrators.
  signature: 'list(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable[''_models.ServerAdministratorResourceListResult'']'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. The name is case insensitive.
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    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 ServerAdministratorResourceListResult
      or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.rdbms.postgresql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\rdbms\\postgresql\\models\\__init__.py'>