Edit

Share via

New-AzSqlSyncMember

Module:
Az.Sql Module

Creates an Azure SQL Database Sync Member.

Syntax

AzureSqlDatabase (Default) 

New-AzSqlSyncMember
    [-SyncGroupName] <String>
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -Name <String>
    -MemberDatabaseType <String>
    -MemberServerName <String>
    -MemberDatabaseName <String>
    -MemberDatabaseCredential <PSCredential>
    [-SyncDirection <String>]
    [-UsePrivateLinkConnection]
    [-SyncMemberAzureDatabaseResourceId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

OnPremisesDatabaseSyncAgentComponent 

New-AzSqlSyncMember
    [-SyncGroupName] <String>
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -Name <String>
    -MemberDatabaseType <String>
    -SyncAgentResourceGroupName <String>
    -SyncAgentServerName <String>
    -SyncAgentName <String>
    -SqlServerDatabaseId <String>
    [-SyncDirection <String>]
    [-UsePrivateLinkConnection]
    [-SyncMemberAzureDatabaseResourceId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

OnPremisesDatabaseSyncAgentResourceID 

New-AzSqlSyncMember
    [-SyncGroupName] <String>
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -Name <String>
    -MemberDatabaseType <String>
    -SqlServerDatabaseId <String>
    -SyncAgentResourceID <String>
    [-SyncDirection <String>]
    [-UsePrivateLinkConnection]
    [-SyncMemberAzureDatabaseResourceId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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

Examples

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

$credential = Get-Credential
New-AzSqlSyncMember -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

$credential = Get-Credential
New-AzSqlSyncMember -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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DatabaseName

The name of the Azure SQL Database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MemberDatabaseCredential

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

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureSqlDatabase
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MemberDatabaseName

The Azure SQL Database name of the member database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureSqlDatabase
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MemberDatabaseType

The database type of the member database.

Parameter properties

Type:String
Default value:None
Accepted values:SqlServerDatabase, AzureSqlDatabase
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MemberServerName

The Azure SQL Server Name of the member database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureSqlDatabase
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The sync member name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SyncMemberName

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerName

The name of the Azure SQL Server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SqlServerDatabaseId

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPremisesDatabaseSyncAgentComponent
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
OnPremisesDatabaseSyncAgentResourceID
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncAgentName

The name of the sync agent.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPremisesDatabaseSyncAgentComponent
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncAgentResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPremisesDatabaseSyncAgentComponent
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncAgentResourceID

The resource ID of the sync agent.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPremisesDatabaseSyncAgentResourceID
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncAgentServerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPremisesDatabaseSyncAgentComponent
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncDirection

The sync direction of this sync member.

Parameter properties

Type:String
Default value:None
Accepted values:Bidirectional, OneWayMemberToHub, OneWayHubToMember
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncGroupName

The sync group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SyncMemberAzureDatabaseResourceId

The resource ID for the sync member database, used if UsePrivateLinkConnection is set to true.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UsePrivateLinkConnection

Use a private link connection when connecting to this sync member.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

AzureSqlSyncMemberModel