Share via

ServersOperations Class

ServersOperations 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

ServersOperations(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

Creates a new server.
begin_delete

Deletes a server.
begin_restart

Restarts a server.
begin_start

Starts a server.
begin_stop

Stops a server.
begin_update

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
get

Gets information about a server.
list

List all the servers in a given subscription.
list_by_resource_group

List all the servers in a given resource group.

begin_create

Creates a new server.

begin_create(resource_group_name: str, server_name: str, parameters: '_models.Server', **kwargs: Any) -> LROPoller['_models.Server']

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.
parameters
Required
Server

The required parameters for creating or updating a 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[Server]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a server.

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

begin_restart

Restarts a server.

begin_restart(resource_group_name: str, server_name: str, parameters: '_models.RestartParameter' | None = None, **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.
parameters
RestartParameter

The parameters for restarting a server.

Default value: None

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

begin_start

Starts a server.

begin_start(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

begin_stop

Stops a server.

begin_stop(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

begin_update

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

begin_update(resource_group_name: str, server_name: str, parameters: '_models.ServerForUpdate', **kwargs: Any) -> LROPoller['_models.Server']

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.
parameters
Required
ServerForUpdate

The required parameters for updating a 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[Server]

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

Exceptions

Type Description
HttpResponseError

get

Gets information about a server.

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

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
Server

Server, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List all the servers in a given subscription.

list(**kwargs: Any) -> Iterable['_models.ServerListResult']

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ServerListResult]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List all the servers in a given resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable['_models.ServerListResult']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ServerListResult]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.rdbms.postgresql_flexibleservers.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv197\\Lib\\site-packages\\azure\\mgmt\\rdbms\\postgresql_flexibleservers\\models\\__init__.py'>