Remove-​Azure​Rm​Sql​Sync​Agent

Removes an Azure SQL Sync Agent.

Syntax

Remove-AzureRmSqlSyncAgent
      [-ResourceGroupName] <String>
      [-ServerName] <String>
      [-Name] <String>
      [-Confirm]
      [-Force]
      [-PassThru]
      [-WhatIf]

Description

The Remove-AzureRmSqlSyncAgent cmdlet removes an Azure SQL Sync Agent.

Examples

Example 1: Remove a sync agent

PS C:\>Remove-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "syncAgent01"

This command removes the Azure SQL Sync Agent named syncAgent01.

Required Parameters

-Name

The sync agent name.

Type:String
Aliases:SyncAgentName
Position:2
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 the sync agent is in.

Type:String
Position:1
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 agent

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