Get-AzSqlSyncMember
Returns information about Azure SQL Database Sync Members.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Get-AzSqlSyncMember
[-Name <String>]
[-SyncGroupName] <String>
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzSqlSyncMember 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.
Examples
Example 1: Get all instances of Azure SQL Sync Member assigned to a sync group
PS C:\> Get-AzSqlSyncMember -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 : GoodThis 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-AzSqlSyncMember -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 : GoodThis command gets information about the Azure SQL Database Sync Member with name "SyncMember01"
Example 3: Get all instances of Azure SQL Sync Member assigned to a sync group using filtering
PS C:\> Get-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember*" | 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 : GoodThis command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01 that start with "SyncMember".
Parameters
-DatabaseName
The name of the Azure SQL Database.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 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 |
| Accept wildcard characters: | True |
-ResourceGroupName
The name of the resource group.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServerName
The name of the Azure SQL Server.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SyncGroupName
The sync group name.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |