New-​Azure​Rm​Sql​Sync​Group

Creates an Azure SQL Database Sync Group.

Syntax

New-AzureRmSqlSyncGroup
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-Name] <String>
   [-Confirm]
   [-ConflictResolutionPolicy <String>]
   [-DatabaseCredential <PSCredential>]
   [-IntervalInSeconds <Int32>]
   [-SchemaFile <String>]
   -SyncDatabaseName <String>
   -SyncDatabaseResourceGroupName <String>
   -SyncDatabaseServerName <String>
   [-WhatIf]

Description

The New-AzureRmSqlSyncGroup cmdlet creates an Azure SQL Database Sync Group.

Examples

Example 1: Create a sync group for an Azure SQL Database.

PS C:\> $credential = Get-Credential
PS C:\> New-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" -ConflictResolutionPolicy "HubWin"
-DatabaseCredential $credential -IntervalInSeconds 100 -SyncDatabaseServerName "syncDatabaseServer01" -SyncDatabaseName "syncDatabaseName01"
-SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" -Schema ".\schema.json" | Format-List
ResourceId                  : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}
ResourceGroupName           : ResourceGroup01
ServerName                  : Server01
DatabaseName                : Database01
SyncGroupName               : SyncGroup01
SyncDatabaseId              : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01}
IntervalInSeconds           : 100
ConflictResolutionPolicy:   : HubWin
HubDatabaseUserName         : myAccount
HubDatabasePassword         : 
SyncState                   : NotReady
LastSyncTime                : 1/1/0001 12:00:00 AM
Schema                      :

This command creates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the shema payload in json format. An example of the schema json is: {"Tables": [{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable1"}, {"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable2"}], "MasterSyncMemberName": null }

Required Parameters

-DatabaseName

The name of the Azure SQL Database.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

The sync group name.

Type:String
Aliases:SyncGroupName
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerName

The name of the Azure SQL Server.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SyncDatabaseName

The database used to store sync related metadata.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SyncDatabaseResourceGroupName

The resource group the sync metadata database belongs to.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SyncDatabaseServerName

The server on which the sync metadata database is hosted.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConflictResolutionPolicy

The policy of resolving confliction between hub and member database in the sync group.

Type:String
Parameter Sets:HubWin, MemberWin
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DatabaseCredential

The SQL authentication credential of the hub database.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IntervalInSeconds

The frequency (in seconds) of doing data synchronization. Default is -1, which means the auto synchronization is not enabled.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SchemaFile

The path of the schema file.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel