Share via

ReplicationLinksOperations Class

ReplicationLinksOperations 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

ReplicationLinksOperations(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_failover

Sets which replica database is primary by failing over from the current primary replica database.
begin_failover_allow_data_loss

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.
begin_unlink

Deletes a database replication link in forced or friendly way.
delete

Deletes a database replication link. Cannot be done during failover.
get

Gets a replication link.
list_by_database

Gets a list of replication links on database.
list_by_server

Gets a list of replication links.

begin_failover

Sets which replica database is primary by failing over from the current primary replica database.

async begin_failover(resource_group_name: str, server_name: str, database_name: str, link_id: 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.
server_name
Required
str

The name of the server.
database_name
Required
str

The name of the database that has the replication link to be failed over.
link_id
Required
str

The ID of the replication link to be failed over.

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 AsyncPollingMethod

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
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

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_allow_data_loss

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

async begin_failover_allow_data_loss(resource_group_name: str, server_name: str, database_name: str, link_id: 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.
server_name
Required
str

The name of the server.
database_name
Required
str

The name of the database that has the replication link to be failed over.
link_id
Required
str

The ID of the replication link to be failed over.

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 AsyncPollingMethod

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
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Deletes a database replication link in forced or friendly way.

async begin_unlink(resource_group_name: str, server_name: str, database_name: str, link_id: str, parameters: UnlinkParameters, **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.
server_name
Required
str

The name of the server.
database_name
Required
str

The name of the database that has the replication link to be failed over.
link_id
Required
str

The ID of the replication link to be failed over.
parameters
Required
UnlinkParameters

The required parameters for unlinking replication link.

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 AsyncPollingMethod

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
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a database replication link. Cannot be done during failover.

async delete(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> 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.
database_name
Required
str

The name of the database that has the replication link to be dropped.
link_id
Required
str

The ID of the replication link to be deleted.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a replication link.

async get(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> ReplicationLink

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

The name of the database.
link_id
Required
str

The name of the replication link.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ReplicationLink

ReplicationLink, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_database

Gets a list of replication links on database.

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) -> AsyncIterable[ReplicationLinkListResult]

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

The name of the database.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[ReplicationLinkListResult]

An iterator like instance of either ReplicationLinkListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_server

Gets a list of replication links.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncIterable[ReplicationLinkListResult]

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.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[ReplicationLinkListResult]

An iterator like instance of either ReplicationLinkListResult 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\\venv223\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>