FailoverGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:failover_groups> attribute.

Constructor

FailoverGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a failover group.
begin_delete	Deletes a failover group.
begin_failover	Fails over from the current primary server to this server.
begin_force_failover_allow_data_loss	Fails over from the current primary server to this server. This operation might result in data loss.
begin_try_planned_before_forced_failover	Fails over from the current primary server to this server. This operation tries planned before forced failover but might still result in data loss.
begin_update	Updates a failover group.
get	Gets a failover group.
list_by_server	Lists the failover groups in a server.

begin_create_or_update

Creates or updates a failover group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. Required.
parameters Required	FailoverGroup or IO[bytes] The failover group parameters. Is either a FailoverGroup type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[FailoverGroup]	An instance of AsyncLROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a failover group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. 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_failover

Fails over from the current primary server to this server.

async begin_failover(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> AsyncLROPoller[FailoverGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

Type	Description
AsyncLROPoller[FailoverGroup]	An instance of AsyncLROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_force_failover_allow_data_loss

Fails over from the current primary server to this server. This operation might result in data loss.

async begin_force_failover_allow_data_loss(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> AsyncLROPoller[FailoverGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

Type	Description
AsyncLROPoller[FailoverGroup]	An instance of AsyncLROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_try_planned_before_forced_failover

Fails over from the current primary server to this server. This operation tries planned before forced failover but might still result in data loss.

async begin_try_planned_before_forced_failover(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> AsyncLROPoller[FailoverGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

Type	Description
AsyncLROPoller[FailoverGroup]	An instance of AsyncLROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a failover group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. Required.
parameters Required	FailoverGroupUpdate or IO[bytes] The failover group parameters. Is either a FailoverGroupUpdate type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[FailoverGroup]	An instance of AsyncLROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a failover group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

Type	Description
FailoverGroup	FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Lists the failover groups in a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[FailoverGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server containing the failover group. Required.

Returns

Type	Description
AsyncItemPaged[FailoverGroup]	An iterator like instance of either FailoverGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>