-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.servicebus.management.SubscriptionProperties.yml
278 lines (244 loc) · 8.43 KB
/
azure.servicebus.management.SubscriptionProperties.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
### YamlMime:PythonClass
uid: azure.servicebus.management.SubscriptionProperties
name: SubscriptionProperties
fullName: azure.servicebus.management.SubscriptionProperties
module: azure.servicebus.management
inheritances:
- azure.servicebus.management._models.DictMixin
summary: 'Properties of a Service Bus topic subscription resource.
**Please use `get_subscription`, `create_subscription`, or `list_subscriptions`
on the
ServiceBusAdministrationClient to get a `SubscriptionProperties` instance instead
of
instantiating a `SubscriptionProperties` object directly.**'
constructor:
syntax: 'SubscriptionProperties(name: str, *, lock_duration: timedelta | str | None,
requires_session: bool | None, default_message_time_to_live: timedelta | str |
None, dead_lettering_on_message_expiration: bool | None, dead_lettering_on_filter_evaluation_exceptions:
bool | None, max_delivery_count: int | None, enable_batched_operations: bool |
None, status: str | EntityStatus | None, forward_to: str | None, user_metadata:
str | None, forward_dead_lettered_messages_to: str | None, auto_delete_on_idle:
timedelta | str | None, availability_status: str | EntityAvailabilityStatus |
None)'
parameters:
- name: name
description: Name of the subscription.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: lock_duration
description: 'ISO 8601 timespan duration of a peek-lock; that is, the amount of
time
that the message is locked for other receivers. The maximum value for LockDuration
is 5
minutes; the default value is 1 minute.'
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- name: requires_session
description: 'A value that indicates whether the queue supports the concept of
sessions.'
types:
- <xref:bool>
- <xref:None>
- name: default_message_time_to_live
description: 'ISO 8601 default message timespan to live value. This is
the duration after which the message expires, starting from when the message
is sent to Service
Bus. This is the default value used when TimeToLive is not set on a message
itself.'
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- name: dead_lettering_on_message_expiration
description: 'A value that indicates whether this subscription
has dead letter support when a message expires.'
types:
- <xref:bool>
- <xref:None>
- name: dead_lettering_on_filter_evaluation_exceptions
description: 'A value that indicates whether this
subscription has dead letter support when a message expires.'
types:
- <xref:bool>
- <xref:None>
- name: max_delivery_count
description: 'The maximum delivery count. A message is automatically deadlettered
after this number of deliveries. Default value is 10.'
types:
- <xref:int>
- <xref:None>
- name: enable_batched_operations
description: 'Value that indicates whether server-side batched operations
are enabled.'
types:
- <xref:bool>
- <xref:None>
- name: status
description: 'Status of a Service Bus resource. Possible values include: "Active",
"Creating",
"Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled",
"Unknown".'
types:
- <xref:str>
- <xref:azure.servicebus.management.EntityStatus>
- <xref:None>
- name: forward_to
description: 'The name of the recipient entity to which all the messages sent
to the
subscription are forwarded to.'
types:
- <xref:str>
- <xref:None>
- name: user_metadata
description: 'Metadata associated with the subscription. Maximum number of characters
is 1024.'
types:
- <xref:str>
- <xref:None>
- name: forward_dead_lettered_messages_to
description: 'The name of the recipient entity to which all the
messages sent to the subscription are forwarded to.'
types:
- <xref:str>
- <xref:None>
- name: auto_delete_on_idle
description: 'ISO 8601 timeSpan idle interval after which the subscription is
automatically deleted. The minimum duration is 5 minutes.'
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- name: availability_status
description: 'Availability status of the entity. Possible values include:
"Available", "Limited", "Renaming", "Restoring", "Unknown".'
types:
- <xref:str>
- <xref:None>
- <xref:azure.servicebus.management.EntityAvailabilityStatus>
variables:
- description: Name of the subscription.
name: name
types:
- <xref:str>
- description: 'ISO 8601 timespan duration of a peek-lock; that is, the amount of
time
that the message is locked for other receivers. The maximum value for LockDuration
is 5
minutes; the default value is 1 minute.'
name: lock_duration
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- description: 'A value that indicates whether the queue supports the concept of
sessions.'
name: requires_session
types:
- <xref:bool>
- <xref:None>
- description: 'ISO 8601 default message timespan to live value. This is
the duration after which the message expires, starting from when the message is
sent to Service
Bus. This is the default value used when TimeToLive is not set on a message itself.'
name: default_message_time_to_live
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- description: 'A value that indicates whether this subscription
has dead letter support when a message expires.'
name: dead_lettering_on_message_expiration
types:
- <xref:bool>
- <xref:None>
- description: 'A value that indicates whether this
subscription has dead letter support when a message expires.'
name: dead_lettering_on_filter_evaluation_exceptions
types:
- <xref:bool>
- <xref:None>
- description: 'The maximum delivery count. A message is automatically deadlettered
after this number of deliveries. Default value is 10.'
name: max_delivery_count
types:
- <xref:int>
- <xref:None>
- description: 'Value that indicates whether server-side batched operations
are enabled.'
name: enable_batched_operations
types:
- <xref:bool>
- <xref:None>
- description: 'Status of a Service Bus resource. Possible values include: "Active",
"Creating",
"Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled",
"Unknown".'
name: status
types:
- <xref:str>
- <xref:azure.servicebus.management.EntityStatus>
- <xref:None>
- description: 'The name of the recipient entity to which all the messages sent to
the
subscription are forwarded to.'
name: forward_to
types:
- <xref:str>
- <xref:None>
- description: 'Metadata associated with the subscription. Maximum number of characters
is 1024.'
name: user_metadata
types:
- <xref:str>
- <xref:None>
- description: 'The name of the recipient entity to which all the
messages sent to the subscription are forwarded to.'
name: forward_dead_lettered_messages_to
types:
- <xref:str>
- <xref:None>
- description: 'ISO 8601 timeSpan idle interval after which the subscription is
automatically deleted. The minimum duration is 5 minutes.'
name: auto_delete_on_idle
types:
- <xref:datetime.timedelta>
- <xref:str>
- <xref:None>
- description: 'Availability status of the entity. Possible values include:
"Available", "Limited", "Renaming", "Restoring", "Unknown".'
name: availability_status
types:
- <xref:str>
- <xref:None>
- <xref:azure.servicebus.management.EntityAvailabilityStatus>
methods:
- uid: azure.servicebus.management.SubscriptionProperties.get
name: get
signature: 'get(key: str, default: Any | None = None) -> Any'
parameters:
- name: key
isRequired: true
- name: default
defaultValue: None
- uid: azure.servicebus.management.SubscriptionProperties.has_key
name: has_key
signature: 'has_key(k: str) -> bool'
parameters:
- name: k
isRequired: true
- uid: azure.servicebus.management.SubscriptionProperties.items
name: items
signature: items() -> List[Tuple[str, Any]]
- uid: azure.servicebus.management.SubscriptionProperties.keys
name: keys
signature: keys() -> List[str]
- uid: azure.servicebus.management.SubscriptionProperties.update
name: update
signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.servicebus.management.SubscriptionProperties.values
name: values
signature: values() -> List[Any]