Remove-AzureRmSqlSyncGroup

NAME Remove-AzureRmSqlSyncGroup



SYNOPSIS

Removes an Azure SQL Database Sync Group.





SYNTAX

Remove-AzureRmSqlSyncGroup [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [-Force] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmSqlSyncGroup cmdlet removes an Azure SQL Database Sync Group.





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



-Force [<SwitchParameter>]

Skip confirmation message for performing the action



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The sync group name.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Defines Whether return the removed sync group



Required? false

Position? named

Default value False

Accept pipeline input? False

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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

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.AzureSqlSyncGroupModel







NOTES









Example 1: Remove a sync group



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



This command removes the Azure SQL Database Sync Group named syncGroup01.







RELATED LINKS

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

New-AzureRmSqlSyncGroup

Update-AzureRmSqlSyncGroup

Get-AzureRmSqlSyncGroup