ServersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<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_failover |
Manual failover 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 or updates an existing server. The update action will overwrite the existing server.
begin_create(resource_group_name: str, server_name: str, parameters: _models.Server, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Server]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
parameters
Required
|
The required parameters for creating or updating a server. Is either a Server type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_failover
Manual failover a server.
begin_failover(resource_group_name: str, server_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_restart
Restarts a server.
begin_restart(resource_group_name: str, server_name: str, parameters: _models.ServerRestartParameter, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
parameters
Required
|
The required parameters for restarting a server. Is either a ServerRestartParameter type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Server]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
parameters
Required
|
The required parameters for updating a server. Is either a ServerForUpdate type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets information about a server.
get(resource_group_name: str, server_name: str, **kwargs: Any) -> ServerParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List all the servers in a given subscription.
list(**kwargs: Any) -> ItemPaged[Server]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
List all the servers in a given resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[Server]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.rdbms.mysql_flexibleservers.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv198\\Lib\\site-packages\\azure\\mgmt\\rdbms\\mysql_flexibleservers\\models\\__init__.py'>