New-​Azure​Rm​Sql​Sync​Member

Creates an Azure SQL Database Sync Member.

Syntax

New-AzureRmSqlSyncMember
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-SyncGroupName] <String>
   [-Confirm]
   -MemberDatabaseCredential <PSCredential>
   -MemberDatabaseName <String>
   -MemberDatabaseType <String>
   -MemberServerName <String>
   -Name <String>
   [-SyncDirection <String>]
   [-WhatIf]
New-AzureRmSqlSyncMember
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-SyncGroupName] <String>
   [-Confirm]
   -MemberDatabaseType <String>
   -Name <String>
   -SqlServerDatabaseId <String>
   -SyncAgentName <String>
   -SyncAgentResourceGroupName <String>
   -SyncAgentServerName <String>
   [-SyncDirection <String>]
   [-WhatIf]
New-AzureRmSqlSyncMember
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-SyncGroupName] <String>
   [-Confirm]
   -MemberDatabaseType <String>
   -Name <String>
   -SqlServerDatabaseId <String>
   -SyncAgentResourceID <String>
   [-SyncDirection <String>]
   [-WhatIf]

Description

The New-AzureRmSqlSyncMember cmdlet creates an Azure SQL Database Sync Member.

Examples

Example 1: Create a sync member for an Azure SQL database.

PS C:\> $credential = Get-Credential
PS C:\> New-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub"
-MemberDatabaseType "AzureSqlDatabase" -MemberServerName "memberServer01.full.dns.name" -MemberDatabaseName "memberDatabase01" -MemberDatabaseCredential $credential | Format-List
ResourceId                  : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01}
ResourceGroupName           : ResourceGroup01
ServerName                  : Server01
DatabaseName                : Database01
SyncGroupName               : SyncGroup01
SyncMemberName              : SyncMember01
SyncDirection               : OneWayMemberToHub
MemberDatabaseType:         : AzureSqlDatabase
SyncAgentId                 : 
SqlServerDatabaseId         : 
MemberServerName            : memberServer01.full.dns.name
MemberDatabaseName          : memberDatabase01
MemberDatabaseUserName      : myAccount
MemberDatabasePassword      : 
SyncState                   : UnProvisioned

This command creates a sync member for an Azure SQL database.

Example 2: Create a sync member for an on-premises SQL Server database

PS C:\> $credential = Get-Credential
PS C:\> New-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub"
-MemberDatabaseType "SqlServerDatabase" -SqlServerDatabaseId "dbId" -syncAgentResourceGroupName "syncAgentResourceGroupName" -syncAgentServerName "syncAgentServerName" 
-syncAgentDatabaseName "syncAgentDatabaseName" -syncAgentName "agentName" | Format-List
ResourceId                  : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01}
ResourceGroupName           : ResourceGroup01
ServerName                  : Server01
DatabaseName                : Database01
SyncGroupName               : SyncGroup01
SyncMemberName              : SyncMember01
SyncDirection               : OneWayMemberToHub
MemberDatabaseType:         : AzureSqlDatabase
SyncAgentId                 : /subscriptions/{subscriptionId}/resourceGroups/{syncAgentResourceGroupName}/servers/{syncAgentServerName}/syncAgents/{syncAgentId}
SqlServerDatabaseId         : dbId
MemberServerName            : 
MemberDatabaseName          : 
MemberDatabaseUserName      : myAccount
MemberDatabasePassword      : 
SyncState                   : UnProvisioned

This command creates a sync member for an on-premises SQL database.

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
-MemberDatabaseCredential

The credential (username and password) of the Azure SQL Database.

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

The Azure SQL Database name of the member database.

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

The database type of the member database.

Type:String
Parameter Sets:SqlServerDatabase, AzureSqlDatabase
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MemberServerName

The Azure SQL Server Name of the member database.

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

The sync member name.

Type:String
Aliases:SyncMemberName
Position:Named
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
-SqlServerDatabaseId

The id of the SQL server database which is connected by the sync agent.

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

The name of the sync agent.

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

The name of the resource group where the sync agent is under.

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

The resource ID of the sync agent.

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

The name of the Azure SQL Server where the sync agent is under.

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

The sync group name.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
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
-SyncDirection

The sync direction of this sync member.

Type:String
Parameter Sets:Bidirectional, OneWayMemberToHub, OneWayHubToMember
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.AzureSqlSyncMemberModel