Get-MgmtSvcSubscription

Get-MgmtSvcSubscription

Gets a subscription.

Syntax

Parameter Set: Default
Get-MgmtSvcSubscription [-AdminUri] <Uri> [-Token] <String> [[-UserName] <String> ] [-Descending] [-DisableCertificateValidation] [-First <Int32> ] [-Skip <Int32> ] [ <CommonParameters>]


 

Detailed Description

The Get-MgmtSvcSubscription cmdlet gets a subscription.

Parameters

-AdminUri<Uri>

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.

 

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Descending

Indicates that the subscriptions are returned in descending order.

 

Aliases

none

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 specifiy this parameter, you can use self-signed certificates.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-First<Int32>

Gets only the specified number of subscriptions.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Skip<Int32>

Skips the specified number of subscriptions.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Token<String>

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

 

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-UserName<String>

Specifies a user name.

 

Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Get a subscription by user name

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.

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

 

Related topics

Add-MgmtSvcSubscription

Get-MgmtSvcSubscription

Disable-MgmtSvcSubscription

Enable-MgmtSvcSubscription

Move-MgmtSvcSubscription

Sync-MgmtSvcSubscription

Remove-MgmtSvcSubscription