ReplicationLinksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:replication_links> attribute.

Constructor

ReplicationLinksOperations(*args, **kwargs)

Methods

begin_create_or_update	Updates the replication link type.
begin_delete	Deletes the replication link.
begin_failover	Fails over from the current primary server to this server.
begin_failover_allow_data_loss	Fails over from the current primary server to this server allowing data loss.
begin_update	Updates the replication link type.
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_create_or_update

Updates the replication link type.

async begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, link_id: str, parameters: _models.ReplicationLink, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str Required.
parameters Required	ReplicationLink or IO[bytes] Is either a ReplicationLink type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the replication link.

async begin_delete(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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str 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, database_name: str, link_id: str, **kwargs: Any) -> AsyncLROPoller[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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str The name of the replication link. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_failover_allow_data_loss

Fails over from the current primary server to this server allowing data loss.

async begin_failover_allow_data_loss(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> AsyncLROPoller[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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str The name of the replication link. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Updates the replication link type.

async begin_update(resource_group_name: str, server_name: str, database_name: str, link_id: str, parameters: _models.ReplicationLinkUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str Required.
parameters Required	ReplicationLinkUpdate or IO[bytes] Is either a ReplicationLinkUpdate type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ReplicationLink]	An instance of AsyncLROPoller that returns either ReplicationLink 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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
link_id Required	str The name of the replication link. Required.

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) -> AsyncItemPaged[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. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.

Returns

Type	Description
AsyncItemPaged[ReplicationLink]	An iterator like instance of either ReplicationLink 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) -> AsyncItemPaged[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. Required.
server_name Required	str The name of the server. Required.

Returns

Type	Description
AsyncItemPaged[ReplicationLink]	An iterator like instance of either ReplicationLink 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'>