-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
subscriptions.json
407 lines (407 loc) · 14 KB
/
subscriptions.json
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
{
"swagger": "2.0",
"info": {
"title": "ServiceBusManagementClient",
"description": "Azure Service Bus client",
"version": "2021-11-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_ListByTopic",
"x-ms-examples": {
"SubscriptionListByTopic": {
"$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json"
}
},
"description": "List all the subscriptions under a specified topic.",
"externalDocs": {
"url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx"
},
"parameters": [
{
"$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved list of subscriptions.",
"schema": {
"$ref": "#/definitions/SBSubscriptionListResult"
}
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": {
"put": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_CreateOrUpdate",
"x-ms-examples": {
"SubscriptionCreate": {
"$ref": "./examples/Subscriptions/SBSubscriptionCreate.json"
}
},
"description": "Creates a topic subscription.",
"externalDocs": {
"url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx"
},
"parameters": [
{
"$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SBSubscription"
},
"description": "Parameters supplied to create a subscription resource."
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Subscription create request accepted.",
"schema": {
"$ref": "#/definitions/SBSubscription"
}
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_Delete",
"x-ms-examples": {
"SubscriptionDelete": {
"$ref": "./examples/Subscriptions/SBSubscriptionDelete.json"
}
},
"description": "Deletes a subscription from the specified topic.",
"externalDocs": {
"url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx"
},
"parameters": [
{
"$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Subscription successfully deleted."
},
"204": {
"description": "No content."
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_Get",
"x-ms-examples": {
"SubscriptionGet": {
"$ref": "./examples/Subscriptions/SBSubscriptionGet.json"
}
},
"description": "Returns a subscription description for the specified topic.",
"externalDocs": {
"url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx"
},
"parameters": [
{
"$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved subscription description.",
"schema": {
"$ref": "#/definitions/SBSubscription"
}
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"SBSubscriptionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/SBSubscription"
},
"description": "Result of the List Subscriptions operation."
},
"nextLink": {
"type": "string",
"description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions."
}
},
"description": "The response to the List Subscriptions operation."
},
"SBSubscription": {
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SBSubscriptionProperties",
"description": "Properties of subscriptions resource."
},
"systemData": {
"readOnly": true,
"description": "The system meta data relating to this resource.",
"$ref": "../../../common/v1/definitions.json#/definitions/systemData"
}
},
"allOf": [
{
"$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource"
}
],
"description": "Description of subscription resource."
},
"SBSubscriptionProperties": {
"type": "object",
"properties": {
"messageCount": {
"readOnly": true,
"format": "int64",
"type": "integer",
"description": "Number of messages."
},
"createdAt": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Exact time the message was created."
},
"accessedAt": {
"readOnly": true,
"format": "date-time",
"type": "string",
"description": "Last time there was a receive request to this subscription."
},
"updatedAt": {
"readOnly": true,
"format": "date-time",
"type": "string",
"description": "The exact time the message was updated."
},
"countDetails": {
"readOnly": true,
"$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails",
"description": "Message count details"
},
"lockDuration": {
"format": "duration",
"type": "string",
"description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute."
},
"requiresSession": {
"type": "boolean",
"description": "Value indicating if a subscription supports the concept of sessions."
},
"defaultMessageTimeToLive": {
"format": "duration",
"type": "string",
"description": "ISO 8061 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."
},
"deadLetteringOnFilterEvaluationExceptions": {
"type": "boolean",
"description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions."
},
"deadLetteringOnMessageExpiration": {
"type": "boolean",
"description": "Value that indicates whether a subscription has dead letter support when a message expires."
},
"duplicateDetectionHistoryTimeWindow": {
"format": "duration",
"type": "string",
"description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes."
},
"maxDeliveryCount": {
"format": "int32",
"type": "integer",
"description": "Number of maximum deliveries."
},
"status": {
"$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus",
"description": "Enumerates the possible values for the status of a messaging entity."
},
"enableBatchedOperations": {
"type": "boolean",
"description": "Value that indicates whether server-side batched operations are enabled."
},
"autoDeleteOnIdle": {
"format": "duration",
"type": "string",
"description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes."
},
"forwardTo": {
"type": "string",
"description": "Queue/Topic name to forward the messages"
},
"forwardDeadLetteredMessagesTo": {
"type": "string",
"description": "Queue/Topic name to forward the Dead Letter message"
},
"isClientAffine": {
"type": "boolean",
"description": "Value that indicates whether the subscription has an affinity to the client id."
},
"clientAffineProperties": {
"$ref": "#/definitions/SBClientAffineProperties",
"description": "Properties specific to client affine subscriptions."
}
},
"description": "Description of Subscription Resource."
},
"SBClientAffineProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Indicates the Client ID of the application that created the client-affine subscription."
},
"isDurable": {
"type": "boolean",
"description": "For client-affine subscriptions, this value indicates whether the subscription is durable or not."
},
"isShared": {
"type": "boolean",
"description": "For client-affine subscriptions, this value indicates whether the subscription is shared or not."
}
},
"description": "Properties specific to client affine subscriptions."
}
},
"parameters": {}
}