Share via

ServersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MySQLManagementClient's

<xref:servers> attribute.

Constructor

ServersOperations(*args, **kwargs)

Methods

begin_create

Creates a new server or updates an existing server. The update action will overwrite the existing server.
begin_delete

Deletes a server.
begin_restart

Restarts a server.
begin_start

Starts a stopped server.
begin_stop

Stops a running server.
begin_update

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

Upgrade server version.
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 or updates an existing server. The update action will overwrite the existing server.

async begin_create(resource_group_name: str, server_name: str, parameters: _models.ServerForCreate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Server]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.
parameters
Required
ServerForCreate or IO[bytes]

The required parameters for creating or updating a server. Is either a ServerForCreate type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Server]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a server.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_restart

Restarts a server.

async begin_restart(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_start

Starts a stopped server.

async begin_start(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_stop

Stops a running server.

async begin_stop(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller 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.

async begin_update(resource_group_name: str, server_name: str, parameters: _models.ServerUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Server]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.
parameters
Required
ServerUpdateParameters or IO[bytes]

The required parameters for updating a server. Is either a ServerUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Server]

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

Exceptions

Type Description
HttpResponseError

begin_upgrade

Upgrade server version.

async begin_upgrade(resource_group_name: str, server_name: str, parameters: _models.ServerUpgradeParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.
parameters
Required
ServerUpgradeParameters or IO[bytes]

The required parameters for updating a server. Is either a ServerUpgradeParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets information about a server.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server. Required.

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) -> AsyncItemPaged[Server]

Returns

Type Description
AsyncItemPaged[Server]

An iterator like instance of either Server 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) -> AsyncItemPaged[Server]

Parameters

Name Description
resource_group_name
Required
str

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

Returns

Type Description
AsyncItemPaged[Server]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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