Get-AzureRmSqlSyncMember
Returns information about Azure SQL Database Sync Members.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmSqlSyncMember
[-Name <String>]
[-SyncGroupName] <String>
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<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.
Examples
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"
Parameters
-DatabaseName
The name of the Azure SQL Database.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The sync member name.
Type: | String |
Aliases: | SyncMemberName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ServerName
The name of the Azure SQL Server.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SyncGroupName
The sync group name.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |