Skip to content

Commit 5b458f0

Browse files
padmagit77padmagit77
authored
Merge branch 'main' into main
2 parents 6b977b1 + 7d776e6 commit 5b458f0

15 files changed

+655
-162
lines changed

‎exchange/docs-conceptual/recipient-filters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Recipient filters in Exchange PowerShell commands"
33
ms.author: chrisda
44
author: chrisda
55
manager: deniseb
6-
ms.date: 9/7/2023
6+
ms.date: 09/07/2023
77
ms.audience: ITPro
88
audience: ITPro
99
ms.topic: reference

‎exchange/docs-conceptual/recipientfilter-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Filterable properties for the RecipientFilter parameter"
33
ms.author: chrisda
44
author: chrisda
55
manager: deniseb
6-
ms.date:
6+
ms.date: 09/07/2023
77
ms.audience: ITPro
88
audience: ITPro
99
ms.topic: article

‎exchange/exchange-ps/exchange/Set-MailUser.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2497,7 +2497,9 @@ Accept wildcard characters: False
24972497
### -RemoveLitigationHoldEnabled
24982498
This parameter is available only in the cloud-based service.
24992499

2500-
{{ Fill RemoveLitigationHoldEnabled Description }}
2500+
The RemoveLitigationHoldEnabled switch specifies whether to remove litigation hold from all mailbox locations of a mail user, including online archive, in an Exchange hybrid environment. You don't need to specify a value with this switch.
2501+
2502+
This switch is useful in scenarios where admins can't permanently delete mail users due to litigation holds on the mail users. For more information on litigation hold, see [Create a Litigation hold](https://learn.microsoft.com/en-us/purview/ediscovery-create-a-litigation-hold).
25012503

25022504
```yaml
25032505
Type: SwitchParameter

‎spmt/docs-conceptual/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
ms.localizationpriority: medium
33
title: Microsoft SharePoint Migration Tool cmdlet help reference
4+
ms.date: 01/01/2020
45
description: "Learn about the Microsoft SharePoint Migration Tool PowerShell cmdlet help reference."
56
---
67

‎spmt/docs-conceptual/intro.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
ms.localizationpriority: medium
33
title: Microsoft SharePoint Migration Tool cmdlet reference
4+
ms.date: 01/01/2020
45
description: "Learn about Microsoft SharePoint Migration Tool cmdlets."
56
---
67

‎spmt/docs-conceptual/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: My overview
3+
ms.date: 01/01/2020
4+
description: "Microsoft SharePoint Migration Tool cmdlet reference."
35
---
46

57
# My overview

‎teams/docs-conceptual/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
ms.localizationpriority: medium
33
title: Microsoft Teams cmdlet help reference
4+
ms.date: 01/01/2020
45
description: "Learn about the Microsoft Teams PowerShell cmdlet help reference."
56
---
67

‎teams/docs-conceptual/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: My overview
3+
ms.date: 01/01/2020
4+
description: "Microsoft Teams cmdlet help reference."
35
---
46

57
# My overview

‎teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md

Lines changed: 150 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -13,82 +13,156 @@ ms.reviewer: julienp
1313
# Get-CsOnlineTelephoneNumberOrder
1414

1515
## SYNOPSIS
16-
Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization.
16+
Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order.
1717

1818
## SYNTAX
1919

2020
```
21-
Get-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>]
21+
Get-CsOnlineTelephoneNumberOrder -OrderId <String> [-OrderType <String>]
22+
[<CommonParameters>]
2223
```
2324

2425
## DESCRIPTION
2526

26-
Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization.
27+
This `Get-CsOnlineTelephoneNumberOrder` cmdlet can be used to get the status of specific telephone number orders. Currently supported orders for retrievals are: Search [New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder), Direct Routing Number Upload [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder), and Direct Routing Number Release [New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder). When the OrderType is not indicated, the cmdlet will default to a Search order.
2728

2829
## EXAMPLES
2930

30-
### -------------------------- Example 1 --------------------------
31+
### Example 1
3132
```
32-
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
33-
34-
AreaCode :
35-
CivicAddressId :
36-
CountryCode : US
37-
CreatedAt : 8/23/2021 5:43:44 PM
38-
Description : test
39-
ErrorCode : NoError
40-
Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
41-
InventoryType : Subscriber
42-
IsManual : False
43-
Name : test
44-
NumberPrefix : 1718
45-
NumberType : UserSubscriber
46-
Quantity : 1
47-
ReservationExpiryDate : 8/23/2021 5:59:45 PM
48-
SearchType : Prefix
49-
SendToServiceDesk : False
50-
Status : Reserved
51-
TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult}
52-
53-
PS C:\> $order.TelephoneNumber
54-
55-
Location TelephoneNumber
56-
-------- ---------------
57-
New York City +17182000004
33+
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be
34+
35+
Key Value
36+
--- -----
37+
Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be
38+
Name Postal Code Search Test
39+
CreatedAt 2024-11-30T00:34:00.0825627+00:00
40+
CreatedBy ContosoAdmin
41+
Description Postal Code Search Test
42+
NumberType UserSubscriber
43+
SearchType PostalCode
44+
AreaCode 778
45+
PostalOrZipCode V7Y 1G5
46+
Quantity 2
47+
Status Reserved
48+
IsManual False
49+
TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]}
50+
ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00
51+
ErrorCode NoError
52+
InventoryType Subscriber
53+
SendToServiceDesk False
54+
CountryCode CA
55+
56+
PS C:\> $order.TelephoneNumbers
57+
58+
Key Value
59+
--- -----
60+
Location Vancouver
61+
TelephoneNumber +16046606034
62+
Location Vancouver
63+
TelephoneNumber +16046606030
5864
```
5965

60-
This example returns a successful telephone number search and the telephone number +17182000004 is reserved for purchase.
66+
This example returns a successful telephone number search and the telephone numbers are reserved for purchase.
6167

62-
### -------------------------- Example 2 --------------------------
68+
### Example 2
6369
```
64-
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042
65-
66-
AreaCode :
67-
CivicAddressId :
68-
CountryCode : US
69-
CreatedAt : 8/23/2021 6:53:12 PM
70-
Description : test
71-
ErrorCode : OutOfStock
72-
Id : 8d23e073-bc98-4f73-8e05-7517655d7042
73-
InventoryType : Subscriber
74-
IsManual : False
75-
Name : test
76-
NumberPrefix : 1425
77-
NumberType : UserSubscriber
78-
Quantity : 1
79-
ReservationExpiryDate :
80-
SearchType : Prefix
81-
SendToServiceDesk : False
82-
Status : Error
83-
TelephoneNumber : {}
70+
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042
71+
72+
Key Value
73+
--- -----
74+
Id 8d23e073-bc98-4f73-8e05-7517655d7042
75+
Name Postal Code Search Test
76+
CreatedAt 2024-11-30T00:34:00.0825627+00:00
77+
CreatedBy ContosoAdmin
78+
Description Prefix Search Test
79+
NumberType UserSubscriber
80+
SearchType Prefix
81+
AreaCode
82+
PostalOrZipCode
83+
Quantity 1
84+
Status Error
85+
IsManual False
86+
TelephoneNumbers {}
87+
ReservationExpiryDate
88+
ErrorCode OutOfStock
89+
InventoryType Subscriber
90+
SendToServiceDesk False
91+
CountryCode
8492
```
8593

8694
This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`.
8795

