InstanceFailoverGroupsOperations Class

InstanceFailoverGroupsOperations 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.

Inheritance

builtins.object

InstanceFailoverGroupsOperations

Constructor

InstanceFailoverGroupsOperations(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_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.

begin_create_or_update(resource_group_name: str, location_name: str, failover_group_name: str, parameters: '_models.InstanceFailoverGroup', **kwargs: Any) -> LROPoller['_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.
location_name Required	str The name of the region where the resource is located.
failover_group_name Required	str The name of the failover group.
parameters Required	InstanceFailoverGroup The failover group parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a failover group.

begin_delete(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) -> LROPoller[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.
location_name Required	str The name of the region where the resource is located.
failover_group_name Required	str The name of the failover group.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller 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.

begin_failover(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) -> LROPoller['_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.
location_name Required	str The name of the region where the resource is located.
failover_group_name Required	str The name of the failover group.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[InstanceFailoverGroup]	An instance of LROPoller 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.

begin_force_failover_allow_data_loss(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) -> LROPoller['_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.
location_name Required	str The name of the region where the resource is located.
failover_group_name Required	str The name of the failover group.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a failover group.

get(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) -> _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.
location_name Required	str The name of the region where the resource is located.
failover_group_name Required	str The name of the failover group.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable['_models.InstanceFailoverGroupListResult']

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>