Skip to content

Commit 41bc3ab

Browse files
authored
Merge pull request #8428 from JensTrier/PhoneNumberRemove
Updating Remove-CsOnlineTelephoneNumber doc
2 parents bd78275 + 0049412 commit 41bc3ab

File tree

1 file changed

+35
-49
lines changed

1 file changed

+35
-49
lines changed
Lines changed: 35 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,70 @@
11
---
22
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
33
online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinetelephonenumber
4-
applicable: Skype for Business Online
4+
applicable: Skype for Business Online, Microsoft Teams
55
title: Remove-CsOnlineTelephoneNumber
66
schema: 2.0.0
77
manager: bulenteg
8-
author: tomkau
9-
ms.author: tomkau
8+
author: jenstrier
9+
ms.author: jenstr
1010
ms.reviewer:
1111
---
1212

1313
# Remove-CsOnlineTelephoneNumber
1414

1515
## SYNOPSIS
16-
Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove a telephone number from the Business Voice Directory.
16+
Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant.
1717

1818
## SYNTAX
1919

2020
```
21-
Remove-CsOnlineTelephoneNumber -TelephoneNumber <String[]> [-Tenant <Guid>] [-DomainController <Fqdn>]
22-
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Remove-CsOnlineTelephoneNumber -TelephoneNumber <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2322
```
2423

2524
## DESCRIPTION
26-
Provide the detailed description here.
25+
This cmdlet removes one or more unassigned telephone numbers from your tenant. If at least one of the telephone numbers is assigned to a user or resource account, the cmdlet will fail and will not remove any of the specified telephone numbers.
2726

2827
## EXAMPLES
2928

3029
### -------------------------- Example 1 --------------------------
3130
```
32-
Remove-CsOnlineTelephoneNumber -TelephoneNumber +14258884567
31+
Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567
32+
```
33+
```Output
34+
NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk
35+
---------------- --------------------- ------------------------- -----------------------------
36+
{14258884567} {} {} {}
37+
```
38+
39+
This example removes the specified telephone number from the tenant.
40+
41+
### -------------------------- Example 2 --------------------------
42+
```
43+
[string[]]$tns="+14255551234","+14255551233"
44+
Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns
45+
```
46+
```Output
47+
NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk
48+
---------------- --------------------- ------------------------- -----------------------------
49+
{14255551234, {} {} {}
50+
14255551233}
3351
```
3452

35-
This example removes the specified telephone number from the Business Voice Directory.
53+
This example removes the specified list of telephone numbers from the tenant.
3654

3755

3856
## PARAMETERS
3957

4058
### -TelephoneNumber
41-
Specifies the target telephone number.
42-
For example: -TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567
59+
Specifies the telephone number(s) to remove. The format can be withor without the prefixed +, but needs to include country code etc.
4360

4461
```yaml
4562
Type: String[]
4663
Parameter Sets: (All)
4764
Aliases:
48-
Applicable: Skype for Business Online
65+
Applicable: Skype for Business Online, Microsoft Teams
4966

50-
Required: False
67+
Required: True
5168
Position: Named
5269
Default value: None
5370
Accept pipeline input: False
@@ -61,23 +78,7 @@ The Confirm switch causes the command to pause processing and requires confirmat
6178
Type: SwitchParameter
6279
Parameter Sets: (All)
6380
Aliases: cf
64-
Applicable: Skype for Business Online
65-
66-
Required: False
67-
Position: Named
68-
Default value: None
69-
Accept pipeline input: False
70-
Accept wildcard characters: False
71-
```
72-
73-
### -DomainController
74-
This parameter is reserved for internal Microsoft use.
75-
76-
```yaml
77-
Type: Fqdn
78-
Parameter Sets: (All)
79-
Aliases: DC
80-
Applicable: Skype for Business Online
81+
Applicable: Skype for Business Online, Microsoft Teams
8182

8283
Required: False
8384
Position: Named
@@ -95,23 +96,7 @@ If the Force switch isn't provided in the command, you're prompted for administr
9596
Type: SwitchParameter
9697
Parameter Sets: (All)
9798
Aliases:
98-
Applicable: Skype for Business Online
99-
100-
Required: False
101-
Position: Named
102-
Default value: None
103-
Accept pipeline input: False
104-
Accept wildcard characters: False
105-
```
106-
107-
### -Tenant
108-
This parameter is reserved for internal Microsoft use.
109-
110-
```yaml
111-
Type: Guid
112-
Parameter Sets: (All)
113-
Aliases:
114-
Applicable: Skype for Business Online
99+
Applicable: Skype for Business Online, Microsoft Teams
115100

116101
Required: False
117102
Position: Named
@@ -128,7 +113,7 @@ By using this switch, you can view what changes would occur without having to co
128113
Type: SwitchParameter
129114
Parameter Sets: (All)
130115
Aliases: wi
131-
Applicable: Skype for Business Online
116+
Applicable: Skype for Business Online, Microsoft Teams
132117

133118
Required: False
134119
Position: Named
@@ -151,6 +136,7 @@ None
151136
None
152137
153138
## NOTES
139+
If one or more of the telephone numbers are assigned to a user or a service, the cmdlet will display an error message and none of the telephone numbers specified will be removed from your tenant.
154140
155141
## RELATED LINKS
156-
142+
- [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md)

0 commit comments

Comments
 (0)