Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Latest commit

 

History

History
131 lines (89 loc) · 3.12 KB

Get-PCSubscription.md

File metadata and controls

131 lines (89 loc) · 3.12 KB

Get-PCSubscription

Returns a list of subscriptions for the specified tenant.

SYNTAX

Get-PCSubscription [-TenantId <String>] [-SaToken <String>] [-SubscriptionId <String>] [-AddOns] [<CommonParameters>]

Get-PCSubscription [-TenantId <String>] [-SaToken <String>] -PartnerId <String> [-ResultSize <Int32>] [<CommonParameters>]

Get-PCSubscription [-TenantId <String>] [-SaToken <String>] [-OrderId <String>] [<CommonParameters>]

DESCRIPTION

The Get-PCSubscription cmdlet returns a list of subscriptions for a specified customer tenant or MPN partner id.

PARAMETERS

-TenantId <String>

Specifies the tenant used for scoping this cmdlet. The tenant must be specified either using this parameter or by using the Select-PCCustomer cmdlet.

Required?                    false
Position?                    named
Default value                $GlobalCustomerId
Accept pipeline input?       false
Accept wildcard characters?  false

-SaToken <String>

Specifies an authentication token with your Partner Center credentials.

Required?                    false
Position?                    named
Default value                $GlobalToken
Accept pipeline input?       false
Accept wildcard characters?  false

-SubscriptionId <String>

Specifies a subscription id for which to return detailed information.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-AddOns <SwitchParameter>

Specifies whether you want to return any addons for the subscription.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Accept wildcard characters?  false

-PartnerId <String>

Specifies the Mpn partner id for which to list the subscriptions.

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-OrderId <String>

Specifies an order id to for which to return a list of subscriptions.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

INPUTS

OUTPUTS

NOTES

EXAMPLES

EXAMPLE 1

Return a list of all subscriptions for the specified partner id

PS C:\>Get-PCSubscription  -PartnerId '46662300'

EXAMPLE 2

Return information about the specified subscription.

PS C:\>Get-PCSubscription -TenantId 99ed2a33-e3ea-34df-bade-30997e2413e5 -SubscriptionId 335c4cad-b235-4a31-8273-e73da43e7817

EXAMPLE 3

Return a list of subscriptions from an order.

PS C:\>Get-PCSubscription -TenantId 99ed2a33-e3ea-34df-bade-30997e2413e5 -OrderId 335c4cad-b235-4a31-8273-e73da43e7817

EXAMPLE 4

Return a list of customer subscriptions from a reseller (Only available in an Indirect Provider tenant)

PS C:\>Get-PCSubscription -TenantId 99ed2a33-e3ea-34df-bade-30997e2413e5 -PartnerId '46662300'