Get-MgmtSvcSubscription

Gets a subscription.

Syntax

Get-MgmtSvcSubscription [-AdminUri] <Uri> [-Token] <String> [[-UserName] <String>] [-AddOnId <String>]
 [-Descending] [-DisableCertificateValidation] [-First <Int32>] [-Skip <Int32>] [-SortProperty <String>]
 [<CommonParameters>]
Get-MgmtSvcSubscription [-AdminUri] <Uri> [-Token] <String> [[-UserName] <String>] [-Descending]
 [-DisableCertificateValidation] [-First <Int32>] [-PlanId <String>] [-Skip <Int32>] [-SortProperty <String>]
 [<CommonParameters>]
Get-MgmtSvcSubscription [-AdminUri] <Uri> [-Token] <String> [-Descending] [-DisableCertificateValidation]
 [-First <Int32>] [-Skip <Int32>] [-SortProperty <String>] [-SubscriptionId <Guid>] [<CommonParameters>]
Get-MgmtSvcSubscription [-AdminUri] <Uri> [-Token] <String> [[-UserName] <String>] [-Descending]
 [-DisableCertificateValidation] [-First <Int32>] [-Skip <Int32>] [-SortProperty <String>] [<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
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Descending

Indicates that the subscriptions are returned in descending order.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:False
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-PlanId

Specifies the ID for a plan.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Required:False
Position:Named
Default value:False
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-SortProperty

Specifies the property by which to sort results.

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

-SubscriptionId

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

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

-Token

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

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

-UserName

Specifies a user name.

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