-
Notifications
You must be signed in to change notification settings - Fork 180
/
Group.yml
220 lines (220 loc) · 8.5 KB
/
Group.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
### YamlMime:TSType
name: Group
uid: '@azure/arm-apimanagement.Group'
package: '@azure/arm-apimanagement'
summary: Interface representing a Group.
fullName: Group
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, string, GroupCreateParameters,
GroupCreateOrUpdateOptionalParams)
uid: '@azure/arm-apimanagement.Group.createOrUpdate'
package: '@azure/arm-apimanagement'
summary: Creates or Updates a group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, serviceName: string,
groupId: string, parameters: GroupCreateParameters, options?:
GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>
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: groupId
type: string
description: >-
Group identifier. Must be unique in the current API Management
service instance.
- id: parameters
type: <xref uid="@azure/arm-apimanagement.GroupCreateParameters" />
description: Create parameters.
- id: options
type: >-
<xref
uid="@azure/arm-apimanagement.GroupCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-apimanagement.GroupCreateOrUpdateResponse" />>
- name: delete(string, string, string, string, GroupDeleteOptionalParams)
uid: '@azure/arm-apimanagement.Group.delete'
package: '@azure/arm-apimanagement'
summary: Deletes specific group of the API Management service instance.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, serviceName: string, groupId:
string, ifMatch: string, options?: GroupDeleteOptionalParams):
Promise<void>
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: groupId
type: string
description: >-
Group identifier. Must be unique in the current API Management
service instance.
- id: ifMatch
type: string
description: >-
ETag of the Entity. ETag should match the current entity state from
the header
response of the GET request or it should be * for unconditional update.
- id: options
type: <xref uid="@azure/arm-apimanagement.GroupDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, GroupGetOptionalParams)
uid: '@azure/arm-apimanagement.Group.get'
package: '@azure/arm-apimanagement'
summary: Gets the details of the group specified by its identifier.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, serviceName: string, groupId:
string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>
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: groupId
type: string
description: >-
Group identifier. Must be unique in the current API Management
service instance.
- id: options
type: <xref uid="@azure/arm-apimanagement.GroupGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-apimanagement.GroupGetResponse"
/>>
- name: getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)
uid: '@azure/arm-apimanagement.Group.getEntityTag'
package: '@azure/arm-apimanagement'
summary: >-
Gets the entity state (Etag) version of the group specified by its
identifier.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getEntityTag(resourceGroupName: string, serviceName: string,
groupId: string, options?: GroupGetEntityTagOptionalParams):
Promise<GroupGetEntityTagHeaders>
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: groupId
type: string
description: >-
Group identifier. Must be unique in the current API Management
service instance.
- id: options
type: >-
<xref uid="@azure/arm-apimanagement.GroupGetEntityTagOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-apimanagement.GroupGetEntityTagHeaders" />>
- name: listByService(string, string, GroupListByServiceOptionalParams)
uid: '@azure/arm-apimanagement.Group.listByService'
package: '@azure/arm-apimanagement'
summary: Lists a collection of groups defined within a service instance.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByService(resourceGroupName: string, serviceName: string,
options?: GroupListByServiceOptionalParams):
PagedAsyncIterableIterator<GroupContract, GroupContract[], 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: options
type: >-
<xref
uid="@azure/arm-apimanagement.GroupListByServiceOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-apimanagement.GroupContract" />, <xref
uid="@azure/arm-apimanagement.GroupContract" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
update(string, string, string, string, GroupUpdateParameters,
GroupUpdateOptionalParams)
uid: '@azure/arm-apimanagement.Group.update'
package: '@azure/arm-apimanagement'
summary: Updates the details of the group specified by its identifier.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceGroupName: string, serviceName: string, groupId:
string, ifMatch: string, parameters: GroupUpdateParameters, options?:
GroupUpdateOptionalParams): Promise<GroupUpdateResponse>
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: groupId
type: string
description: >-
Group identifier. Must be unique in the current API Management
service instance.
- id: ifMatch
type: string
description: >-
ETag of the Entity. ETag should match the current entity state from
the header
response of the GET request or it should be * for unconditional update.
- id: parameters
type: <xref uid="@azure/arm-apimanagement.GroupUpdateParameters" />
description: Update parameters.
- id: options
type: <xref uid="@azure/arm-apimanagement.GroupUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-apimanagement.GroupUpdateResponse"
/>>