replication_links

Creates, updates, deletes, gets or lists a replication_links resource.

Overview

Name	replication_links
Type	Resource
Id	azure.sql.replication_links

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified replication link.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved the list of replication links.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of replication links.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Gets a replication link.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets a list of replication links on database.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of replication links.
create_or_update	insert	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Updates the replication link type.
update	update	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Updates the replication link type.
delete	delete	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Deletes the replication link.
failover	exec	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Fails over from the current primary server to this server.
failover_allow_data_loss	exec	resourceGroupName, serverName, databaseName, linkId, subscriptionId		Fails over from the current primary server to this server allowing data loss.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
databaseName	string	The name of the database.
linkId	string	The name of the replication link.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a replication link.

SELECT
properties
FROM azure.sql.replication_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND linkId = '{{ linkId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets a list of replication links on database.

SELECT
properties
FROM azure.sql.replication_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Gets a list of replication links.

SELECT
properties
FROM azure.sql.replication_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Updates the replication link type.

INSERT INTO azure.sql.replication_links (
data__properties,
resourceGroupName,
serverName,
databaseName,
linkId,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ linkId }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: replication_links
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_links resource.
    - name: serverName
      value: string
      description: Required parameter for the replication_links resource.
    - name: databaseName
      value: string
      description: Required parameter for the replication_links resource.
    - name: linkId
      value: string
      description: Required parameter for the replication_links resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_links resource.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates the replication link type.

UPDATE azure.sql.replication_links
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND linkId = '{{ linkId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the replication link.

DELETE FROM azure.sql.replication_links
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND linkId = '{{ linkId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

failover

Fails over from the current primary server to this server.

EXEC azure.sql.replication_links.failover 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@linkId='{{ linkId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

failover_allow_data_loss

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

EXEC azure.sql.replication_links.failover_allow_data_loss 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@linkId='{{ linkId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;