Removes a specific call park orbit.
Syntax
Remove-CsCallParkOrbit -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
String |
The name of the call park orbit. This name was assigned by the administrator when the call park orbit was defined. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
The Remove-CsCallParkOrbit cmdlet deletes the call park orbit that is specified by the Identity parameter, which is required. Each call park orbit within an organization must have a unique range of numbers. Removing a call park orbit frees up the range that was in that call park orbit. The freed numbers can then be used in a newly defined call park orbit.
Return Types
Removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsCallParkOrbit -Identity "Redmond CPO 1" |
|
In this example, Remove-CsCallParkOrbit is used to delete the call park orbit with the name Redmond CPO 1.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsCallParkOrbit | Remove-CsCallParkOrbit |
|
The command in Example 2 removes all call park orbits that have been defined for an organization. The command first calls the Get-CsCallParkOrbit cmdlet with no parameters to retrieve all the defined call park orbits. It then pipes that collection of call park orbits to the Remove-CsCallParkOrbit cmdlet, which removes each call park orbit.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsCallParkOrbit -Filter *Redmond* | Remove-CsCallParkOrbit |
|
This command removes all call park orbits that have an identity that includes the string "Redmond", such as "Redmond 501", "CP Redmond 1", and "ARedmond". The command first calls Get-CsCallParkOrbit with the Filter parameter to retrieve all call park orbits that have an Identity with the string Redmond in it. This collection is piped to Remove-CsCallParkOrbit, which removes everything in the collection.