-
Notifications
You must be signed in to change notification settings - Fork 181
/
UserSubscription.yml
85 lines (85 loc) · 3.27 KB
/
UserSubscription.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
### YamlMime:TSType
name: UserSubscription
uid: '@azure/arm-apimanagement.UserSubscription'
package: '@azure/arm-apimanagement'
summary: Interface representing a UserSubscription.
fullName: UserSubscription
remarks: ''
isDeprecated: false
type: interface
methods:
- name: get(string, string, string, string, UserSubscriptionGetOptionalParams)
uid: '@azure/arm-apimanagement.UserSubscription.get'
package: '@azure/arm-apimanagement'
summary: Gets the specified Subscription entity associated with a particular user.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, serviceName: string, userId:
string, sid: string, options?: UserSubscriptionGetOptionalParams):
Promise<UserSubscriptionGetResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of the API Management service.
- id: userId
type: string
description: >-
User identifier. Must be unique in the current API Management
service instance.
- id: sid
type: string
description: >-
Subscription entity Identifier. The entity represents the
association between a user and
a product in API Management.
- id: options
type: >-
<xref
uid="@azure/arm-apimanagement.UserSubscriptionGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-apimanagement.UserSubscriptionGetResponse" />>
- name: list(string, string, string, UserSubscriptionListOptionalParams)
uid: '@azure/arm-apimanagement.UserSubscription.list'
package: '@azure/arm-apimanagement'
summary: Lists the collection of subscriptions of the specified user.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, serviceName: string, userId:
string, options?: UserSubscriptionListOptionalParams):
PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of the API Management service.
- id: userId
type: string
description: >-
User identifier. Must be unique in the current API Management
service instance.
- id: options
type: >-
<xref
uid="@azure/arm-apimanagement.UserSubscriptionListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-apimanagement.SubscriptionContract" />, <xref
uid="@azure/arm-apimanagement.SubscriptionContract" />[], <xref
uid="@azure/core-paging.PageSettings" />>