Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. SyncGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.SyncGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure SQL Database sync group. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2020-11-01-preview.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

Example Usage

Create a sync group

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

return await Deployment.RunAsync(() => 
{
    var syncGroup = new AzureNative.Sql.SyncGroup("syncGroup", new()
    {
        ConflictResolutionPolicy = AzureNative.Sql.SyncConflictResolutionPolicy.HubWin,
        DatabaseName = "syncgroupcrud-4328",
        HubDatabaseUserName = "hubUser",
        Interval = -1,
        ResourceGroupName = "syncgroupcrud-65440",
        ServerName = "syncgroupcrud-8475",
        SyncDatabaseId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        SyncGroupName = "syncgroupcrud-3187",
        UsePrivateLinkConnection = true,
    });

});
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.NewSyncGroup(ctx, "syncGroup", &sql.SyncGroupArgs{
			ConflictResolutionPolicy: pulumi.String(sql.SyncConflictResolutionPolicyHubWin),
			DatabaseName:             pulumi.String("syncgroupcrud-4328"),
			HubDatabaseUserName:      pulumi.String("hubUser"),
			Interval:                 pulumi.Int(-1),
			ResourceGroupName:        pulumi.String("syncgroupcrud-65440"),
			ServerName:               pulumi.String("syncgroupcrud-8475"),
			SyncDatabaseId:           pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
			SyncGroupName:            pulumi.String("syncgroupcrud-3187"),
			UsePrivateLinkConnection: pulumi.Bool(true),
		})
		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.SyncGroup;
import com.pulumi.azurenative.sql.SyncGroupArgs;
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 syncGroup = new SyncGroup("syncGroup", SyncGroupArgs.builder()
            .conflictResolutionPolicy("HubWin")
            .databaseName("syncgroupcrud-4328")
            .hubDatabaseUserName("hubUser")
            .interval(-1)
            .resourceGroupName("syncgroupcrud-65440")
            .serverName("syncgroupcrud-8475")
            .syncDatabaseId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
            .syncGroupName("syncgroupcrud-3187")
            .usePrivateLinkConnection(true)
            .build());

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

