ReplicationLinks interface

Package:

@azure/arm-sql

Interface representing a ReplicationLinks.

Methods

beginDelete(string, string, string, string, ReplicationLinksDeleteOptionalParams)	Deletes the replication link.
beginDeleteAndWait(string, string, string, string, ReplicationLinksDeleteOptionalParams)	Deletes the replication link.
beginFailover(string, string, string, string, ReplicationLinksFailoverOptionalParams)	Fails over from the current primary server to this server.
beginFailoverAllowDataLoss(string, string, string, string, ReplicationLinksFailoverAllowDataLossOptionalParams)	Fails over from the current primary server to this server allowing data loss.
beginFailoverAllowDataLossAndWait(string, string, string, string, ReplicationLinksFailoverAllowDataLossOptionalParams)	Fails over from the current primary server to this server allowing data loss.
beginFailoverAndWait(string, string, string, string, ReplicationLinksFailoverOptionalParams)	Fails over from the current primary server to this server.
get(string, string, string, string, ReplicationLinksGetOptionalParams)	Gets a replication link.
listByDatabase(string, string, string, ReplicationLinksListByDatabaseOptionalParams)	Gets a list of replication links on database.
listByServer(string, string, ReplicationLinksListByServerOptionalParams)	Gets a list of replication links.

Method Details

beginDelete(string, string, string, string, ReplicationLinksDeleteOptionalParams)

Deletes the replication link.

function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

options

ReplicationLinksDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, ReplicationLinksDeleteOptionalParams)

Deletes the replication link.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

options

ReplicationLinksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, string, string, ReplicationLinksFailoverOptionalParams)

Fails over from the current primary server to this server.

function beginFailover(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksFailoverOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationLink>, ReplicationLink>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

The name of the replication link.

options

ReplicationLinksFailoverOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationLink>, ReplicationLink>>

beginFailoverAllowDataLoss(string, string, string, string, ReplicationLinksFailoverAllowDataLossOptionalParams)

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

function beginFailoverAllowDataLoss(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksFailoverAllowDataLossOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationLink>, ReplicationLink>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

The name of the replication link.

options

ReplicationLinksFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationLink>, ReplicationLink>>

beginFailoverAllowDataLossAndWait(string, string, string, string, ReplicationLinksFailoverAllowDataLossOptionalParams)

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

function beginFailoverAllowDataLossAndWait(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksFailoverAllowDataLossOptionalParams): Promise<ReplicationLink>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

The name of the replication link.

options

ReplicationLinksFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<ReplicationLink>

beginFailoverAndWait(string, string, string, string, ReplicationLinksFailoverOptionalParams)

Fails over from the current primary server to this server.

function beginFailoverAndWait(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksFailoverOptionalParams): Promise<ReplicationLink>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

The name of the replication link.

options

ReplicationLinksFailoverOptionalParams

The options parameters.

Returns

Promise<ReplicationLink>

get(string, string, string, string, ReplicationLinksGetOptionalParams)

Gets a replication link.

function get(resourceGroupName: string, serverName: string, databaseName: string, linkId: string, options?: ReplicationLinksGetOptionalParams): Promise<ReplicationLink>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

linkId

string

The name of the replication link.

options

ReplicationLinksGetOptionalParams

The options parameters.

Returns

Promise<ReplicationLink>

listByDatabase(string, string, string, ReplicationLinksListByDatabaseOptionalParams)

Gets a list of replication links on database.

function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: ReplicationLinksListByDatabaseOptionalParams): PagedAsyncIterableIterator<ReplicationLink, ReplicationLink[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

options

ReplicationLinksListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ReplicationLink, ReplicationLink[], PageSettings>

listByServer(string, string, ReplicationLinksListByServerOptionalParams)

Gets a list of replication links.

function listByServer(resourceGroupName: string, serverName: string, options?: ReplicationLinksListByServerOptionalParams): PagedAsyncIterableIterator<ReplicationLink, ReplicationLink[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ReplicationLinksListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ReplicationLink, ReplicationLink[], PageSettings>