Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. ReplicationLink
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.ReplicationLink

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

A replication link.

Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01-preview.

Other available API versions: 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var replicationLink = new AzureNative.Sql.ReplicationLink("replicationLink", new()
    {
        DatabaseName = "gamma-db",
        LinkId = "00000000-1111-2222-3333-666666666666",
        LinkType = AzureNative.Sql.ReplicationLinkType.STANDBY,
        ResourceGroupName = "Default",
        ServerName = "sourcesvr",
    });

});
Copy
package main

import (
	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewReplicationLink(ctx, "replicationLink", &sql.ReplicationLinkArgs{
			DatabaseName:      pulumi.String("gamma-db"),
			LinkId:            pulumi.String("00000000-1111-2222-3333-666666666666"),
			LinkType:          pulumi.String(sql.ReplicationLinkTypeSTANDBY),
			ResourceGroupName: pulumi.String("Default"),
			ServerName:        pulumi.String("sourcesvr"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.ReplicationLink;
import com.pulumi.azurenative.sql.ReplicationLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var replicationLink = new ReplicationLink("replicationLink", ReplicationLinkArgs.builder()
            .databaseName("gamma-db")
            .linkId("00000000-1111-2222-3333-666666666666")
            .linkType("STANDBY")
            .resourceGroupName("Default")
            .serverName("sourcesvr")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const replicationLink = new azure_native.sql.ReplicationLink("replicationLink", {
    databaseName: "gamma-db",
    linkId: "00000000-1111-2222-3333-666666666666",
    linkType: azure_native.sql.ReplicationLinkType.STANDBY,
    resourceGroupName: "Default",
    serverName: "sourcesvr",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

replication_link = azure_native.sql.ReplicationLink("replicationLink",
    database_name="gamma-db",
    link_id="00000000-1111-2222-3333-666666666666",
    link_type=azure_native.sql.ReplicationLinkType.STANDBY,
    resource_group_name="Default",
    server_name="sourcesvr")
Copy
resources:
  replicationLink:
    type: azure-native:sql:ReplicationLink
    properties:
      databaseName: gamma-db
      linkId: 00000000-1111-2222-3333-666666666666
      linkType: STANDBY
      resourceGroupName: Default
      serverName: sourcesvr
Copy

Create ReplicationLink Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ReplicationLink(name: string, args: ReplicationLinkArgs, opts?: CustomResourceOptions);
@overload
def ReplicationLink(resource_name: str,
                    args: ReplicationLinkArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ReplicationLink(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    database_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    server_name: Optional[str] = None,
                    link_id: Optional[str] = None,
                    link_type: Optional[Union[str, ReplicationLinkType]] = None)
func NewReplicationLink(ctx *Context, name string, args ReplicationLinkArgs, opts ...ResourceOption) (*ReplicationLink, error)
public ReplicationLink(string name, ReplicationLinkArgs args, CustomResourceOptions? opts = null)
public ReplicationLink(String name, ReplicationLinkArgs args)
public ReplicationLink(String name, ReplicationLinkArgs args, CustomResourceOptions options)

type: azure-native:sql:ReplicationLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReplicationLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ReplicationLinkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ReplicationLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReplicationLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReplicationLinkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var replicationLinkResource = new AzureNative.Sql.ReplicationLink("replicationLinkResource", new()
{
    DatabaseName = "string",
    ResourceGroupName = "string",
    ServerName = "string",
    LinkId = "string",
    LinkType = "string",
});
Copy
example, err := sql.NewReplicationLink(ctx, "replicationLinkResource", &sql.ReplicationLinkArgs{
	DatabaseName:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServerName:        pulumi.String("string"),
	LinkId:            pulumi.String("string"),
	LinkType:          pulumi.String("string"),
})
Copy
var replicationLinkResource = new ReplicationLink("replicationLinkResource", ReplicationLinkArgs.builder()
    .databaseName("string")
    .resourceGroupName("string")
    .serverName("string")
    .linkId("string")
    .linkType("string")
    .build());
Copy
replication_link_resource = azure_native.sql.ReplicationLink("replicationLinkResource",
    database_name="string",
    resource_group_name="string",
    server_name="string",
    link_id="string",
    link_type="string")
Copy
const replicationLinkResource = new azure_native.sql.ReplicationLink("replicationLinkResource", {
    databaseName: "string",
    resourceGroupName: "string",
    serverName: "string",
    linkId: "string",
    linkType: "string",
});
Copy
type: azure-native:sql:ReplicationLink
properties:
    databaseName: string
    linkId: string
    linkType: string
    resourceGroupName: string
    serverName: string
Copy

ReplicationLink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ReplicationLink resource accepts the following input properties:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
LinkId Changes to this property will trigger replacement. string
LinkType string | Pulumi.AzureNative.Sql.ReplicationLinkType
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
LinkId Changes to this property will trigger replacement. string
LinkType string | ReplicationLinkType
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
linkId Changes to this property will trigger replacement. String
linkType String | ReplicationLinkType
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
linkId Changes to this property will trigger replacement. string
linkType string | ReplicationLinkType
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
link_id Changes to this property will trigger replacement. str
link_type str | ReplicationLinkType
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
linkId Changes to this property will trigger replacement. String
linkType String | "GEO" | "NAMED" | "STANDBY"
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.

Outputs

All input properties are implicitly available as output properties. Additionally, the ReplicationLink resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsTerminationAllowed bool
Whether the user is currently allowed to terminate the link.
Name string
Resource name.
PartnerDatabase string
Resource partner database.
PartnerDatabaseId string
Resource partner database Id.
PartnerLocation string
Resource partner location.
PartnerRole string
Partner replication role.
PartnerServer string
Resource partner server.
PercentComplete int
Seeding completion percentage for the link.
ReplicationMode string
Replication mode.
ReplicationState string
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
Role string
Local replication role.
StartTime string
Time at which the link was created.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsTerminationAllowed bool
Whether the user is currently allowed to terminate the link.
Name string
Resource name.
PartnerDatabase string
Resource partner database.
PartnerDatabaseId string
Resource partner database Id.
PartnerLocation string
Resource partner location.
PartnerRole string
Partner replication role.
PartnerServer string
Resource partner server.
PercentComplete int
Seeding completion percentage for the link.
ReplicationMode string
Replication mode.
ReplicationState string
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
Role string
Local replication role.
StartTime string
Time at which the link was created.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isTerminationAllowed Boolean
Whether the user is currently allowed to terminate the link.
name String
Resource name.
partnerDatabase String
Resource partner database.
partnerDatabaseId String
Resource partner database Id.
partnerLocation String
Resource partner location.
partnerRole String
Partner replication role.
partnerServer String
Resource partner server.
percentComplete Integer
Seeding completion percentage for the link.
replicationMode String
Replication mode.
replicationState String
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
role String
Local replication role.
startTime String
Time at which the link was created.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
isTerminationAllowed boolean
Whether the user is currently allowed to terminate the link.
name string
Resource name.
partnerDatabase string
Resource partner database.
partnerDatabaseId string
Resource partner database Id.
partnerLocation string
Resource partner location.
partnerRole string
Partner replication role.
partnerServer string
Resource partner server.
percentComplete number
Seeding completion percentage for the link.
replicationMode string
Replication mode.
replicationState string
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
role string
Local replication role.
startTime string
Time at which the link was created.
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
is_termination_allowed bool
Whether the user is currently allowed to terminate the link.
name str
Resource name.
partner_database str
Resource partner database.
partner_database_id str
Resource partner database Id.
partner_location str
Resource partner location.
partner_role str
Partner replication role.
partner_server str
Resource partner server.
percent_complete int
Seeding completion percentage for the link.
replication_mode str
Replication mode.
replication_state str
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
role str
Local replication role.
start_time str
Time at which the link was created.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isTerminationAllowed Boolean
Whether the user is currently allowed to terminate the link.
name String
Resource name.
partnerDatabase String
Resource partner database.
partnerDatabaseId String
Resource partner database Id.
partnerLocation String
Resource partner location.
partnerRole String
Partner replication role.
partnerServer String
Resource partner server.
percentComplete Number
Seeding completion percentage for the link.
replicationMode String
Replication mode.
replicationState String
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
role String
Local replication role.
startTime String
Time at which the link was created.
type String
Resource type.

Supporting Types

ReplicationLinkType
, ReplicationLinkTypeArgs

GEO
GEO
NAMED
NAMED
STANDBY
STANDBY
ReplicationLinkTypeGEO
GEO
ReplicationLinkTypeNAMED
NAMED
ReplicationLinkTypeSTANDBY
STANDBY
GEO
GEO
NAMED
NAMED
STANDBY
STANDBY
GEO
GEO
NAMED
NAMED
STANDBY
STANDBY
GEO
GEO
NAMED
NAMED
STANDBY
STANDBY
"GEO"
GEO
"NAMED"
NAMED
"STANDBY"
STANDBY

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:sql:ReplicationLink 00000000-1111-2222-3333-666666666666 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native