Share via

Get-MgmtSvcSubscription

  • Reference
Module:
MgmtSvcAdmin

Gets a subscription.

Syntax

Get-MgmtSvcSubscription
   [[-UserName] <String>]
   [-Skip <Int32>]
   [-First <Int32>]
   [-SortProperty <String>]
   [-Descending]
   [-AdminUri] <Uri>
   [-Token] <String>
   [-DisableCertificateValidation]
   [<CommonParameters>]
Get-MgmtSvcSubscription
   [[-UserName] <String>]
   [-AddOnId <String>]
   [-Skip <Int32>]
   [-First <Int32>]
   [-SortProperty <String>]
   [-Descending]
   [-AdminUri] <Uri>
   [-Token] <String>
   [-DisableCertificateValidation]
   [<CommonParameters>]
Get-MgmtSvcSubscription
   [[-UserName] <String>]
   [-PlanId <String>]
   [-Skip <Int32>]
   [-First <Int32>]
   [-SortProperty <String>]
   [-Descending]
   [-AdminUri] <Uri>
   [-Token] <String>
   [-DisableCertificateValidation]
   [<CommonParameters>]
Get-MgmtSvcSubscription
   [-SubscriptionId <Guid>]
   [-Skip <Int32>]
   [-First <Int32>]
   [-SortProperty <String>]
   [-Descending]
   [-AdminUri] <Uri>
   [-Token] <String>
   [-DisableCertificateValidation]
   [<CommonParameters>]

Description

The Get-MgmtSvcSubscription cmdlet gets a subscription.

Examples

Example 1: Get a subscription by user name

PS C:\> Get-MgmtSvcSubscription -UserName 'admin@Contoso.com' -AdminUri "https://Computer01:30004" -Token $Token -DisableCertificateValidation

NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.

This command gets the subscription for the user admin@Contoso.com.

Parameters

-AddOnId

Specifies the ID of an add-on.

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

-AdminUri

Specifies the URI of the Windows Azure Pack administrator API. Use the following format: https://<computer>:<port>, where <computer> is the computer on which the administrator API is installed.

Type:Uri
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Descending

Indicates that the subscriptions are returned in descending order.

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

-DisableCertificateValidation

Disables certificate validation for the Windows Azure Pack installation.

If you specify this parameter, you can use self-signed certificates.

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

-First

Gets only the specified number of objects. Enter the number of objects to get.

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

-PlanId

Specifies the ID for a plan.

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

-Skip

Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.

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

-SortProperty

Specifies the property by which to sort results.

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

-SubscriptionId

Specifies, as a GUID, the ID of a subscription.

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

-Token

Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.

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

-UserName

Specifies a user name.

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