Interface UserSubscription

Package version

Interface representing a UserSubscription.

Hierarchy

UserSubscription

Implemented by

UserSubscriptionImpl

Index

Methods

get
list

Methods

get

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

- Defined in operationsInterfaces/userSubscription.ts:42
Gets the specified Subscription entity associated with a particular user.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: UserSubscriptionGetOptionalParams
  
  The options parameters.
Returns Promise<UserSubscriptionGetResponse>

list

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

- Defined in operationsInterfaces/userSubscription.ts:27
Lists the collection of subscriptions of the specified user.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- Optional options: UserSubscriptionListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SubscriptionContract>

Generated using TypeDoc