Removes an existing Microsoft Communications Server 2010 announcement. Announcements are played when users dial a valid but unassigned phone number. With announcements, users who dial one of these numbers can be given a message (such as "This number is temporarily out of service") or can be presented with a busy signal.
Syntax
Remove-CsAnnouncement -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
A unique identifier for the Announcement you want to remove. The value for the Identity parameter can be supplied in one of two ways: - Enter the Identity of the Application service for the announcements you want to retrieve. This will retrieve all announcements configured with the given service Identity. For example, ApplicationServer:Redmond.litwareinc.com. - Enter the full Identity of the single announcement you want to retrieve. This value will always be in the format <serviceID>/<GUID>, where serviceID is the Identity of the Application Server running the Announcement Service and GUID is a globally unique identifier associated with this announcement. For example: ApplicationServer:Redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. |
|
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
An enterprise can own phone numbers that are not assigned to users or phones, but which are still valid numbers that can be called. By default when someone dials one of those numbers he or she will receive a busy signal and the call may result in an error returned to the SIP client. By applying announcement settings to unassigned numbers, administrators have the option of playing a message, returning a busy signal, or redirecting the call. This cmdlet removes one or more of these announcement settings.
If you attempt to remove an announcement that is associated with an unassigned number range, by default you’ll receive a prompt asking if you really want to remove the announcement. If you delete the announcement, the AnnouncementName property of that range will be set to Null and no announcement will be played when those numbers are reached, only a busy signal will be heard. However, the AnnouncementId property value (the GUID of the Announcement that was removed) will remain.
Return Types
Deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90" |
|
The preceding command removes the announcement that has the Identity "ApplicationServer:Redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90". Because Identities must be unique, this command will remove, at most, a single announcement.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com" | Where-Object {$_.Name -eq "Welcome Announcement"} | Remove-CsAnnouncement
|
|
The command shown in Example 2 is a variation of the command shown in Example 1. In both cases a single announcement is removed. In Example 2, however, the announcement is identified by service ID and Name rather than by using the full announcement Identity (which includes both the service where the announcement has been applied plus a 36-character GUID). To carry out this this task, the command first calls Get-CsAnnouncement with an Identity of ApplicationServer:Redmond.litwareinc.com; that returns a collection of all the announcements configured for that service. This collection is piped to the Where-Object cmdlet, which picks out the announcement that has a name equal to (-eq) "Welcome Announcement". In turn, that announcement is piped to, and removed by, the Remove-CsAnnouncement cmdlet.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com" |
|
In Example 3, all the announcements that have been applied to the service ApplicationServer:Redmond.litwareinc.com are deleted. To do this, Remove-CsAnnouncement is called along with the -Identity parameter. Specifying the parameter value "ApplicationServer:Redmond.litwareinc.com" (without the appended GUID that identifies a unique announcement) removes all the announcements configured for the specified service.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsAnnouncement | Where-Object {($_.TextToSpeechPrompt -ne $Null) -and ($_.Language -ne "en-US")} | Remove-CsAnnouncement
|
|
The preceding command deletes all the announcements that use a TTS prompt but do not use en-US (US English) as the announcement language. To carry out this task, the command first calls Get-CsAnnouncement without any parameters in order to return a collection of all the announcements configured for use in the organization. This collection is then piped to Where-Object, which picks out only those announcements where the Language property is not equal to (-ne) "en-US" and the TextToSpeechPrompt property is not Null (meaning it contains a value). That filtered collection is then piped to Remove-CsAnnouncement which deletes all the non-English TTS-prompted announcements.