New-CsOnlineTelephoneNumberReleaseOrder
This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory.
Syntax
Default (Default)
New-CsOnlineTelephoneNumberReleaseOrder
[-TelephoneNumber <String>]
[-StartingNumber <String>]
[-EndingNumber <String>]
[-FileContent <Byte[]>]
[<CommonParameters>]
Description
This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired telephone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 numbers need to be released, the requests should be divided into multiple increments of up to 1,000 numbers.
The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the
Get-CsOnlineTelephoneNumberOrder
cmdlet to check the status of the OrderId, including any error or warning messages that might result
from the operation: Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId".
Examples
Example 1
PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789"
cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13
In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone number management inventory.
Example 2
PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901"
cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13
In this example, a list of telephone numbers are being released from Microsoft Teams telephone number management.
Example 3
PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009"
cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13
In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management.
Example 4
PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv")
PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist
cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13
In this example, the content of a file with a list of telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of telephone numbers to be released. The New-CsOnlineTelephoneNumberReleaseOrder cmdlet is only used to pass the content.
Parameters
-EndingNumber
This is the ending number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FileContent
This is the content of a .csv file that includes the telephone numbers to be released from the Microsoft Teams telephone number management inventory. This parameter can be used to release up to 1,000 numbers at a time.
Parameter properties
| Type: | Byte[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StartingNumber
This is the starting number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TelephoneNumber
This is the telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.String
Notes
The cmdlet is available in Teams PowerShell module 6.7.1 or later.
The cmdlet is only available in commercial and GCC cloud instances.