New-AzureRmSqlSyncMember

NAME New-AzureRmSqlSyncMember



SYNOPSIS

Creates an Azure SQL Database Sync Member.





SYNTAX

New-AzureRmSqlSyncMember [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-SyncGroupName] <String> [-DefaultProfile

<IAzureContextContainer>] -MemberDatabaseCredential <PSCredential> -MemberDatabaseName <String> -MemberDatabaseType {SqlServerDatabase |

AzureSqlDatabase} -MemberServerName <String> -Name <String> [-SyncDirection {Bidirectional | OneWayMemberToHub | OneWayHubToMember}] [-Confirm]

[-WhatIf] [<CommonParameters>]



New-AzureRmSqlSyncMember [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-SyncGroupName] <String> [-DefaultProfile

<IAzureContextContainer>] -MemberDatabaseType {SqlServerDatabase | AzureSqlDatabase} -Name <String> -SqlServerDatabaseId <String> -SyncAgentName

<String> -SyncAgentResourceGroupName <String> -SyncAgentServerName <String> [-SyncDirection {Bidirectional | OneWayMemberToHub |

OneWayHubToMember}] [-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmSqlSyncMember [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-SyncGroupName] <String> [-DefaultProfile

<IAzureContextContainer>] -MemberDatabaseType {SqlServerDatabase | AzureSqlDatabase} -Name <String> -SqlServerDatabaseId <String>

-SyncAgentResourceID <String> [-SyncDirection {Bidirectional | OneWayMemberToHub | OneWayHubToMember}] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-DatabaseName <String>

The name of the Azure SQL Database.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MemberDatabaseCredential <PSCredential>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MemberDatabaseName <String>

The Azure SQL Database name of the member database.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MemberDatabaseType <String>

The database type of the member database.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MemberServerName <String>

The Azure SQL Server Name of the member database.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The sync member name.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

The name of the Azure SQL Server.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SqlServerDatabaseId <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncAgentName <String>

The name of the sync agent.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncAgentResourceGroupName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncAgentResourceID <String>

The resource ID of the sync agent.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncAgentServerName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncDirection <String>

The sync direction of this sync member.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncGroupName <String>

The sync group name.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... syncmember

Get-AzureRmSqlSyncMember

Set-AzureRmSqlSyncMember

Remove-AzureRmSqlSyncMember