-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
hybridConnections.json
296 lines (296 loc) · 10.1 KB
/
hybridConnections.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
{
"swagger": "2.0",
"info": {
"title": "Relay API",
"description": "Use these API to manage Azure Relay resources through Azure Resource Manager.",
"version": "2021-11-01",
"x-ms-code-generation-settings": {
"name": "RelayManagementClient"
}
},
"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.Relay/namespaces/{namespaceName}/hybridConnections": {
"get": {
"tags": [
"HybridConnections"
],
"operationId": "HybridConnections_ListByNamespace",
"x-ms-examples": {
"RelayHybridConnectionListAll": {
"$ref": "./examples/HybridConnection/RelayHybridConnectionListAll.json"
}
},
"description": "Lists the hybrid connection within the namespace.",
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Request to retrieve hybrid connections by namespace succeeded.",
"schema": {
"$ref": "#/definitions/HybridConnectionListResult"
}
},
"default": {
"description": "Relay error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}": {
"put": {
"tags": [
"HybridConnections"
],
"operationId": "HybridConnections_CreateOrUpdate",
"x-ms-examples": {
"RelayHybridConnectionCreate": {
"$ref": "./examples/HybridConnection/RelayHybridConnectionCreate.json"
}
},
"description": "Creates or updates a service hybrid connection. This operation is idempotent.",
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/HybridConnectionNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/HybridConnection"
},
"description": "Parameters supplied to create a hybrid connection."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Request to create hybrid connections succeeded.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "Relay error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"HybridConnections"
],
"operationId": "HybridConnections_Delete",
"x-ms-examples": {
"RelayHybridconnectionDelete": {
"$ref": "./examples/HybridConnection/RelayHybridconnectionDelete.json"
}
},
"description": "Deletes a hybrid connection.",
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/HybridConnectionNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Request to delete hybrid connection succeeded."
},
"204": {
"description": "No content. The request has been accepted but the hybrid connection was not found."
},
"default": {
"description": "Relay error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"HybridConnections"
],
"operationId": "HybridConnections_Get",
"x-ms-examples": {
"RelayHybridConnectionGet": {
"$ref": "./examples/HybridConnection/RelayHybridConnectionGet.json"
}
},
"description": "Returns the description for the specified hybrid connection.",
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/HybridConnectionNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved description for the hybrid connection.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "Relay error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"HybridConnectionListResult": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/HybridConnection"
},
"description": "Result of the list hybrid connections."
},
"nextLink": {
"type": "string",
"description": "Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation."
}
},
"description": "The response of the list hybrid connection operation."
},
"HybridConnection": {
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"properties": {
"createdAt": {
"readOnly": true,
"format": "date-time",
"type": "string",
"description": "The time the hybrid connection was created."
},
"updatedAt": {
"readOnly": true,
"format": "date-time",
"type": "string",
"description": "The time the namespace was updated."
},
"listenerCount": {
"readOnly": true,
"format": "int32",
"type": "integer",
"minimum": 0,
"maximum": 25,
"description": "The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported."
},
"requiresClientAuthorization": {
"type": "boolean",
"description": "Returns true if client authorization is needed for this hybrid connection; otherwise, false."
},
"userMetadata": {
"type": "string",
"description": "The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored."
}
},
"description": "Properties of the HybridConnection."
},
"systemData": {
"readOnly": true,
"description": "The system meta data relating to this resource.",
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData"
}
},
"description": "Description of hybrid connection resource.",
"allOf": [
{
"$ref": "../../common/v1/definitions.json#/definitions/ProxyResource"
}
]
}
},
"parameters": {}
}