-
Notifications
You must be signed in to change notification settings - Fork 246
/
azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.yml
315 lines (312 loc) · 11.6 KB
/
azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations
name: DisasterRecoveryConfigsOperations
fullName: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations
module: azure.mgmt.eventhub.v2022_01_01_preview.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.eventhub.v2022_01_01_preview.EventHubManagementClient>'s\n\
>\n> <xref:disaster_recovery_configs> attribute.\n>"
constructor:
syntax: DisasterRecoveryConfigsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.break_pairing
name: break_pairing
summary: 'This operation disables the Disaster Recovery and stops replicating changes
from primary to
secondary namespaces.'
signature: 'break_pairing(resource_group_name: str, namespace_name: str, alias:
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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.check_name_availability
name: check_name_availability
summary: Check the give Namespace name availability.
signature: 'check_name_availability(resource_group_name: str, namespace_name: str,
parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = ''application/json'',
**kwargs: Any) -> _models.CheckNameAvailabilityResult'
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: parameters
description: 'Parameters to check availability of the given Alias name. Is either
a
CheckNameAvailabilityParameter type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.CheckNameAvailabilityParameter>
- <xref:typing.IO>[<xref:bytes>]
return:
description: CheckNameAvailabilityResult or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.CheckNameAvailabilityResult>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.create_or_update
name: create_or_update
summary: Creates or updates a new Alias(Disaster Recovery configuration).
signature: 'create_or_update(resource_group_name: str, namespace_name: str, alias:
str, parameters: _models.ArmDisasterRecovery, *, content_type: str = ''application/json'',
**kwargs: Any) -> _models.ArmDisasterRecovery'
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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters required to create an Alias(Disaster Recovery configuration).
Is
either a ArmDisasterRecovery type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
- <xref:typing.IO>[<xref:bytes>]
return:
description: ArmDisasterRecovery or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.delete
name: delete
summary: Deletes an Alias(Disaster Recovery configuration).
signature: 'delete(resource_group_name: str, namespace_name: str, alias: 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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.fail_over
name: fail_over
summary: Invokes GEO DR failover and reconfigure the alias to point to the secondary
namespace.
signature: 'fail_over(resource_group_name: str, namespace_name: str, alias: 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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.get
name: get
summary: Retrieves Alias(Disaster Recovery configuration) for primary or secondary
namespace.
signature: 'get(resource_group_name: str, namespace_name: str, alias: str, **kwargs:
Any) -> ArmDisasterRecovery'
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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
return:
description: ArmDisasterRecovery or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.get_authorization_rule
name: get_authorization_rule
summary: Gets an AuthorizationRule for a Namespace by rule name.
signature: 'get_authorization_rule(resource_group_name: str, namespace_name: str,
alias: str, authorization_rule_name: str, **kwargs: Any) -> AuthorizationRule'
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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
return:
description: AuthorizationRule or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AuthorizationRule>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list
name: list
summary: Gets all Alias(Disaster Recovery configurations).
signature: 'list(resource_group_name: str, namespace_name: str, **kwargs: Any) ->
Iterable[ArmDisasterRecovery]'
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>
return:
description: An iterator like instance of either ArmDisasterRecovery or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list_authorization_rules
name: list_authorization_rules
summary: Gets a list of authorization rules for a Namespace.
signature: 'list_authorization_rules(resource_group_name: str, namespace_name: str,
alias: str, **kwargs: Any) -> Iterable[AuthorizationRule]'
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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either AuthorizationRule or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AuthorizationRule>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list_keys
name: list_keys
summary: Gets the primary and secondary connection strings for the Namespace.
signature: 'list_keys(resource_group_name: str, namespace_name: str, alias: 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: alias
description: The Disaster Recovery configuration name. Required.
isRequired: true
types:
- <xref:str>
- name: authorization_rule_name
description: The authorization rule name. Required.
isRequired: true
types:
- <xref:str>
return:
description: AccessKeys or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AccessKeys>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.models
name: models
signature: models = <module 'azure.mgmt.eventhub.v2022_01_01_preview.models' from
'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2022_01_01_preview\\models\\__init__.py'>