Remove-​Azure​Rm​Sql​Sync​Member

Removes an Azure SQL Database Sync Member.

Syntax

Remove-AzureRmSqlSyncMember
      [-ResourceGroupName] <String>
      [-ServerName] <String>
      [-DatabaseName] <String>
      [-SyncGroupName] <String>
      [-Confirm]
      [-Force]
      -Name <String>
      [-PassThru]
      [-WhatIf]

Description

The Remove-AzureRmSqlSyncMember cmdlet removes an Azure SQL Database Sync Member.

Examples

Example 1: Remove a sync member

PS C:\>Remove-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -Name "syncMember01"

This command removes the Azure SQL Database Sync Member named syncMember01.

Required Parameters

-DatabaseName

The name of the Azure SQL Database.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

The sync member name.

Type:String
Aliases:SyncMemberName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerName

The name of the Azure SQL Server.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SyncGroupName

The sync group name.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Skip confirmation message for performing the action

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Defines Whether return the removed sync member

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

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