ServersOperations Class
ServersOperations async 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 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.
async begin_create(resource_group_name: str, server_name: str, parameters: Server, **kwargs: Any) -> AsyncLROPoller[Server]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
|
parameters
Required
|
The required parameters for creating or updating a server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_failover
Manual failover a server.
async begin_failover(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_restart
Restarts a server.
async begin_restart(resource_group_name: str, server_name: str, parameters: ServerRestartParameter, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
|
parameters
Required
|
The required parameters for restarting a server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_start
Starts a server.
async begin_start(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_stop
Stops a server.
async begin_stop(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller 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.
async begin_update(resource_group_name: str, server_name: str, parameters: ServerForUpdate, **kwargs: Any) -> AsyncLROPoller[Server]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
|
server_name
Required
|
The name of the server. |
|
parameters
Required
|
The required parameters for updating a server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either Server or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets information about a server.
async 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. |
|
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
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) -> AsyncIterable[ServerListResult]Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ServerListResult 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) -> AsyncIterable[ServerListResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ServerListResult 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\\venv197\\Lib\\site-packages\\azure\\mgmt\\rdbms\\mysql_flexibleservers\\models\\__init__.py'>