96+
### Example 3
97+
```powershell
98+
PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be
99+
100+
Key Value
101+
--- -----
102+
Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be
103+
Name Postal Code Search Test
104+
CreatedAt 2024-11-30T00:34:00.0825627+00:00
105+
CreatedBy TNM
106+
Description Postal Code Search Test from Postman
107+
NumberType UserSubscriber
108+
SearchType PostalCode
109+
AreaCode 778
110+
PostalOrZipCode V7Y 1G5
111+
Quantity 2
112+
Status Expired
113+
IsManual False
114+
TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]}
115+
ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00
116+
ErrorCode NoError
117+
InventoryType Subscriber
118+
SendToServiceDesk False
119+
CountryCode CA
120+
```
121+
122+
When the OrderType is not indicated, the cmdlet will default to a Search order. This example returns a successful telephone number search and the telephone numbers are reserved for purchase.
123+
124+
### Example 4
125+
```powershell
126+
PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId 6aa4f786-8628-4923-9df1-896f3d84016c
127+
128+
Key Value
129+
--- -----
130+
OrderId 6aa4f786-8628-4923-9df1-896f3d84016c
131+
CreatedAt 2024-11-27T06:44:26.1975766+00:00
132+
Status Complete
133+
TotalCount 3
134+
SuccessCount 3
135+
FailureCount 0
136+
SuccessPhoneNumbers {+12063866355, +12063868075, +12063861642}
137+
FailedPhoneNumbers {}
138+
```
139+
140+
This example returns the status of a successful release order for Direct Routing telephone numbers.
141+
142+
### Example 5
143+
```powershell
144+
PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId faef09f7-5bd5-4740-9e76-9a5762380f34
145+
146+
Key Value
147+
--- -----
148+
OrderId faef09f7-5bd5-4740-9e76-9a5762380f34
149+
CreatedAt 2024-11-30T00:22:59.4989508+00:00
150+
Status Success
151+
TotalCount 1
152+
SuccessCount 1
153+
FailureCount 0
154+
WarningCount 0
155+
FailedPhoneNumbers {}
156+
WarningPhoneNumbers {}
157+
SuccessPhoneNumbers {+99999980}
158+
```
159+
160+
This example returns the status of a successful upload order for a Direct Routing phone number.
161+
88162
## PARAMETERS
89163

90-
### OrderId
91-
Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id.
164+
### -OrderId
165+
Use the OrderId received as output of your order creation cmdlets.
92166

93167
```yaml
94168
Type: String
@@ -102,21 +176,40 @@ Accept pipeline input: False
102176
Accept wildcard characters: False
103177
```
104178
179+
### -OrderType
180+
Specifies the type of telephone number order to look up. Currently supported values are **Search**, **Release**, and **DirectRoutingNumberCreation**. If this value is unspecified, then it will default to a **Search** order.
181+
182+
```yaml
183+
Type: String
184+
Parameter Sets: (All)
185+
Aliases:
186+
187+
Required: False
188+
Position: Named
189+
Default value: None
190+
Accept pipeline input: False
191+
Accept wildcard characters: False
192+
```
193+
105194
### CommonParameters
106-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
195+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
107196
108197
## INPUTS
109198
110199
## OUTPUTS
111200
112201
## NOTES
202+
Updates in Teams PowerShell Module version 6.7.1 and later:
203+
- A new optional parameter `OrderType` is introduced. If no OrderType is provided, it will default to a Search order.
204+
- [BREAKING CHANGE] When a Search order is queried, the property name `TelephoneNumber` in the output will be changed to `TelephoneNumbers`. The structure of the `TelephoneNumbers` output will remain unchanged.
205+
- Impact: Scripts and processes that reference the `TelephoneNumber` property will need to be updated to use `TelephoneNumbers`.
113206

114207
## RELATED LINKS
115-
116208
[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry)
117209
[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry)
118-
119210
[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder)
120211
[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder)
121212
[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder)
122213
[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder)
214+
[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder)
215+
[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder)

0 commit comments

Comments
 (0)