Docs Packages
  1. Pulumi Registry
  2. Azure Native
  3. API Docs
  4. sql
  5. SyncMember
azure-native logo
Azure Native v1.102.0, May 2 23

azure-native.sql.SyncMember

Explore with Pulumi AI

An Azure SQL Database sync member. API Version: 2020-11-01-preview.

Example Usage

Create a new sync member

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

return await Deployment.RunAsync(() => 
{
    var syncMember = new AzureNative.Sql.SyncMember("syncMember", new()
    {
        DatabaseName = "syncgroupcrud-4328",
        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",
    });

});

package main

import (
	sql "github.com/pulumi/pulumi-azure-native/sdk/go/azure/sql"
	"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-4328"),
			DatabaseType:                      pulumi.String("AzureSqlDatabase"),
			ResourceGroupName:                 pulumi.String("syncgroupcrud-65440"),
			ServerName:                        pulumi.String("syncgroupcrud-8475"),
			SyncDirection:                     pulumi.String("Bidirectional"),
			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
	})
}

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-4328")
            .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());

    }
}

import pulumi
import pulumi_azure_native as azure_native

sync_member = azure_native.sql.SyncMember("syncMember",
    database_name="syncgroupcrud-4328",
    database_type="AzureSqlDatabase",
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_direction="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")

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

const syncMember = new azure_native.sql.SyncMember("syncMember", {
    databaseName: "syncgroupcrud-4328",
    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",
});

resources:
  syncMember:
    type: azure-native:sql:SyncMember
    properties:
      databaseName: syncgroupcrud-4328
      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

Update a sync member

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

return await Deployment.RunAsync(() => 
{
    var syncMember = new AzureNative.Sql.SyncMember("syncMember", new()
    {
        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",
    });

});

package main

import (
	sql "github.com/pulumi/pulumi-azure-native/sdk/go/azure/sql"
	"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("AzureSqlDatabase"),
			ResourceGroupName:                 pulumi.String("syncgroupcrud-65440"),
			ServerName:                        pulumi.String("syncgroupcrud-8475"),
			SyncDirection:                     pulumi.String("Bidirectional"),
			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
	})
}

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());

    }
}

import pulumi
import pulumi_azure_native as azure_native

sync_member = azure_native.sql.SyncMember("syncMember",
    database_name="syncgroupcrud-7421",
    database_type="AzureSqlDatabase",
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_direction="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")

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: "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",
});

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

Create SyncMember Resource

new SyncMember(name: string, args: SyncMemberArgs, opts?: CustomResourceOptions);
@overload
def SyncMember(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               database_name: Optional[str] = None,
               database_type: Optional[Union[str, SyncMemberDbType]] = None,
               password: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               server_name: Optional[str] = None,
               sql_server_database_id: Optional[str] = None,
               sync_agent_id: Optional[str] = None,
               sync_direction: Optional[Union[str, SyncDirection]] = None,
               sync_group_name: Optional[str] = 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)
@overload
def SyncMember(resource_name: str,
               args: SyncMemberArgs,
               opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args SyncMemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args SyncMemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SyncMemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SyncMemberArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The SyncMember resource accepts the following input properties:

DatabaseName string

Database name of the member database in the sync member.

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

Server name of the member database in the sync member

SyncGroupName 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 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 string

Database name of the member database in the sync member.

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

Server name of the member database in the sync member

SyncGroupName 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 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 String

Database name of the member database in the sync member.

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

Server name of the member database in the sync member

syncGroupName 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 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 string

Database name of the member database in the sync member.

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

Server name of the member database in the sync member

syncGroupName 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 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 str

Database name of the member database in the sync member.

resource_group_name 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 str

Server name of the member database in the sync member

sync_group_name 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 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 String

Database name of the member database in the sync member.

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

Server name of the member database in the sync member

syncGroupName 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 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:

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.

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.

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.

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.

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.

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

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

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/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0