const syncGroup = new azure_native.sql.SyncGroup("syncGroup", {
    conflictResolutionPolicy: azure_native.sql.SyncConflictResolutionPolicy.HubWin,
    databaseName: "syncgroupcrud-4328",
    hubDatabaseUserName: "hubUser",
    interval: -1,
    resourceGroupName: "syncgroupcrud-65440",
    serverName: "syncgroupcrud-8475",
    syncDatabaseId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    syncGroupName: "syncgroupcrud-3187",
    usePrivateLinkConnection: true,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sync_group = azure_native.sql.SyncGroup("syncGroup",
    conflict_resolution_policy=azure_native.sql.SyncConflictResolutionPolicy.HUB_WIN,
    database_name="syncgroupcrud-4328",
    hub_database_user_name="hubUser",
    interval=-1,
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_database_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    sync_group_name="syncgroupcrud-3187",
    use_private_link_connection=True)
Copy
resources:
  syncGroup:
    type: azure-native:sql:SyncGroup
    properties:
      conflictResolutionPolicy: HubWin
      databaseName: syncgroupcrud-4328
      hubDatabaseUserName: hubUser
      interval: -1
      resourceGroupName: syncgroupcrud-65440
      serverName: syncgroupcrud-8475
      syncDatabaseId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328
      syncGroupName: syncgroupcrud-3187
      usePrivateLinkConnection: true
Copy

Update a sync group

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

return await Deployment.RunAsync(() => 
{
    var syncGroup = new AzureNative.Sql.SyncGroup("syncGroup", new()
    {
        ConflictResolutionPolicy = AzureNative.Sql.SyncConflictResolutionPolicy.HubWin,
        DatabaseName = "syncgroupcrud-4328",
        HubDatabaseUserName = "hubUser",
        Interval = -1,
        ResourceGroupName = "syncgroupcrud-65440",
        ServerName = "syncgroupcrud-8475",
        SyncDatabaseId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        SyncGroupName = "syncgroupcrud-3187",
        UsePrivateLinkConnection = true,
    });

});
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.NewSyncGroup(ctx, "syncGroup", &sql.SyncGroupArgs{
			ConflictResolutionPolicy: pulumi.String(sql.SyncConflictResolutionPolicyHubWin),
			DatabaseName:             pulumi.String("syncgroupcrud-4328"),
			HubDatabaseUserName:      pulumi.String("hubUser"),
			Interval:                 pulumi.Int(-1),
			ResourceGroupName:        pulumi.String("syncgroupcrud-65440"),
			ServerName:               pulumi.String("syncgroupcrud-8475"),
			SyncDatabaseId:           pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
			SyncGroupName:            pulumi.String("syncgroupcrud-3187"),
			UsePrivateLinkConnection: pulumi.Bool(true),
		})
		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.SyncGroup;
import com.pulumi.azurenative.sql.SyncGroupArgs;
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 syncGroup = new SyncGroup("syncGroup", SyncGroupArgs.builder()
            .conflictResolutionPolicy("HubWin")
            .databaseName("syncgroupcrud-4328")
            .hubDatabaseUserName("hubUser")
            .interval(-1)
            .resourceGroupName("syncgroupcrud-65440")
            .serverName("syncgroupcrud-8475")
            .syncDatabaseId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
            .syncGroupName("syncgroupcrud-3187")
            .usePrivateLinkConnection(true)
            .build());

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

const syncGroup = new azure_native.sql.SyncGroup("syncGroup", {
    conflictResolutionPolicy: azure_native.sql.SyncConflictResolutionPolicy.HubWin,
    databaseName: "syncgroupcrud-4328",
    hubDatabaseUserName: "hubUser",
    interval: -1,
    resourceGroupName: "syncgroupcrud-65440",
    serverName: "syncgroupcrud-8475",
    syncDatabaseId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    syncGroupName: "syncgroupcrud-3187",
    usePrivateLinkConnection: true,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sync_group = azure_native.sql.SyncGroup("syncGroup",
    conflict_resolution_policy=azure_native.sql.SyncConflictResolutionPolicy.HUB_WIN,
    database_name="syncgroupcrud-4328",
    hub_database_user_name="hubUser",
    interval=-1,
    resource_group_name="syncgroupcrud-65440",
    server_name="syncgroupcrud-8475",
    sync_database_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    sync_group_name="syncgroupcrud-3187",
    use_private_link_connection=True)
Copy
resources:
  syncGroup:
    type: azure-native:sql:SyncGroup
    properties:
      conflictResolutionPolicy: HubWin
      databaseName: syncgroupcrud-4328
      hubDatabaseUserName: hubUser
      interval: -1
      resourceGroupName: syncgroupcrud-65440
      serverName: syncgroupcrud-8475
      syncDatabaseId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328
      syncGroupName: syncgroupcrud-3187
      usePrivateLinkConnection: true
Copy

Create SyncGroup Resource

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

Constructor syntax

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

@overload
def SyncGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              server_name: Optional[str] = None,
              database_name: Optional[str] = None,
              enable_conflict_logging: Optional[bool] = None,
              hub_database_password: Optional[str] = None,
              hub_database_user_name: Optional[str] = None,
              interval: Optional[int] = None,
              conflict_logging_retention_in_days: Optional[int] = None,
              schema: Optional[SyncGroupSchemaArgs] = None,
              conflict_resolution_policy: Optional[Union[str, SyncConflictResolutionPolicy]] = None,
              sku: Optional[SkuArgs] = None,
              sync_database_id: Optional[str] = None,
              sync_group_name: Optional[str] = None,
              use_private_link_connection: Optional[bool] = None)
func NewSyncGroup(ctx *Context, name string, args SyncGroupArgs, opts ...ResourceOption) (*SyncGroup, error)
public SyncGroup(string name, SyncGroupArgs args, CustomResourceOptions? opts = null)
public SyncGroup(String name, SyncGroupArgs args)
public SyncGroup(String name, SyncGroupArgs args, CustomResourceOptions options)

type: azure-native:sql:SyncGroup
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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 syncGroupResource = new AzureNative.Sql.SyncGroup("syncGroupResource", new()
{
    ResourceGroupName = "string",
    ServerName = "string",
    DatabaseName = "string",
    EnableConflictLogging = false,
    HubDatabasePassword = "string",
    HubDatabaseUserName = "string",
    Interval = 0,
    ConflictLoggingRetentionInDays = 0,
    Schema = 
    {
        { "masterSyncMemberName", "string" },
        { "tables", new[]
        {
            
            {
                { "columns", new[]
                {
                    
                    {
                        { "dataSize", "string" },
                        { "dataType", "string" },
                        { "quotedName", "string" },
                    },
                } },
                { "quotedName", "string" },
            },
        } },
    },
    ConflictResolutionPolicy = "string",
    Sku = 
    {
        { "name", "string" },
        { "capacity", 0 },
        { "family", "string" },
        { "size", "string" },
        { "tier", "string" },
    },
    SyncDatabaseId = "string",
    SyncGroupName = "string",
    UsePrivateLinkConnection = false,
});
Copy
example, err := sql.NewSyncGroup(ctx, "syncGroupResource", &sql.SyncGroupArgs{
	ResourceGroupName:              "string",
	ServerName:                     "string",
	DatabaseName:                   "string",
	EnableConflictLogging:          false,
	HubDatabasePassword:            "string",
	HubDatabaseUserName:            "string",
	Interval:                       0,
	ConflictLoggingRetentionInDays: 0,
	Schema: map[string]interface{}{
		"masterSyncMemberName": "string",
		"tables": []map[string]interface{}{
			map[string]interface{}{
				"columns": []map[string]interface{}{
					map[string]interface{}{
						"dataSize":   "string",
						"dataType":   "string",
						"quotedName": "string",
					},
				},
				"quotedName": "string",
			},
		},
	},
	ConflictResolutionPolicy: "string",
	Sku: map[string]interface{}{
		"name":     "string",
		"capacity": 0,
		"family":   "string",
		"size":     "string",
		"tier":     "string",
	},
	SyncDatabaseId:           "string",
	SyncGroupName:            "string",
	UsePrivateLinkConnection: false,
})
Copy
var syncGroupResource = new SyncGroup("syncGroupResource", SyncGroupArgs.builder()
    .resourceGroupName("string")
    .serverName("string")
    .databaseName("string")
    .enableConflictLogging(false)
    .hubDatabasePassword("string")
    .hubDatabaseUserName("string")
    .interval(0)
    .conflictLoggingRetentionInDays(0)
    .schema(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .conflictResolutionPolicy("string")
    .sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .syncDatabaseId("string")
    .syncGroupName("string")
    .usePrivateLinkConnection(false)
    .build());
Copy
sync_group_resource = azure_native.sql.SyncGroup("syncGroupResource",
    resource_group_name=string,
    server_name=string,
    database_name=string,
    enable_conflict_logging=False,
    hub_database_password=string,
    hub_database_user_name=string,
    interval=0,
    conflict_logging_retention_in_days=0,
    schema={
        masterSyncMemberName: string,
        tables: [{
            columns: [{
                dataSize: string,
                dataType: string,
                quotedName: string,
            }],
            quotedName: string,
        }],
    },
    conflict_resolution_policy=string,
    sku={
        name: string,
        capacity: 0,
        family: string,
        size: string,
        tier: string,
    },
    sync_database_id=string,
    sync_group_name=string,
    use_private_link_connection=False)
Copy
const syncGroupResource = new azure_native.sql.SyncGroup("syncGroupResource", {
    resourceGroupName: "string",
    serverName: "string",
    databaseName: "string",
    enableConflictLogging: false,
    hubDatabasePassword: "string",
    hubDatabaseUserName: "string",
    interval: 0,
    conflictLoggingRetentionInDays: 0,
    schema: {
        masterSyncMemberName: "string",
        tables: [{
            columns: [{
                dataSize: "string",
                dataType: "string",
                quotedName: "string",
            }],
            quotedName: "string",
        }],
    },
    conflictResolutionPolicy: "string",
    sku: {
        name: "string",
        capacity: 0,
        family: "string",
        size: "string",
        tier: "string",
    },
    syncDatabaseId: "string",
    syncGroupName: "string",
    usePrivateLinkConnection: false,
});
Copy
type: azure-native:sql:SyncGroup
properties:
    conflictLoggingRetentionInDays: 0
    conflictResolutionPolicy: string
    databaseName: string
    enableConflictLogging: false
    hubDatabasePassword: string
    hubDatabaseUserName: string
    interval: 0
    resourceGroupName: string
    schema:
        masterSyncMemberName: string
        tables:
            - columns:
                - dataSize: string
                  dataType: string
                  quotedName: string
              quotedName: string
    serverName: string
    sku:
        capacity: 0
        family: string
        name: string
        size: string
        tier: string
    syncDatabaseId: string
    syncGroupName: string
    usePrivateLinkConnection: false
Copy

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

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
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.
ConflictLoggingRetentionInDays int
Conflict logging retention period.
ConflictResolutionPolicy string | Pulumi.AzureNative.Sql.SyncConflictResolutionPolicy
Conflict resolution policy of the sync group.
EnableConflictLogging bool
If conflict logging is enabled.
HubDatabasePassword string
Password for the sync group hub database credential.
HubDatabaseUserName string
User name for the sync group hub database credential.
Interval int
Sync interval of the sync group.
Schema Pulumi.AzureNative.Sql.Inputs.SyncGroupSchema
Sync schema of the sync group.
Sku Pulumi.AzureNative.Sql.Inputs.Sku
The name and capacity of the SKU.
SyncDatabaseId string
ARM resource id of the sync database in the sync group.
SyncGroupName Changes to this property will trigger replacement. string
The name of the sync group.
UsePrivateLinkConnection bool
If use private link connection is enabled.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
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.
ConflictLoggingRetentionInDays int
Conflict logging retention period.
ConflictResolutionPolicy string | SyncConflictResolutionPolicy
Conflict resolution policy of the sync group.
EnableConflictLogging bool
If conflict logging is enabled.
HubDatabasePassword string
Password for the sync group hub database credential.
HubDatabaseUserName string
User name for the sync group hub database credential.
Interval int
Sync interval of the sync group.
Schema SyncGroupSchemaArgs
Sync schema of the sync group.
Sku SkuArgs
The name and capacity of the SKU.
SyncDatabaseId string
ARM resource id of the sync database in the sync group.
SyncGroupName Changes to this property will trigger replacement. string
The name of the sync group.
UsePrivateLinkConnection bool
If use private link connection is enabled.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database on which the sync group is hosted.
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.
conflictLoggingRetentionInDays Integer
Conflict logging retention period.
conflictResolutionPolicy String | SyncConflictResolutionPolicy
Conflict resolution policy of the sync group.
enableConflictLogging Boolean
If conflict logging is enabled.
hubDatabasePassword String
Password for the sync group hub database credential.
hubDatabaseUserName String
User name for the sync group hub database credential.
interval Integer
Sync interval of the sync group.
schema SyncGroupSchema
Sync schema of the sync group.
sku Sku
The name and capacity of the SKU.
syncDatabaseId String
ARM resource id of the sync database in the sync group.
syncGroupName Changes to this property will trigger replacement. String
The name of the sync group.
usePrivateLinkConnection Boolean
If use private link connection is enabled.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
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.
conflictLoggingRetentionInDays number
Conflict logging retention period.
conflictResolutionPolicy string | SyncConflictResolutionPolicy
Conflict resolution policy of the sync group.
enableConflictLogging boolean
If conflict logging is enabled.
hubDatabasePassword string
Password for the sync group hub database credential.
hubDatabaseUserName string
User name for the sync group hub database credential.
interval number
Sync interval of the sync group.
schema SyncGroupSchema
Sync schema of the sync group.
sku Sku
The name and capacity of the SKU.
syncDatabaseId string
ARM resource id of the sync database in the sync group.
syncGroupName Changes to this property will trigger replacement. string
The name of the sync group.
usePrivateLinkConnection boolean
If use private link connection is enabled.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database on which the sync group is hosted.
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.
conflict_logging_retention_in_days int
Conflict logging retention period.
conflict_resolution_policy str | SyncConflictResolutionPolicy
Conflict resolution policy of the sync group.
enable_conflict_logging bool
If conflict logging is enabled.
hub_database_password str
Password for the sync group hub database credential.
hub_database_user_name str
User name for the sync group hub database credential.
interval int
Sync interval of the sync group.
schema SyncGroupSchemaArgs
Sync schema of the sync group.
sku SkuArgs
The name and capacity of the SKU.
sync_database_id str
ARM resource id of the sync database in the sync group.
sync_group_name Changes to this property will trigger replacement. str
The name of the sync group.
use_private_link_connection bool
If use private link connection is enabled.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database on which the sync group is hosted.
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.
conflictLoggingRetentionInDays Number
Conflict logging retention period.
conflictResolutionPolicy String | "HubWin" | "MemberWin"
Conflict resolution policy of the sync group.
enableConflictLogging Boolean
If conflict logging is enabled.
hubDatabasePassword String
Password for the sync group hub database credential.
hubDatabaseUserName String
User name for the sync group hub database credential.
interval Number
Sync interval of the sync group.
schema Property Map
Sync schema of the sync group.
sku Property Map
The name and capacity of the SKU.
syncDatabaseId String
ARM resource id of the sync database in the sync group.
syncGroupName Changes to this property will trigger replacement. String
The name of the sync group.
usePrivateLinkConnection Boolean
If use private link connection is enabled.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
LastSyncTime string
Last sync time of the sync group.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
SyncState string
Sync state of the sync group.
Type string
Resource type.
Id string
The provider-assigned unique ID for this managed resource.
LastSyncTime string
Last sync time of the sync group.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
SyncState string
Sync state of the sync group.
Type string
Resource type.
id String
The provider-assigned unique ID for this managed resource.
lastSyncTime String
Last sync time of the sync group.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync group if use private link connection is enabled.
syncState String
Sync state of the sync group.
type String
Resource type.
id string
The provider-assigned unique ID for this managed resource.
lastSyncTime string
Last sync time of the sync group.
name string
Resource name.
privateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
syncState string
Sync state of the sync group.
type string
Resource type.
id str
The provider-assigned unique ID for this managed resource.
last_sync_time str
Last sync time of the sync group.
name str
Resource name.
private_endpoint_name str
Private endpoint name of the sync group if use private link connection is enabled.
sync_state str
Sync state of the sync group.
type str
Resource type.
id String
The provider-assigned unique ID for this managed resource.
lastSyncTime String
Last sync time of the sync group.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync group if use private link connection is enabled.
syncState String
Sync state of the sync group.
type String
Resource type.

Supporting Types

Sku
, SkuArgs

Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Integer
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity number
Capacity of the particular SKU.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
Size of the particular SKU
tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. str
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity int
Capacity of the particular SKU.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
Size of the particular SKU
tier str
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Number
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.

SkuResponse
, SkuResponseArgs

Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Integer
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity number
Capacity of the particular SKU.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
Size of the particular SKU
tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. str
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity int
Capacity of the particular SKU.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
Size of the particular SKU
tier str
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Number
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.

SyncConflictResolutionPolicy
, SyncConflictResolutionPolicyArgs

HubWin
HubWin
MemberWin
MemberWin
SyncConflictResolutionPolicyHubWin
HubWin
SyncConflictResolutionPolicyMemberWin
MemberWin
HubWin
HubWin
MemberWin
MemberWin
HubWin
HubWin
MemberWin
MemberWin
HUB_WIN
HubWin
MEMBER_WIN
MemberWin
"HubWin"
HubWin
"MemberWin"
MemberWin

SyncGroupSchema
, SyncGroupSchemaArgs

MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTable>
List of tables in sync group schema.
MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables []SyncGroupSchemaTable
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<SyncGroupSchemaTable>
List of tables in sync group schema.
masterSyncMemberName string
Name of master sync member where the schema is from.
tables SyncGroupSchemaTable[]
List of tables in sync group schema.
master_sync_member_name str
Name of master sync member where the schema is from.
tables Sequence[SyncGroupSchemaTable]
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<Property Map>
List of tables in sync group schema.

SyncGroupSchemaResponse
, SyncGroupSchemaResponseArgs

MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTableResponse>
List of tables in sync group schema.
MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables []SyncGroupSchemaTableResponse
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<SyncGroupSchemaTableResponse>
List of tables in sync group schema.
masterSyncMemberName string
Name of master sync member where the schema is from.
tables SyncGroupSchemaTableResponse[]
List of tables in sync group schema.
master_sync_member_name str
Name of master sync member where the schema is from.
tables Sequence[SyncGroupSchemaTableResponse]
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<Property Map>
List of tables in sync group schema.

SyncGroupSchemaTable
, SyncGroupSchemaTableArgs

Columns List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTableColumn>
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
Columns []SyncGroupSchemaTableColumn
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
columns List<SyncGroupSchemaTableColumn>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.
columns SyncGroupSchemaTableColumn[]
List of columns in sync group schema.
quotedName string
Quoted name of sync group schema table.
columns Sequence[SyncGroupSchemaTableColumn]
List of columns in sync group schema.
quoted_name str
Quoted name of sync group schema table.
columns List<Property Map>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.

SyncGroupSchemaTableColumn
, SyncGroupSchemaTableColumnArgs

DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.
dataSize string
Data size of the column.
dataType string
Data type of the column.
quotedName string
Quoted name of sync group table column.
data_size str
Data size of the column.
data_type str
Data type of the column.
quoted_name str
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.

SyncGroupSchemaTableColumnResponse
, SyncGroupSchemaTableColumnResponseArgs

DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.
dataSize string
Data size of the column.
dataType string
Data type of the column.
quotedName string
Quoted name of sync group table column.
data_size str
Data size of the column.
data_type str
Data type of the column.
quoted_name str
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.

SyncGroupSchemaTableResponse
, SyncGroupSchemaTableResponseArgs

Columns List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTableColumnResponse>
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
Columns []SyncGroupSchemaTableColumnResponse
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
columns List<SyncGroupSchemaTableColumnResponse>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.
columns SyncGroupSchemaTableColumnResponse[]
List of columns in sync group schema.
quotedName string
Quoted name of sync group schema table.
columns Sequence[SyncGroupSchemaTableColumnResponse]
List of columns in sync group schema.
quoted_name str
Quoted name of sync group schema table.
columns List<Property Map>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.

Import

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

$ pulumi import azure-native:sql:SyncGroup syncgroupcrud-3187 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native