|
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) |
| 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 tenant. |
| 18 | + |
| 19 | +## SYNTAX |
| 20 | + |
| 21 | +``` |
| 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 | +**Available properties to use are: ** |
| 31 | + |
| 32 | +- TelephoneNumber |
| 33 | +- OperatorId |
| 34 | +- NumberType |
| 35 | +- LocationId |
| 36 | +- CivicAddressId |
| 37 | +- NetworkSiteId |
| 38 | +- AvailableCapabilities |
| 39 | +- AcquiredCapabilities |
| 40 | +- BlockId |
| 41 | +- RangeId |
| 42 | +- AssignmentStatus |
| 43 | +- PlaceName |
| 44 | +- ActivationState |
| 45 | +- PartnerName |
| 46 | +- IsOperatorConnect |
| 47 | +- IsoCountryCode |
| 48 | +- PortInOrderStatus |
| 49 | +- DsuSupported |
| 50 | +- CapabilityUpdateSupported |
| 51 | +- LocationUpdateSupported |
| 52 | +- AcquisitionDate |
| 53 | +- TargetId |
| 54 | +- TargetType |
| 55 | +- AssignmentCategory |
| 56 | +- SmsCampaignBriefs |
| 57 | +- CallingProfileId |
| 58 | +- IsoSubdivisionCode |
| 59 | +- NumberSource |
| 60 | +- ResourceAccountSharedCallingPolicySupported |
| 61 | +- SupportedCustomerActions |
| 62 | +- ReverseNumberLookup |
| 63 | +- RoutingOptions |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +## EXAMPLES |
| 68 | + |
| 69 | +### Example 1 |
| 70 | +```powershell |
| 71 | +Export-CsAcquiredPhoneNumber |
| 72 | +``` |
| 73 | +```output |
| 74 | +OrderId : 0e923e2c-ab0e-4b7a-be5a-906be8c |
| 75 | +``` |
| 76 | +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. |
| 77 | + |
| 78 | +### Example 2 |
| 79 | +```powershell |
| 80 | +Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus" |
| 81 | +``` |
| 82 | +```output |
| 83 | +OrderId : 0e923e2c-ab0e-6h8c-be5a-906be8c |
| 84 | +``` |
| 85 | +This example displays the OrderId of the export acquired phone numbers operation. This file will only contain the properties indicated. |
| 86 | + |
| 87 | +## PARAMETERS |
| 88 | + |
| 89 | +### -Property |
| 90 | +{{ Fill Property Description }} |
| 91 | + |
| 92 | +```yaml |
| 93 | +Type: String |
| 94 | +Parameter Sets: (All) |
| 95 | +Aliases: |
| 96 | + |
| 97 | +Required: False |
| 98 | +Position: Named |
| 99 | +Default value: None |
| 100 | +Accept pipeline input: False |
| 101 | +Accept wildcard characters: False |
| 102 | +``` |
| 103 | +
|
| 104 | +
|
| 105 | +### 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](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 107 | +
|
| 108 | +## INPUTS |
| 109 | +
|
| 110 | +### None |
| 111 | +
|
| 112 | +## OUTPUTS |
| 113 | +
|
| 114 | +### System.String |
| 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) |
0 commit comments