Skip to content

Commit f3a906b

Browse files
pavellatifpavellatif
authored
Adding new cmdlets for Phone Number Export
1 parent 2288b07 commit f3a906b

File tree

2 files changed

+240
-0
lines changed

2 files changed

+240
-0
lines changed

‎Export-CsAcquiredPhoneNumber.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber
5+
applicable: Microsoft Teams
6+
title: Export-CsAcquiredPhoneNumber
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer:
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Export-CsAcquiredPhoneNumber
15+
16+
## SYNOPSIS
17+
This cmdlet exports the list of phone numbers acquired by Teams Phone System tenant.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Export-CsAcquiredPhoneNumber [-Property <string>]
23+
```
24+
25+
## DESCRIPTION
26+
This cmdlet exports all the acquired phone numbers by the tenant to a file. The cmdlet is an asynchronus operation and will return an OrderId. [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) cmdlet can be used to check the status of the OrderId including the download link to exported file.
27+
28+
By default, this cmdlet returns all the phone numbers acquired by the tenant with all corresponding properties in the results. The tenant admin may indicate specific properties as an input to get a list with only selected properties in the file.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
Export-CsAcquiredPhoneNumber
35+
```
36+
```output
37+
OrderId : 0e923e2c-ab0e-4b7a-be5a-906be8c
38+
```
39+
This example displays the OrderId of the export acquired phone numbers operation. The OrderId can be used to get the download link for the file.
40+
41+
### Example 2
42+
```powershell
43+
Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus"
44+
```
45+
```output
46+
OrderId : 0e923e2c-ab0e-6h8c-be5a-906be8c
47+
```
48+
This example displays the OrderId of the export acquired phone numbers operation. This file will only contain the properties indicated.
49+
50+
51+
## PARAMETERS
52+
53+
### -Property
54+
Filters the returned results to only show the indicated properties in the file.
55+
```yaml
56+
Type: String
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
#### Available properties to use are:
68+
69+
```yaml
70+
- TelephoneNumber
71+
- OperatorId
72+
- NumberType
73+
- LocationId
74+
- CivicAddressId
75+
- NetworkSiteId
76+
- AvailableCapabilities
77+
- AcquiredCapabilities
78+
- BlockId
79+
- RangeId
80+
- AssignmentStatus
81+
- PlaceName
82+
- ActivationState
83+
- PartnerName
84+
- IsOperatorConnect
85+
- IsoCountryCode
86+
- PortInOrderStatus
87+
- DsuSupported
88+
- CapabilityUpdateSupported
89+
- LocationUpdateSupported
90+
- AcquisitionDate
91+
- TargetId
92+
- TargetType
93+
- AssignmentCategory
94+
- SmsCampaignBriefs
95+
- CallingProfileId
96+
- IsoSubdivisionCode
97+
- NumberSource
98+
- ResourceAccountSharedCallingPolicySupported
99+
- SupportedCustomerActions
100+
- ReverseNumberLookup
101+
- RoutingOptions
102+
```
103+
104+
### CommonParameters
105+
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).
106+
107+
## INPUTS
108+
109+
### None
110+
111+
## OUTPUTS
112+
```yaml
113+
OrderId
114+
```
115+
116+
## NOTES
117+
The cmdlet is available in Teams PowerShell module 6.1.0 or later.
118+
119+
The cmdlet is only available in commercial and GCC cloud instances.
120+
121+
## RELATED LINKS
122+
[Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md)

‎Get-CsExportAcquiredPhoneNumberStatus.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus
5+
applicable: Microsoft Teams
6+
title: Get-CsExportAcquiredPhoneNumberStatus
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer:
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Get-CsExportAcquiredPhoneNumberStatus
15+
16+
## SYNOPSIS
17+
This cmdlet exports the list of phone numbers acquired by Teams Phone System tenant.
18+
19+
## SYNTAX
20+
21+
### Get-CsExportAcquiredPhoneNumberStatus (Default)
22+
```
23+
Get-CsExportAcquiredPhoneNumberStatus -OrderId <String>
24+
```
25+
26+
## DESCRIPTION
27+
This cmdlet returns the status of the [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) operation. The response will include the download link to the file if operation has been completed.
28+
29+
By Default the download link will remain active for 1 hour.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
Get-CsExportAcquiredPhoneNumberStatus -OrderId 0e923e2c-ab0e-4b7a-be5a-906be8c
36+
```
37+
This example displays the OrderId of the export acquired phone numbers operation. The OrderId can be used to get the download link for the file.
38+
39+
## PARAMETERS
40+
41+
### -OrderId
42+
Filters the returned results to only show the indicated properties in the file.
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: Named
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### CommonParameters
56+
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).
57+
58+
## INPUTS
59+
60+
### -OrderId
61+
62+
## OUTPUTS
63+
64+
### Pending
65+
The output shows the status Pending when the request is created but processing has not been started.
66+
67+
```yaml
68+
Id : 0e923e2c-af0e-4b7a-be5a-906be8c
69+
CreatedAt : 6/24/2024 9:26:44 PM
70+
CreatedBy : [email protected]
71+
Status : Pending
72+
DownloadLinkExpiry : null
73+
DownloadLink : null
74+
```
75+
76+
### InProgress
77+
The output shows the status InProgress when the request is being processed.
78+
79+
```yaml
80+
Id : 0e923e2c-af0e-4b7a-be5a-906be8c
81+
CreatedAt : 6/24/2024 9:26:44 PM
82+
CreatedBy : [email protected]
83+
Status : InProgress
84+
DownloadLinkExpiry : null
85+
DownloadLink : null
86+
```
87+
88+
### Success
89+
The output shows the status Success with download link and expiry date for the link when the request is completed successfully.
90+
91+
```yaml
92+
Id : 0e923e2c-ab0e-4b7a-be5a-906be8c
93+
CreatedAt : 6/24/2024 9:16:44 PM
94+
CreatedBy : [email protected]
95+
Status : Success
96+
DownloadLinkExpiry : 6/24/2024 10:17:29 PM
97+
DownloadLink : https://<downloadLink>
98+
```
99+
100+
### Failure
101+
The output shows the status Success with download link and expiry date for the link when the request is completed successfully.
102+
103+
```yaml
104+
Id : 0e923d2c-ab0e-4b7a-bg5a-906be8c
105+
CreatedAt : 6/24/2024 9:36:44 PM
106+
CreatedBy : [email protected]
107+
Status : Failure
108+
ErrorMessage : <Error message related to failure>
109+
```
110+
111+
## NOTES
112+
113+
The cmdlet is available in Teams PowerShell module 6.1.0 or later.
114+
115+
The cmdlet is only available in commercial and GCC cloud instances.
116+
117+
## RELATED LINKS
118+
[Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md)

0 commit comments

Comments
 (0)