-
Notifications
You must be signed in to change notification settings - Fork 180
/
Namespaces.yml
570 lines (565 loc) · 21.8 KB
/
Namespaces.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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
### YamlMime:TSType
name: Namespaces
uid: '@azure/arm-eventhub.Namespaces'
package: '@azure/arm-eventhub'
summary: Interface representing a Namespaces.
fullName: Namespaces
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, EHNamespace,
NamespacesCreateOrUpdateOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.beginCreateOrUpdate'
package: '@azure/arm-eventhub'
summary: >-
Creates or updates a namespace. Once created, this namespace's resource
manifest is immutable. This
operation is idempotent.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, namespaceName:
string, parameters: EHNamespace, options?:
NamespacesCreateOrUpdateOptionalParams):
Promise<PollerLike<PollOperationState<EHNamespace>, EHNamespace>>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: parameters
type: <xref uid="@azure/arm-eventhub.EHNamespace" />
description: Parameters for creating a namespace resource.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-eventhub.EHNamespace" />>, <xref
uid="@azure/arm-eventhub.EHNamespace" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, EHNamespace,
NamespacesCreateOrUpdateOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.beginCreateOrUpdateAndWait'
package: '@azure/arm-eventhub'
summary: >-
Creates or updates a namespace. Once created, this namespace's resource
manifest is immutable. This
operation is idempotent.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
namespaceName: string, parameters: EHNamespace, options?:
NamespacesCreateOrUpdateOptionalParams): Promise<EHNamespace>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: parameters
type: <xref uid="@azure/arm-eventhub.EHNamespace" />
description: Parameters for creating a namespace resource.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.EHNamespace" />>
- name: beginDelete(string, string, NamespacesDeleteOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.beginDelete'
package: '@azure/arm-eventhub'
summary: >-
Deletes an existing namespace. This operation also removes all associated
resources under the
namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, namespaceName: string,
options?: NamespacesDeleteOptionalParams):
Promise<PollerLike<PollOperationState<void>, 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: options
type: <xref uid="@azure/arm-eventhub.NamespacesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.beginDeleteAndWait'
package: '@azure/arm-eventhub'
summary: >-
Deletes an existing namespace. This operation also removes all associated
resources under the
namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, namespaceName:
string, options?: NamespacesDeleteOptionalParams): 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: options
type: <xref uid="@azure/arm-eventhub.NamespacesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
checkNameAvailability(CheckNameAvailabilityParameter,
NamespacesCheckNameAvailabilityOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.checkNameAvailability'
package: '@azure/arm-eventhub'
summary: Check the give Namespace name availability.
remarks: ''
isDeprecated: false
syntax:
content: >-
function checkNameAvailability(parameters:
CheckNameAvailabilityParameter, options?:
NamespacesCheckNameAvailabilityOptionalParams):
Promise<CheckNameAvailabilityResult>
parameters:
- id: parameters
type: <xref uid="@azure/arm-eventhub.CheckNameAvailabilityParameter" />
description: Parameters to check availability of the given Namespace name
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesCheckNameAvailabilityOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-eventhub.CheckNameAvailabilityResult"
/>>
- name: >-
createOrUpdateAuthorizationRule(string, string, string, AuthorizationRule,
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.createOrUpdateAuthorizationRule'
package: '@azure/arm-eventhub'
summary: Creates or updates an AuthorizationRule for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateAuthorizationRule(resourceGroupName: string,
namespaceName: string, authorizationRuleName: string, parameters:
AuthorizationRule, options?:
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams):
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: 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.NamespacesCreateOrUpdateAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AuthorizationRule" />>
- name: >-
createOrUpdateNetworkRuleSet(string, string, NetworkRuleSet,
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.createOrUpdateNetworkRuleSet'
package: '@azure/arm-eventhub'
summary: Create or update NetworkRuleSet for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateNetworkRuleSet(resourceGroupName: string,
namespaceName: string, parameters: NetworkRuleSet, options?:
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams):
Promise<NetworkRuleSet>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: parameters
type: <xref uid="@azure/arm-eventhub.NetworkRuleSet" />
description: The Namespace IpFilterRule.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesCreateOrUpdateNetworkRuleSetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.NetworkRuleSet" />>
- name: >-
deleteAuthorizationRule(string, string, string,
NamespacesDeleteAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.deleteAuthorizationRule'
package: '@azure/arm-eventhub'
summary: Deletes an AuthorizationRule for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteAuthorizationRule(resourceGroupName: string,
namespaceName: string, authorizationRuleName: string, options?:
NamespacesDeleteAuthorizationRuleOptionalParams): 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: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesDeleteAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, NamespacesGetOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.get'
package: '@azure/arm-eventhub'
summary: Gets the description of the specified namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, namespaceName: string, options?:
NamespacesGetOptionalParams): Promise<EHNamespace>
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.NamespacesGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.EHNamespace" />>
- name: >-
getAuthorizationRule(string, string, string,
NamespacesGetAuthorizationRuleOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.getAuthorizationRule'
package: '@azure/arm-eventhub'
summary: Gets an AuthorizationRule for a Namespace by rule name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAuthorizationRule(resourceGroupName: string, namespaceName:
string, authorizationRuleName: string, options?:
NamespacesGetAuthorizationRuleOptionalParams):
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: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesGetAuthorizationRuleOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AuthorizationRule" />>
- name: >-
getNetworkRuleSet(string, string,
NamespacesGetNetworkRuleSetOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.getNetworkRuleSet'
package: '@azure/arm-eventhub'
summary: Gets NetworkRuleSet for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getNetworkRuleSet(resourceGroupName: string, namespaceName:
string, options?: NamespacesGetNetworkRuleSetOptionalParams):
Promise<NetworkRuleSet>
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.NamespacesGetNetworkRuleSetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.NetworkRuleSet" />>
- name: list(NamespacesListOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.list'
package: '@azure/arm-eventhub'
summary: >-
Lists all the available Namespaces within a subscription, irrespective of
the resource groups.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: NamespacesListOptionalParams):
PagedAsyncIterableIterator<EHNamespace, EHNamespace[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/arm-eventhub.NamespacesListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventhub.EHNamespace" />, <xref
uid="@azure/arm-eventhub.EHNamespace" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
listAuthorizationRules(string, string,
NamespacesListAuthorizationRulesOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.listAuthorizationRules'
package: '@azure/arm-eventhub'
summary: Gets a list of authorization rules for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listAuthorizationRules(resourceGroupName: string,
namespaceName: string, options?:
NamespacesListAuthorizationRulesOptionalParams):
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: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesListAuthorizationRulesOptionalParams"
/>
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: listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.listByResourceGroup'
package: '@azure/arm-eventhub'
summary: Lists the available Namespaces within a resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
NamespacesListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<EHNamespace, EHNamespace[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventhub.EHNamespace" />, <xref
uid="@azure/arm-eventhub.EHNamespace" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listKeys(string, string, string, NamespacesListKeysOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.listKeys'
package: '@azure/arm-eventhub'
summary: Gets the primary and secondary connection strings for the Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listKeys(resourceGroupName: string, namespaceName: string,
authorizationRuleName: string, options?:
NamespacesListKeysOptionalParams): 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: authorizationRuleName
type: string
description: The authorization rule name.
- id: options
type: <xref uid="@azure/arm-eventhub.NamespacesListKeysOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AccessKeys" />>
- name: >-
listNetworkRuleSet(string, string,
NamespacesListNetworkRuleSetOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.listNetworkRuleSet'
package: '@azure/arm-eventhub'
summary: Gets NetworkRuleSet for a Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listNetworkRuleSet(resourceGroupName: string, namespaceName:
string, options?: NamespacesListNetworkRuleSetOptionalParams):
Promise<NetworkRuleSetListResult>
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.NamespacesListNetworkRuleSetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-eventhub.NetworkRuleSetListResult"
/>>
- name: >-
regenerateKeys(string, string, string, RegenerateAccessKeyParameters,
NamespacesRegenerateKeysOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.regenerateKeys'
package: '@azure/arm-eventhub'
summary: >-
Regenerates the primary or secondary connection strings for the specified
Namespace.
remarks: ''
isDeprecated: false
syntax:
content: >-
function regenerateKeys(resourceGroupName: string, namespaceName:
string, authorizationRuleName: string, parameters:
RegenerateAccessKeyParameters, options?:
NamespacesRegenerateKeysOptionalParams): 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: authorizationRuleName
type: string
description: The authorization rule name.
- id: parameters
type: <xref uid="@azure/arm-eventhub.RegenerateAccessKeyParameters" />
description: Parameters required to regenerate the connection string.
- id: options
type: >-
<xref
uid="@azure/arm-eventhub.NamespacesRegenerateKeysOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.AccessKeys" />>
- name: update(string, string, EHNamespace, NamespacesUpdateOptionalParams)
uid: '@azure/arm-eventhub.Namespaces.update'
package: '@azure/arm-eventhub'
summary: >-
Creates or updates a namespace. Once created, this namespace's resource
manifest is immutable. This
operation is idempotent.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceGroupName: string, namespaceName: string,
parameters: EHNamespace, options?: NamespacesUpdateOptionalParams):
Promise<EHNamespace>
parameters:
- id: resourceGroupName
type: string
description: Name of the resource group within the azure subscription.
- id: namespaceName
type: string
description: The Namespace name
- id: parameters
type: <xref uid="@azure/arm-eventhub.EHNamespace" />
description: Parameters for updating a namespace resource.
- id: options
type: <xref uid="@azure/arm-eventhub.NamespacesUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventhub.EHNamespace" />>