[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes an existing Response Group agent group. An agent group is a collection of agents assigned to a Response Group queue. Agents are the users assigned to answer calls directed to a particular queue.


Remove-CsRgsAgentGroup -Identity <RgsIdentity> [-Confirm [<SwitchParameter>]] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Rgs Identity

Unique identifier for the agent group to be removed. The Identity of an agent group consists of the location of the service where the agent group is hosted plus a globally unique identifier (GUID). That means that an agent group will have an Identity similar to this: service:ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83. Because GUIDs are difficult to remember, and to work with, the Examples section demonstrates alternate ways that you can identify the agent group to be removed.



Switch Parameter

Forces removal of the agent group. If this parameter is present, the agent group will be deleted without warning, even if it is used by an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any agent group currently being used by an active workflow.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

When someone calls a phone number associated with the Response Group application, the service starts by determining which workflow corresponds to the number that was called. Based on the configuration of that workflow, the call might be routed to a set of Interactive Voice Response questions (in which the caller is asked one more questions along the lines of "Is this question about hardware support or software support?"). Alternatively, the call might be placed in a Response Group Service queue; there the caller will remain on hold until someone is available to answer the call. The people designated to answer calls are known as agents, and a collected group of agents are referred to as a Response Group agent group. Agent groups are associated with workflows, and are further associated with like job responsibilities; for example, help desk personnel might be grouped in the Help Desk agent group while customer support agents might be grouped in the Customer Support agent group.

New agent groups are created using the New-CsRgsAgentGroup cmdlet. If you need to delete an agent group, this can be done by calling the Remove-CsRgsAgentGroup cmdlet. Note that this cmdlet deletes the entire group, and all the agents in that group. If you only want to remove a single agent from a group, use the Set-CsRgsAgentGroup cmdlet instead.

Return Types

Remove-CsRgsAgentGroup deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object.


-------------------------- Example 1 ------------------------

Copy Code
Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsAgentGroup

The preceding command deletes all the Response Group agent groups configured for use on the service ApplicationServer:atl-cs-001.litwareinc.com. To do this, the command first uses Get-CsRgsAgentGroup to return all the agent groups for ApplicationServer:atl-cs-001.litwareinc.com. Those groups are then piped to, and removed by, the Remove-CsRgsAgentGroup cmdlet.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" | Remove-CsRgsAgentGroup

In Example 2, a single Response Group agent group is removed: the group named Help Desk. To carry out this task, Get-CsRgsAgentGroup is first used to return the Help Desk agent group (-Name "Help Desk") from ApplicationServer:atl-cs-001.litwareinc.com. This group is then piped to Remove-CsRgsAgentGroup, which removes the group from the service.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -ne "RoundRobin"} | Remove-CsRgsAgentGroup

Example 3 deletes all the Response Group agent groups on ApplicationServer:atl-cs-001.litwareinc.com that do not use the round robin routing method. To do this, Get-CsRgsAgentGroup is called in order to return a collection of all the agent groups found on the service ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to the Where-Object cmdlet, which picks out only those groups where the RoutingMethod property is not equal to (-ne) RoundRobin. The filtered collection is then piped to Remove-CsRgsAgentGroup, which deletes each item in that collection.