Share via

ServerAdministratorsOperations Class

  • Reference

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

ServerAdministratorsOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.
begin_delete

Deletes server active directory administrator.
get

Gets information about a AAD server administrator.
list

Returns a list of server Administrators.

begin_create_or_update

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

begin_create_or_update(resource_group_name: str, server_name: str, properties: '_models.ServerAdministratorResource', **kwargs: Any) -> LROPoller['_models.ServerAdministratorResource']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.
properties
Required
ServerAdministratorResource

The required parameters for creating or updating an AAD server administrator.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[ServerAdministratorResource]

An instance of LROPoller that returns either ServerAdministratorResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes server active directory administrator.

begin_delete(resource_group_name: str, server_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets information about a AAD server administrator.

get(resource_group_name: str, server_name: str, **kwargs: Any) -> _models.ServerAdministratorResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ServerAdministratorResource

ServerAdministratorResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Returns a list of server Administrators.

list(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable['_models.ServerAdministratorResourceListResult']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[ServerAdministratorResourceListResult]

An iterator like instance of either ServerAdministratorResourceListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.rdbms.postgresql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv188\\Lib\\site-packages\\azure\\mgmt\\rdbms\\postgresql\\models\\__init__.py'>