Skip to content

Commit 7ca67b7

Browse files
TristanChen-msftTristanChen-msft
committed
Addig Telephone Number Search and Acquire cmdlet
1 parent ce4d848 commit 7ca67b7

6 files changed

+775
-0
lines changed

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

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder
4+
Module Name: MicrosoftTeams
5+
title: Clear-CsOnlineTelephoneNumberOrder
6+
schema: 2.0.0
7+
manager: mreddy
8+
author: jiaych
9+
ms.author: jiaych
10+
ms.reviewer:
11+
---
12+
13+
# Clear-CsOnlineTelephoneNumberOrder
14+
15+
## SYNOPSIS
16+
17+
Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire.
18+
19+
## SYNTAX
20+
21+
```
22+
Clear-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire.
28+
29+
## EXAMPLES
30+
31+
### -------------------------- Example 1 --------------------------
32+
```
33+
PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
34+
PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
35+
36+
AreaCode :
37+
CivicAddressId :
38+
CountryCode : US
39+
CreatedAt : 8/23/2021 5:43:44 PM
40+
Description : test
41+
ErrorCode : NoError
42+
Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
43+
InventoryType : Subscriber
44+
IsManual : False
45+
Name : test
46+
NumberPrefix : 1718
47+
NumberType : UserSubscriber
48+
Quantity : 1
49+
ReservationExpiryDate : 8/23/2021 5:59:45 PM
50+
SearchType : Prefix
51+
SendToServiceDesk : False
52+
Status : Cancelled
53+
TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult}
54+
55+
PS C:\> $order.TelephoneNumber
56+
57+
Location TelephoneNumber
58+
-------- ---------------
59+
New York City +17182000004
60+
```
61+
62+
This example cancels the purchase of the telephone number order containing the phone number +17182000004.
63+
64+
65+
## PARAMETERS
66+
67+
### OrderId
68+
Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id.
69+
70+
```yaml
71+
Type: String
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
## INPUTS
83+
84+
## OUTPUTS
85+
86+
This cmdlet does not have a response object.
87+
88+
## RELATED LINKS
89+
90+
[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md)
91+
[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md)
92+
93+
[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md)
94+
[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md)
95+
[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md)
96+
[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md)

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

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder
4+
Module Name: MicrosoftTeams
5+
title: Complete-CsOnlineTelephoneNumberOrder
6+
schema: 2.0.0
7+
manager: mreddy
8+
author: jiaych
9+
ms.author: jiaych
10+
ms.reviewer:
11+
---
12+
13+
# Complete-CsOnlineTelephoneNumberOrder
14+
15+
## SYNOPSIS
16+
17+
Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization.
18+
19+
## SYNTAX
20+
21+
```
22+
Complete-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization.
28+
29+
30+
## EXAMPLES
31+
32+
### -------------------------- Example 1 --------------------------
33+
```
34+
PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
35+
PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
36+
37+
AreaCode :
38+
CivicAddressId :
39+
CountryCode : US
40+
CreatedAt : 8/23/2021 5:43:44 PM
41+
Description : test
42+
ErrorCode : NoError
43+
Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
44+
InventoryType : Subscriber
45+
IsManual : False
46+
Name : test
47+
NumberPrefix : 1718
48+
NumberType : UserSubscriber
49+
Quantity : 1
50+
ReservationExpiryDate : 8/23/2021 5:59:45 PM
51+
SearchType : Prefix
52+
SendToServiceDesk : False
53+
Status : Completed
54+
TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult}
55+
56+
PS C:\> $order.TelephoneNumber
57+
58+
Location TelephoneNumber
59+
-------- ---------------
60+
New York City +17182000004
61+
```
62+
63+
This example completes the purchase of the telephone number order containing the phone number +17182000004.
64+
65+
66+
## PARAMETERS
67+
68+
### OrderId
69+
Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: (All)
74+
Aliases:
75+
76+
Required: True
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
## INPUTS
84+
85+
## OUTPUTS
86+
87+
This cmdlet does not have a response object.
88+
89+
## RELATED LINKS
90+
91+
[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md)
92+
[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md)
93+
94+
[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md)
95+
[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md)
96+
[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md)
97+
[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md)

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry
4+
Module Name: MicrosoftTeams
5+
title: Get-CsOnlineTelephoneNumberCountry
6+
schema: 2.0.0
7+
manager: mreddy
8+
author: jiaych
9+
ms.author: jiaych
10+
ms.reviewer:
11+
---
12+
13+
# Get-CsOnlineTelephoneNumberCountry
14+
15+
## SYNOPSIS
16+
Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization.
17+
18+
## SYNTAX
19+
20+
```
21+
PS C:\> Get-CsOnlineTelephoneNumberCountry [<CommonParameters>]
22+
```
23+
24+
```output
25+
Name Value
26+
---- -----
27+
Antigua and Barbuda AG
28+
Argentina AR
29+
Australia AU
30+
Austria AT
31+
...
32+
United Kingdom GB
33+
United States US
34+
Uruguay UY
35+
Venezuela VE
36+
Vietnam VN
37+
```
38+
39+
## DESCRIPTION
40+
41+
Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization.
42+
43+
## EXAMPLES
44+
45+
### -------------------------- Example 1 --------------------------
46+
```
47+
Get-CsOnlineTelephoneNumberCountry
48+
```
49+
This example returns the list of supported countries or regions for the cmdlet search and acquire of new telephone numbers.
50+
51+
## PARAMETERS
52+
53+
This cmdlet requires no additional parameters.
54+
55+
## INPUTS
56+
57+
This cmdlet requires no additional inputs.
58+
59+
## OUTPUTS
60+
61+
This cmdlet returns a list of supported countries or regions.
62+
63+
## RELATED LINKS
64+
[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md)
65+
[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md)
66+
67+
[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md)
68+
[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md)
69+
[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md)
70+
[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md)

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

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder
4+
Module Name: MicrosoftTeams
5+
title: Get-CsOnlineTelephoneNumberOrder
6+
schema: 2.0.0
7+
manager: mreddy
8+
author: jiaych
9+
ms.author: jiaych
10+
ms.reviewer:
11+
---
12+
13+
# Get-CsOnlineTelephoneNumberOrder
14+
15+
## 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.
17+
18+
## SYNTAX
19+
20+
```
21+
Get-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
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+
28+
29+
## EXAMPLES
30+
31+
### -------------------------- Example 1 --------------------------
32+
```
33+
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
34+
35+
AreaCode :
36+
CivicAddressId :
37+
CountryCode : US
38+
CreatedAt : 8/23/2021 5:43:44 PM
39+
Description : test
40+
ErrorCode : NoError
41+
Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912
42+
InventoryType : Subscriber
43+
IsManual : False
44+
Name : test
45+
NumberPrefix : 1718
46+
NumberType : UserSubscriber
47+
Quantity : 1
48+
ReservationExpiryDate : 8/23/2021 5:59:45 PM
49+
SearchType : Prefix
50+
SendToServiceDesk : False
51+
Status : Reserved
52+
TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult}
53+
54+
PS C:\> $order.TelephoneNumber
55+
56+
Location TelephoneNumber
57+
-------- ---------------
58+
New York City +17182000004
59+
```
60+
61+
This example returns a successful telephone number search and the telephone number +17182000004 is reserved for purchase.
62+
63+
### -------------------------- Example 2 --------------------------
64+
```
65+
PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042
66+
67+
AreaCode :
68+
CivicAddressId :
69+
CountryCode : US
70+
CreatedAt : 8/23/2021 6:53:12 PM
71+
Description : test
72+
ErrorCode : OutOfStock
73+
Id : 8d23e073-bc98-4f73-8e05-7517655d7042
74+
InventoryType : Subscriber
75+
IsManual : False
76+
Name : test
77+
NumberPrefix : 1425
78+
NumberType : UserSubscriber
79+
Quantity : 1
80+
ReservationExpiryDate :
81+
SearchType : Prefix
82+
SendToServiceDesk : False
83+
Status : Error
84+
TelephoneNumber : {}
85+
```
86+
87+
This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`.
88+
89+
90+
## PARAMETERS
91+
92+
### OrderId
93+
Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id.
94+
95+
```yaml
96+
Type: String
97+
Parameter Sets: (All)
98+
Aliases:
99+
100+
Required: True
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
## INPUTS
108+
109+
## OUTPUTS
110+
111+
This cmdlet returns an order report of a specific telephone number search order.
112+
113+
## RELATED LINKS
114+
115+
[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md)
116+
[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md)
117+
118+
[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md)
119+
[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md)
120+
[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md)
121+
[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md)

0 commit comments

Comments
 (0)