InstanceFailoverGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:instance_failover_groups> attribute.

Constructor

InstanceFailoverGroupsOperations(*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 managed instance to this managed instance.
begin_force_failover_allow_data_loss	Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
get	Gets a failover group.
list_by_location	Lists the failover groups in a location.

begin_create_or_update

Creates or updates a failover group.

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

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.
location_name Required	str The name of the region where the resource is located. Required.
failover_group_name Required	str The name of the failover group. Required.
parameters Required	InstanceFailoverGroup or IO[bytes] The failover group parameters. Is either a InstanceFailoverGroup type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a failover group.

async begin_delete(resource_group_name: str, location_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.
location_name Required	str The name of the region where the resource is located. 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 managed instance to this managed instance.

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

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.
location_name Required	str The name of the region where the resource is located. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_force_failover_allow_data_loss

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

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

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.
location_name Required	str The name of the region where the resource is located. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a failover group.

async get(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) -> InstanceFailoverGroup

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.
location_name Required	str The name of the region where the resource is located. Required.
failover_group_name Required	str The name of the failover group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_location

Lists the failover groups in a location.

list_by_location(resource_group_name: str, location_name: str, **kwargs: Any) -> AsyncItemPaged[InstanceFailoverGroup]

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.
location_name Required	str The name of the region where the resource is located. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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