Edit

Share via

Get-CsExportAcquiredPhoneNumberStatus

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

This cmdlet shows the status of the Export-CsAcquiredPhoneNumber cmdlet.

Syntax

Get-CsExportAcquiredPhoneNumberStatus
   -OrderId <String>
   [<CommonParameters>]

Description

This cmdlet returns OrderId status from the respective Export-CsAcquiredPhoneNumber operation. The response will include the download link to the file if operation has been completed.

By default, the download link will remain active for 1 hour.

Examples

Example 1

PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId 0e923e2c-ab0e-4b7a-be5a-906be8c

Id                   : 0e923e2c-ab0e-4b7a-be5a-906be8c
CreatedAt            : 2024-08-29 21:50:54Z
status               : Success
DownloadLinkExpiry   : 2024-08-29 22:51:17Z
DownloadLink         : <link>

This example displays the status of the export acquired phone numbers operation. The OrderId is the output from Export-CsAcquiredPhoneNumber cmdlet. The status contains the download link for the file along with expiry date.

Example 2

PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId

Id                   : 0e923e2c-ab0e-4b7a-be5a-906be8c
CreatedAt            : 2024-08-29 21:50:54Z
status               : Success
DownloadLinkExpiry   : 2024-08-29 22:51:17Z
DownloadLink         : <link>

This example displays the status of the export acquired phone numbers operation with the use of a variable named "orderId".

Example 3

PS C:\> $order = Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId
PS C:\> $order

Id                   : 0e923e2c-ab0e-4b7a-be5a-906be8c
CreatedAt            : 2024-08-29 21:50:54Z
status               : Success
DownloadLinkExpiry   : 2024-08-29 22:51:17Z
DownloadLink         : <link>

This example stores the Get-CsExportAcquiredPhoneNumberStatus cmdlet status for the "orderId" in the variable "order". This will allow a quick view of the order status without typing the cmdlet again.

Parameters

-OrderId

The orderId of the ExportAcquiredNumberStatus cmdlet.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity

Outputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtGetExportAcquiredTelephoneNumbersResponse

Notes

The cmdlet is available in Teams PowerShell module 6.1.0 or later.

The cmdlet is only available in commercial and GCC cloud instances.