Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. SyncMember
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.SyncMember

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure SQL Database sync member.

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

Other available API versions: 2015-05-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 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

Create a new sync member

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

return await Deployment.RunAsync(() => 
{
    var syncMember = new AzureNative.Sql.SyncMember("syncMember", new()
    {
        DatabaseName = "syncgroupcrud-7421",
        DatabaseType = AzureNative.Sql.SyncMemberDbType.AzureSqlDatabase,
        ResourceGroupName = "syncgroupcrud-65440",
        ServerName = "syncgroupcrud-8475",
        SyncDirection = AzureNative.Sql.SyncDirection.Bidirectional,
        SyncGroupName = "syncgroupcrud-3187",
        SyncMemberAzureDatabaseResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        SyncMemberName = "syncmembercrud-4879",
        UsePrivateLinkConnection = true,
        UserName = "myUser",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewSyncMember(ctx, "syncMember", &sql.SyncMemberArgs{
			DatabaseName:                      pulumi.String("syncgroupcrud-7421"),
			DatabaseType:                      pulumi.String(sql.SyncMemberDbTypeAzureSqlDatabase),
			ResourceGroupName:                 pulumi.String("syncgroupcrud-65440"),
			ServerName:                        pulumi.String("syncgroupcrud-8475"),
			SyncDirection:                     pulumi.String(sql.SyncDirectionBidirectional),
			SyncGroupName:                     pulumi.String("syncgroupcrud-3187"),
			SyncMemberAzureDatabaseResourceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
			SyncMemberName:                    pulumi.String("syncmembercrud-4879"),
			UsePrivateLinkConnection:          pulumi.Bool(true),
			UserName:                          pulumi.String("myUser"),
		})
		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.SyncMember;
import com.pulumi.azurenative.sql.SyncMemberArgs;
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 syncMember = new SyncMember("syncMember", SyncMemberArgs.builder()
            .databaseName("syncgroupcrud-7421")
            .databaseType("AzureSqlDatabase")
            .resourceGroupName("syncgroupcrud-65440")
            .serverName("syncgroupcrud-8475")
            .syncDirection("Bidirectional")
            .syncGroupName("syncgroupcrud-3187")
            .syncMemberAzureDatabaseResourceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
            .syncMemberName("syncmembercrud-4879")
            .usePrivateLinkConnection(true)
            .userName("myUser")
            .build());

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

const syncMember = new azure_native.sql.SyncMember("syncMember", {
    databaseName: "syncgroupcrud-7421",
    databaseType: azure_native.sql.SyncMemberDbType.AzureSqlDatabase,
    resourceGroupName: "syncgroupcrud-65440",
    serverName: "syncgroupcrud-8475",
    syncDirection: azure_native.sql.SyncDirection.Bidirectional,
    syncGroupName: "syncgroupcrud-3187",
    syncMemberAzureDatabaseResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    syncMemberName: "syncmembercrud-4879",
    usePrivateLinkConnection: true,
    userName: "myUser",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sync_member = azure_native.sql.SyncMember("syncMember",
    database_name="syncgroupcrud-7421",
    database_type=azure_native.sql.SyncMemberDbType.AZURE_SQL_DATABASE,
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_direction=azure_native.sql.SyncDirection.BIDIRECTIONAL,
    sync_group_name="syncgroupcrud-3187",
    sync_member_azure_database_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    sync_member_name="syncmembercrud-4879",
    use_private_link_connection=True,
    user_name="myUser")
Copy
resources:
  syncMember:
    type: azure-native:sql:SyncMember
    properties:
      databaseName: syncgroupcrud-7421
      databaseType: AzureSqlDatabase
      resourceGroupName: syncgroupcrud-65440
      serverName: syncgroupcrud-8475
      syncDirection: Bidirectional
      syncGroupName: syncgroupcrud-3187
      syncMemberAzureDatabaseResourceId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328
      syncMemberName: syncmembercrud-4879
      usePrivateLinkConnection: true
      userName: myUser
Copy

Update a sync member

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

return await Deployment.RunAsync(() => 
{
    var syncMember = new AzureNative.Sql.SyncMember("syncMember", new()
    {
        DatabaseName = "syncgroupcrud-7421",
        DatabaseType = AzureNative.Sql.SyncMemberDbType.AzureSqlDatabase,
        ResourceGroupName = "syncgroupcrud-65440",
        ServerName = "syncgroupcrud-8475",
        SyncDirection = AzureNative.Sql.SyncDirection.Bidirectional,
        SyncGroupName = "syncgroupcrud-3187",
        SyncMemberAzureDatabaseResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        SyncMemberName = "syncmembercrud-4879",
        UsePrivateLinkConnection = true,
        UserName = "myUser",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewSyncMember(ctx, "syncMember", &sql.SyncMemberArgs{
			DatabaseName:                      pulumi.String("syncgroupcrud-7421"),
			DatabaseType:                      pulumi.String(sql.SyncMemberDbTypeAzureSqlDatabase),
			ResourceGroupName:                 pulumi.String("syncgroupcrud-65440"),
			ServerName:                        pulumi.String("syncgroupcrud-8475"),
			SyncDirection:                     pulumi.String(sql.SyncDirectionBidirectional),
			SyncGroupName:                     pulumi.String("syncgroupcrud-3187"),
			SyncMemberAzureDatabaseResourceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
			SyncMemberName:                    pulumi.String("syncmembercrud-4879"),
			UsePrivateLinkConnection:          pulumi.Bool(true),
			UserName:                          pulumi.String("myUser"),
		})
		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.SyncMember;
import com.pulumi.azurenative.sql.SyncMemberArgs;
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 syncMember = new SyncMember("syncMember", SyncMemberArgs.builder()
            .databaseName("syncgroupcrud-7421")
            .databaseType("AzureSqlDatabase")
            .resourceGroupName("syncgroupcrud-65440")
            .serverName("syncgroupcrud-8475")
            .syncDirection("Bidirectional")
            .syncGroupName("syncgroupcrud-3187")
            .syncMemberAzureDatabaseResourceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
            .syncMemberName("syncmembercrud-4879")
            .usePrivateLinkConnection(true)
            .userName("myUser")
            .build());

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

const syncMember = new azure_native.sql.SyncMember("syncMember", {
    databaseName: "syncgroupcrud-7421",
    databaseType: azure_native.sql.SyncMemberDbType.AzureSqlDatabase,
    resourceGroupName: "syncgroupcrud-65440",
    serverName: "syncgroupcrud-8475",
    syncDirection: azure_native.sql.SyncDirection.Bidirectional,
    syncGroupName: "syncgroupcrud-3187",
    syncMemberAzureDatabaseResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    syncMemberName: "syncmembercrud-4879",
    usePrivateLinkConnection: true,
    userName: "myUser",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sync_member = azure_native.sql.SyncMember("syncMember",
    database_name="syncgroupcrud-7421",
    database_type=azure_native.sql.SyncMemberDbType.AZURE_SQL_DATABASE,
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_direction=azure_native.sql.SyncDirection.BIDIRECTIONAL,
    sync_group_name="syncgroupcrud-3187",
    sync_member_azure_database_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    sync_member_name="syncmembercrud-4879",
    use_private_link_connection=True,
    user_name="myUser")
Copy
resources:
  syncMember:
    type: azure-native:sql:SyncMember
    properties:
      databaseName: syncgroupcrud-7421
      databaseType: AzureSqlDatabase
      resourceGroupName: syncgroupcrud-65440
      serverName: syncgroupcrud-8475
      syncDirection: Bidirectional
      syncGroupName: syncgroupcrud-3187
      syncMemberAzureDatabaseResourceId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328
      syncMemberName: syncmembercrud-4879
      usePrivateLinkConnection: true
      userName: myUser
Copy

Create SyncMember Resource

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

Constructor syntax

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

@overload
def SyncMember(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               server_name: Optional[str] = None,
               sync_group_name: Optional[str] = None,
               database_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               sync_agent_id: Optional[str] = None,
               sql_server_database_id: Optional[str] = None,
               password: Optional[str] = None,
               sync_direction: Optional[Union[str, SyncDirection]] = None,
               database_type: Optional[Union[str, SyncMemberDbType]] = None,
               sync_member_azure_database_resource_id: Optional[str] = None,
               sync_member_name: Optional[str] = None,
               use_private_link_connection: Optional[bool] = None,
               user_name: Optional[str] = None)
func NewSyncMember(ctx *Context, name string, args SyncMemberArgs, opts ...ResourceOption) (*SyncMember, error)
public SyncMember(string name, SyncMemberArgs args, CustomResourceOptions? opts = null)
public SyncMember(String name, SyncMemberArgs args)
public SyncMember(String name, SyncMemberArgs args, CustomResourceOptions options)

type: azure-native:sql:SyncMember
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. SyncMemberArgs
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. SyncMemberArgs
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. SyncMemberArgs
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. SyncMemberArgs
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. SyncMemberArgs
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 syncMemberResource = new AzureNative.Sql.SyncMember("syncMemberResource", new()
{
    ServerName = "string",
    SyncGroupName = "string",
    DatabaseName = "string",
    ResourceGroupName = "string",
    SyncAgentId = "string",
    SqlServerDatabaseId = "string",
    Password = "string",
    SyncDirection = "string",
    DatabaseType = "string",
    SyncMemberAzureDatabaseResourceId = "string",
    SyncMemberName = "string",
    UsePrivateLinkConnection = false,
    UserName = "string",
});
Copy
example, err := sql.NewSyncMember(ctx, "syncMemberResource", &sql.SyncMemberArgs{
	ServerName:                        pulumi.String("string"),
	SyncGroupName:                     pulumi.String("string"),
	DatabaseName:                      pulumi.String("string"),
	ResourceGroupName:                 pulumi.String("string"),
	SyncAgentId:                       pulumi.String("string"),
	SqlServerDatabaseId:               pulumi.String("string"),
	Password:                          pulumi.String("string"),
	SyncDirection:                     pulumi.String("string"),
	DatabaseType:                      pulumi.String("string"),
	SyncMemberAzureDatabaseResourceId: pulumi.String("string"),
	SyncMemberName:                    pulumi.String("string"),
	UsePrivateLinkConnection:          pulumi.Bool(false),
	UserName:                          pulumi.String("string"),
})
Copy
var syncMemberResource = new SyncMember("syncMemberResource", SyncMemberArgs.builder()
    .serverName("string")
    .syncGroupName("string")
    .databaseName("string")
    .resourceGroupName("string")
    .syncAgentId("string")
    .sqlServerDatabaseId("string")
    .password("string")
    .syncDirection("string")
    .databaseType("string")
    .syncMemberAzureDatabaseResourceId("string")
    .syncMemberName("string")
    .usePrivateLinkConnection(false)
    .userName("string")
    .build());
Copy
sync_member_resource = azure_native.sql.SyncMember("syncMemberResource",
    server_name="string",
    sync_group_name="string",
    database_name="string",
    resource_group_name="string",
    sync_agent_id="string",
    sql_server_database_id="string",
    password="string",
    sync_direction="string",
    database_type="string",
    sync_member_azure_database_resource_id="string",
    sync_member_name="string",
    use_private_link_connection=False,
    user_name="string")
Copy
const syncMemberResource = new azure_native.sql.SyncMember("syncMemberResource", {
    serverName: "string",
    syncGroupName: "string",
    databaseName: "string",
    resourceGroupName: "string",
    syncAgentId: "string",
    sqlServerDatabaseId: "string",
    password: "string",
    syncDirection: "string",
    databaseType: "string",
    syncMemberAzureDatabaseResourceId: "string",
    syncMemberName: "string",
    usePrivateLinkConnection: false,
    userName: "string",
});
Copy
type: azure-native:sql:SyncMember
properties:
    databaseName: string
    databaseType: string
    password: string
    resourceGroupName: string
    serverName: string
    sqlServerDatabaseId: string
    syncAgentId: string
    syncDirection: string
    syncGroupName: string
    syncMemberAzureDatabaseResourceId: string
    syncMemberName: string
    usePrivateLinkConnection: false
    userName: string
Copy

SyncMember 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 SyncMember resource accepts the following input properties:

DatabaseName This property is required. string
Database name of the member database in the sync member.
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. string
Server name of the member database in the sync member
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group on which the sync member is hosted.
DatabaseType string | Pulumi.AzureNative.Sql.SyncMemberDbType
Database type of the sync member.
Password string
Password of the member database in the sync member.
SqlServerDatabaseId string
SQL Server database id of the sync member.
SyncAgentId string
ARM resource id of the sync agent in the sync member.
SyncDirection string | Pulumi.AzureNative.Sql.SyncDirection
Sync direction of the sync member.
SyncMemberAzureDatabaseResourceId string
ARM resource id of the sync member logical database, for sync members in Azure.
SyncMemberName Changes to this property will trigger replacement. string
The name of the sync member.
UsePrivateLinkConnection bool
Whether to use private link connection.
UserName string
User name of the member database in the sync member.
DatabaseName This property is required. string
Database name of the member database in the sync member.
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. string
Server name of the member database in the sync member
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group on which the sync member is hosted.
DatabaseType string | SyncMemberDbType
Database type of the sync member.
Password string
Password of the member database in the sync member.
SqlServerDatabaseId string
SQL Server database id of the sync member.
SyncAgentId string
ARM resource id of the sync agent in the sync member.
SyncDirection string | SyncDirection
Sync direction of the sync member.
SyncMemberAzureDatabaseResourceId string
ARM resource id of the sync member logical database, for sync members in Azure.
SyncMemberName Changes to this property will trigger replacement. string
The name of the sync member.
UsePrivateLinkConnection bool
Whether to use private link connection.
UserName string
User name of the member database in the sync member.
databaseName This property is required. String
Database name of the member database in the sync member.
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. String
Server name of the member database in the sync member
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync group on which the sync member is hosted.
databaseType String | SyncMemberDbType
Database type of the sync member.
password String
Password of the member database in the sync member.
sqlServerDatabaseId String
SQL Server database id of the sync member.
syncAgentId String
ARM resource id of the sync agent in the sync member.
syncDirection String | SyncDirection
Sync direction of the sync member.
syncMemberAzureDatabaseResourceId String
ARM resource id of the sync member logical database, for sync members in Azure.
syncMemberName Changes to this property will trigger replacement. String
The name of the sync member.
usePrivateLinkConnection Boolean
Whether to use private link connection.
userName String
User name of the member database in the sync member.
databaseName This property is required. string
Database name of the member database in the sync member.
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. string
Server name of the member database in the sync member
syncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group on which the sync member is hosted.
databaseType string | SyncMemberDbType
Database type of the sync member.
password string
Password of the member database in the sync member.
sqlServerDatabaseId string
SQL Server database id of the sync member.
syncAgentId string
ARM resource id of the sync agent in the sync member.
syncDirection string | SyncDirection
Sync direction of the sync member.
syncMemberAzureDatabaseResourceId string
ARM resource id of the sync member logical database, for sync members in Azure.
syncMemberName Changes to this property will trigger replacement. string
The name of the sync member.
usePrivateLinkConnection boolean
Whether to use private link connection.
userName string
User name of the member database in the sync member.
database_name This property is required. str
Database name of the member database in the sync member.
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. str
Server name of the member database in the sync member
sync_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the sync group on which the sync member is hosted.
database_type str | SyncMemberDbType
Database type of the sync member.
password str
Password of the member database in the sync member.
sql_server_database_id str
SQL Server database id of the sync member.
sync_agent_id str
ARM resource id of the sync agent in the sync member.
sync_direction str | SyncDirection
Sync direction of the sync member.
sync_member_azure_database_resource_id str
ARM resource id of the sync member logical database, for sync members in Azure.
sync_member_name Changes to this property will trigger replacement. str
The name of the sync member.
use_private_link_connection bool
Whether to use private link connection.
user_name str
User name of the member database in the sync member.
databaseName This property is required. String
Database name of the member database in the sync member.
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. String
Server name of the member database in the sync member
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync group on which the sync member is hosted.
databaseType String | "AzureSqlDatabase" | "SqlServerDatabase"
Database type of the sync member.
password String
Password of the member database in the sync member.
sqlServerDatabaseId String
SQL Server database id of the sync member.
syncAgentId String
ARM resource id of the sync agent in the sync member.
syncDirection String | "Bidirectional" | "OneWayMemberToHub" | "OneWayHubToMember"
Sync direction of the sync member.
syncMemberAzureDatabaseResourceId String
ARM resource id of the sync member logical database, for sync members in Azure.
syncMemberName Changes to this property will trigger replacement. String
The name of the sync member.
usePrivateLinkConnection Boolean
Whether to use private link connection.
userName String
User name of the member database in the sync member.

Outputs

All input properties are implicitly available as output properties. Additionally, the SyncMember 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.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
SyncState string
Sync state of the sync member.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
SyncState string
Sync state of the sync member.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
syncState String
Sync state of the sync member.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
privateEndpointName string
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
syncState string
Sync state of the sync member.
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.
name str
Resource name.
private_endpoint_name str
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
sync_state str
Sync state of the sync member.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
syncState String
Sync state of the sync member.
type String
Resource type.

Supporting Types

SyncDirection
, SyncDirectionArgs

Bidirectional
Bidirectional
OneWayMemberToHub
OneWayMemberToHub
OneWayHubToMember
OneWayHubToMember
SyncDirectionBidirectional
Bidirectional
SyncDirectionOneWayMemberToHub
OneWayMemberToHub
SyncDirectionOneWayHubToMember
OneWayHubToMember
Bidirectional
Bidirectional
OneWayMemberToHub
OneWayMemberToHub
OneWayHubToMember
OneWayHubToMember
Bidirectional
Bidirectional
OneWayMemberToHub
OneWayMemberToHub
OneWayHubToMember
OneWayHubToMember
BIDIRECTIONAL
Bidirectional
ONE_WAY_MEMBER_TO_HUB
OneWayMemberToHub
ONE_WAY_HUB_TO_MEMBER
OneWayHubToMember
"Bidirectional"
Bidirectional
"OneWayMemberToHub"
OneWayMemberToHub
"OneWayHubToMember"
OneWayHubToMember

SyncMemberDbType
, SyncMemberDbTypeArgs

AzureSqlDatabase
AzureSqlDatabase
SqlServerDatabase
SqlServerDatabase
SyncMemberDbTypeAzureSqlDatabase
AzureSqlDatabase
SyncMemberDbTypeSqlServerDatabase
SqlServerDatabase
AzureSqlDatabase
AzureSqlDatabase
SqlServerDatabase
SqlServerDatabase
AzureSqlDatabase
AzureSqlDatabase
SqlServerDatabase
SqlServerDatabase
AZURE_SQL_DATABASE
AzureSqlDatabase
SQL_SERVER_DATABASE
SqlServerDatabase
"AzureSqlDatabase"
AzureSqlDatabase
"SqlServerDatabase"
SqlServerDatabase

Import

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

$ pulumi import azure-native:sql:SyncMember syncmembercrud-4879 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native