Get-AzureRmSqlSyncMember

NAME Get-AzureRmSqlSyncMember



SYNOPSIS

Returns information about Azure SQL Database Sync Members.





SYNTAX

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

<IAzureContextContainer>] [-Name <String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlSyncMember cmdlet returns information about one or more Azure SQL Database Sync Members. Specify the name of a sync member to

see information for only that 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



-Name <String>

The sync member name.



Required? false

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



-SyncGroupName <String>

The sync group name.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

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: Get all instances of Azure SQL Sync Member assigned to a sync group



PS C:\\>Get-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName

"SyncGroup01" | 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 : Good



ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/

{SyncGroup01}/syncMembers/{SyncMember02}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncGroupName : SyncGroup01

SyncMemberName : SyncMember02

SyncDirection : OneWayMemberToHub

MemberDatabaseType: : AzureSqlDatabase

SyncAgentId :

SqlServerDatabaseId :

MemberServerName : memberServer01.full.dns.name

MemberDatabaseName : memberDatabase01

MemberDatabaseUserName : myAccount

MemberDatabasePassword :

SyncState : Good



This command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01.





Example 2: Get information about an Azure SQL Database Sync Member



PS C:\\>Get-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName

"SyncGroup01" -Name "SyncMember01" | 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 : Good



This command gets information about the Azure SQL Database Sync Member with name "SyncMember01"







RELATED LINKS

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

New-AzureRmSqlSyncMember

Update-AzureRmSqlSyncMember

Remove-AzureRmSqlSyncMember