Share via

FailoverGroupsOperations Class

  • Reference

FailoverGroupsOperations 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
FailoverGroupsOperations

Constructor

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

begin_create_or_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: '_models.FailoverGroup', **kwargs: Any) -> LROPoller['_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.
server_name
Required
str

The name of the server containing the failover group.
failover_group_name
Required
str

The name of the failover group.
parameters
Required
FailoverGroup

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[FailoverGroup]

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a failover group.

begin_delete(resource_group_name: str, server_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.
server_name
Required
str

The name of the server containing the failover group.
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 server to this server.

begin_failover(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> LROPoller['_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.
server_name
Required
str

The name of the server containing the failover group.
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[FailoverGroup]

An instance of LROPoller 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.

begin_force_failover_allow_data_loss(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> LROPoller['_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.
server_name
Required
str

The name of the server containing the failover group.
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[FailoverGroup]

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates a failover group.

begin_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: '_models.FailoverGroupUpdate', **kwargs: Any) -> LROPoller['_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.
server_name
Required
str

The name of the server containing the failover group.
failover_group_name
Required
str

The name of the failover group.
parameters
Required
FailoverGroupUpdate

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[FailoverGroup]

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a failover group.

get(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) -> _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.
server_name
Required
str

The name of the server containing the failover group.
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
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) -> Iterable['_models.FailoverGroupListResult']

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.
server_name
Required
str

The name of the server containing 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
ItemPaged[FailoverGroupListResult]

An iterator like instance of either FailoverGroupListResult 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'>