-
Notifications
You must be signed in to change notification settings - Fork 180
/
EventHubs.yml
353 lines (352 loc) · 13.5 KB
/
EventHubs.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
### YamlMime:TSType
name: EventHubs
uid: '@azure/arm-eventhub.EventHubs'
package: '@azure/arm-eventhub'
summary: Interface representing a EventHubs.
fullName: EventHubs
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, string, Eventhub,
EventHubsCreateOrUpdateOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.createOrUpdate'
package: '@azure/arm-eventhub'
summary: >-
Creates or updates a new Event Hub as a nested resource within a
Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, namespaceName:
string, eventHubName: string, parameters: Eventhub, options?:
EventHubsCreateOrUpdateOptionalParams): Promise<Eventhub>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: parameters
type: <xref uid="@azure/arm-eventhub.Eventhub" />
description: Parameters supplied to create an Event Hub resource.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.Eventhub" />>
- name: >-
createOrUpdateAuthorizationRule(string, string, string, string,
AuthorizationRule, EventHubsCreateOrUpdateAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.createOrUpdateAuthorizationRule'
package: '@azure/arm-eventhub'
summary: >-
Creates or updates an AuthorizationRule for the specified Event Hub.
Creation/update of the
AuthorizationRule will take a few seconds to take effect.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateAuthorizationRule(resourceGroupName: string,
namespaceName: string, eventHubName: string, authorizationRuleName:
string, parameters: AuthorizationRule, options?:
EventHubsCreateOrUpdateAuthorizationRuleOptionalParams):
Promise<AuthorizationRule>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: authorizationRuleName
type: string
description: The authorization rule name.
- id: parameters
type: <xref uid="@azure/arm-eventhub.AuthorizationRule" />
description: The shared access AuthorizationRule.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsCreateOrUpdateAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AuthorizationRule" />>
- name: delete(string, string, string, EventHubsDeleteOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.delete'
package: '@azure/arm-eventhub'
summary: Deletes an Event Hub from the specified Namespace and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, namespaceName: string,
eventHubName: string, options?: EventHubsDeleteOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: options
type: <xref uid="@azure/arm-eventhub.EventHubsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
deleteAuthorizationRule(string, string, string, string,
EventHubsDeleteAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.deleteAuthorizationRule'
package: '@azure/arm-eventhub'
summary: Deletes an Event Hub AuthorizationRule.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteAuthorizationRule(resourceGroupName: string,
namespaceName: string, eventHubName: string, authorizationRuleName:
string, options?: EventHubsDeleteAuthorizationRuleOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsDeleteAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, EventHubsGetOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.get'
package: '@azure/arm-eventhub'
summary: Gets an Event Hubs description for the specified Event Hub.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, namespaceName: string,
eventHubName: string, options?: EventHubsGetOptionalParams):
Promise<Eventhub>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: options
type: <xref uid="@azure/arm-eventhub.EventHubsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.Eventhub" />>
- name: >-
getAuthorizationRule(string, string, string, string,
EventHubsGetAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.getAuthorizationRule'
package: '@azure/arm-eventhub'
summary: Gets an AuthorizationRule for an Event Hub by rule name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAuthorizationRule(resourceGroupName: string, namespaceName:
string, eventHubName: string, authorizationRuleName: string, options?:
EventHubsGetAuthorizationRuleOptionalParams): Promise<AuthorizationRule>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsGetAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AuthorizationRule" />>
- name: >-
listAuthorizationRules(string, string, string,
EventHubsListAuthorizationRulesOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.listAuthorizationRules'
package: '@azure/arm-eventhub'
summary: Gets the authorization rules for an Event Hub.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listAuthorizationRules(resourceGroupName: string,
namespaceName: string, eventHubName: string, options?:
EventHubsListAuthorizationRulesOptionalParams):
PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsListAuthorizationRulesOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventhub.AuthorizationRule" />, <xref
uid="@azure/arm-eventhub.AuthorizationRule" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listByNamespace(string, string, EventHubsListByNamespaceOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.listByNamespace'
package: '@azure/arm-eventhub'
summary: Gets all the Event Hubs in a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByNamespace(resourceGroupName: string, namespaceName:
string, options?: EventHubsListByNamespaceOptionalParams):
PagedAsyncIterableIterator<Eventhub, Eventhub[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsListByNamespaceOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventhub.Eventhub" />, <xref
uid="@azure/arm-eventhub.Eventhub" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listKeys(string, string, string, string, EventHubsListKeysOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.listKeys'
package: '@azure/arm-eventhub'
summary: Gets the ACS and SAS connection strings for the Event Hub.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listKeys(resourceGroupName: string, namespaceName: string,
eventHubName: string, authorizationRuleName: string, options?:
EventHubsListKeysOptionalParams): Promise<AccessKeys>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: <xref uid="@azure/arm-eventhub.EventHubsListKeysOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AccessKeys" />>
- name: >-
regenerateKeys(string, string, string, string,
RegenerateAccessKeyParameters, EventHubsRegenerateKeysOptionalParams)
uid: '@azure/arm-eventhub.EventHubs.regenerateKeys'
package: '@azure/arm-eventhub'
summary: Regenerates the ACS and SAS connection strings for the Event Hub.
remarks: ''
isDeprecated: false
syntax:
content: >-
function regenerateKeys(resourceGroupName: string, namespaceName:
string, eventHubName: string, authorizationRuleName: string, parameters:
RegenerateAccessKeyParameters, options?:
EventHubsRegenerateKeysOptionalParams): Promise<AccessKeys>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: eventHubName
type: string
description: The Event Hub name
- id: authorizationRuleName
type: string
description: The authorization rule name.
- id: parameters
type: <xref uid="@azure/arm-eventhub.RegenerateAccessKeyParameters" />
description: |-
Parameters supplied to regenerate the AuthorizationRule Keys
(PrimaryKey/SecondaryKey).
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.EventHubsRegenerateKeysOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AccessKeys" />>