-
Notifications
You must be signed in to change notification settings - Fork 239
/
azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.yml
447 lines (438 loc) · 16.2 KB
/
azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations
name: TopicsOperations
fullName: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations
module: azure.mgmt.servicebus.v2021_11_01.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.servicebus.v2021_11_01.aio.ServiceBusManagementClient>'s\n\
>\n> <xref:topics> attribute.\n>"
constructor:
syntax: TopicsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.create_or_update
name: create_or_update
summary: Creates a topic in the specified namespace.
signature: 'async create_or_update(resource_group_name: str, namespace_name: str,
topic_name: str, parameters: _models.SBTopic, *, content_type: str = ''application/json'',
**kwargs: Any) -> _models.SBTopic'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to create a topic resource. Is either a SBTopic
type or
a IO type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: SBTopic or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.create_or_update_authorization_rule
name: create_or_update_authorization_rule
summary: Creates an authorization rule for the specified topic.
signature: 'async create_or_update_authorization_rule(resource_group_name: str,
namespace_name: str, topic_name: str, authorization_rule_name: str, parameters:
_models.SBAuthorizationRule, *, content_type: str = ''application/json'', **kwargs:
Any) -> _models.SBAuthorizationRule'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'The shared access authorization rule. Is either a SBAuthorizationRule
type
or a IO type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: SBAuthorizationRule or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.delete
name: delete
summary: Deletes a topic from the specified namespace and resource group.
signature: 'async delete(resource_group_name: str, namespace_name: str, topic_name:
str, **kwargs: Any) -> None'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.delete_authorization_rule
name: delete_authorization_rule
summary: Deletes a topic authorization rule.
signature: 'async delete_authorization_rule(resource_group_name: str, namespace_name:
str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> None'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.get
name: get
summary: Returns a description for the specified topic.
signature: 'async get(resource_group_name: str, namespace_name: str, topic_name:
str, **kwargs: Any) -> SBTopic'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: SBTopic or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.get_authorization_rule
name: get_authorization_rule
summary: Returns the specified authorization rule.
signature: 'async get_authorization_rule(resource_group_name: str, namespace_name:
str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> SBAuthorizationRule'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: SBAuthorizationRule or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_authorization_rules
name: list_authorization_rules
summary: Gets authorization rules for a topic.
signature: 'list_authorization_rules(resource_group_name: str, namespace_name: str,
topic_name: str, **kwargs: Any) -> AsyncIterable[SBAuthorizationRule]'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: An iterator like instance of either SBAuthorizationRule or the result
of cls(response)
types:
- <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_by_namespace
name: list_by_namespace
summary: Gets all the topics in a namespace.
signature: 'list_by_namespace(resource_group_name: str, namespace_name: str, skip:
int | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[SBTopic]'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: skip
description: 'Skip is only used if a previous operation returned a partial result.
If a previous
response contains a nextLink element, the value of the nextLink element will
include a skip
parameter that specifies a starting point to use for subsequent calls. Default
value is None.'
isRequired: true
types:
- <xref:int>
- name: top
description: 'May be used to limit the number of results to the most recent N
usageDetails.
Default value is None.'
isRequired: true
types:
- <xref:int>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: An iterator like instance of either SBTopic or the result of cls(response)
types:
- <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_keys
name: list_keys
summary: Gets the primary and secondary connection strings for the topic.
signature: 'async list_keys(resource_group_name: str, namespace_name: str, topic_name:
str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: AccessKeys or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.AccessKeys>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx)\
\ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.regenerate_keys
name: regenerate_keys
summary: Regenerates primary or secondary connection strings for the topic.
signature: 'async regenerate_keys(resource_group_name: str, namespace_name: str,
topic_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters,
*, content_type: str = ''application/json'', **kwargs: Any) -> _models.AccessKeys'
parameters:
- name: resource_group_name
description: Name of the Resource group within the Azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: topic_name
description: The topic name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to regenerate the authorization rule. Is either
a
RegenerateAccessKeyParameters type or a IO type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.RegenerateAccessKeyParameters>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: AccessKeys or the result of cls(response)
types:
- <xref:azure.mgmt.servicebus.v2021_11_01.models.AccessKeys>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx)\
\ \n"
attributes:
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.models
name: models
signature: models = <module 'azure.mgmt.servicebus.v2021_11_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2021_11_01\\models\\__init__.py'>