UserSubscription interface

Package:

@azure/arm-apimanagement

Interface representing a UserSubscription.

Methods

get(string, string, string, string, UserSubscriptionGetOptionalParams)	Gets the specified Subscription entity associated with a particular user.
list(string, string, string, UserSubscriptionListOptionalParams)	Lists the collection of subscriptions of the specified user.

Method Details

get(string, string, string, string, UserSubscriptionGetOptionalParams)

Gets the specified Subscription entity associated with a particular user.

function get(resourceGroupName: string, serviceName: string, userId: string, sid: string, options?: UserSubscriptionGetOptionalParams): Promise<UserSubscriptionGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

userId

string

User identifier. Must be unique in the current API Management service instance.

sid

string

Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

options

UserSubscriptionGetOptionalParams

The options parameters.

Returns

Promise<UserSubscriptionGetResponse>

list(string, string, string, UserSubscriptionListOptionalParams)

Lists the collection of subscriptions of the specified user.

function list(resourceGroupName: string, serviceName: string, userId: string, options?: UserSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

userId

string

User identifier. Must be unique in the current API Management service instance.

options

UserSubscriptionListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>