1{
2 "swagger": "2.0",
3 "info": {
4 "title": "NetworkManagementClient",
5 "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.",
6 "version": "2020-04-01"
7 },
8 "host": "management.azure.com",
9 "schemes": [
10 "https"
11 ],
12 "consumes": [
13 "application/json"
14 ],
15 "produces": [
16 "application/json"
17 ],
18 "security": [
19 {
20 "azure_auth": [
21 "user_impersonation"
22 ]
23 }
24 ],
25 "securityDefinitions": {
26 "azure_auth": {
27 "type": "oauth2",
28 "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29 "flow": "implicit",
30 "description": "Azure Active Directory OAuth2 Flow.",
31 "scopes": {
32 "user_impersonation": "impersonate your user account"
33 }
34 }
35 },
36 "paths": {
37 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": {
38 "delete": {
39 "tags": [
40 "RouteTables"
41 ],
42 "operationId": "RouteTables_Delete",
43 "description": "Deletes the specified route table.",
44 "parameters": [
45 {
46 "name": "resourceGroupName",
47 "in": "path",
48 "required": true,
49 "type": "string",
50 "description": "The name of the resource group."
51 },
52 {
53 "name": "routeTableName",
54 "in": "path",
55 "required": true,
56 "type": "string",
57 "description": "The name of the route table."
58 },
59 {
60 "$ref": "./network.json#/parameters/ApiVersionParameter"
61 },
62 {
63 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
64 }
65 ],
66 "responses": {
67 "204": {
68 "description": "Request successful. Resource does not exist."
69 },
70 "200": {
71 "description": "Request successful. Operation to delete was accepted."
72 },
73 "202": {
74 "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously."
75 },
76 "default": {
77 "description": "Error response describing why the operation failed.",
78 "schema": {
79 "$ref": "./network.json#/definitions/CloudError"
80 }
81 }
82 },
83 "x-ms-long-running-operation": true,
84 "x-ms-long-running-operation-options": {
85 "final-state-via": "location"
86 },
87 "x-ms-examples": {
88 "Delete route table": {
89 "$ref": "./examples/RouteTableDelete.json"
90 }
91 }
92 },
93 "get": {
94 "tags": [
95 "RouteTables"
96 ],
97 "operationId": "RouteTables_Get",
98 "description": "Gets the specified route table.",
99 "parameters": [
100 {
101 "name": "resourceGroupName",
102 "in": "path",
103 "required": true,
104 "type": "string",
105 "description": "The name of the resource group."
106 },
107 {
108 "name": "routeTableName",
109 "in": "path",
110 "required": true,
111 "type": "string",
112 "description": "The name of the route table."
113 },
114 {
115 "$ref": "./network.json#/parameters/ApiVersionParameter"
116 },
117 {
118 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
119 },
120 {
121 "name": "$expand",
122 "in": "query",
123 "required": false,
124 "type": "string",
125 "description": "Expands referenced resources."
126 }
127 ],
128 "responses": {
129 "200": {
130 "description": "Request successful. The operation returns the resulting RouteTable resource.",
131 "schema": {
132 "$ref": "#/definitions/RouteTable"
133 }
134 },
135 "default": {
136 "description": "Error response describing why the operation failed.",
137 "schema": {
138 "$ref": "./network.json#/definitions/CloudError"
139 }
140 }
141 },
142 "x-ms-examples": {
143 "Get route table": {
144 "$ref": "./examples/RouteTableGet.json"
145 }
146 }
147 },
148 "put": {
149 "tags": [
150 "RouteTables"
151 ],
152 "operationId": "RouteTables_CreateOrUpdate",
153 "description": "Create or updates a route table in a specified resource group.",
154 "parameters": [
155 {
156 "name": "resourceGroupName",
157 "in": "path",
158 "required": true,
159 "type": "string",
160 "description": "The name of the resource group."
161 },
162 {
163 "name": "routeTableName",
164 "in": "path",
165 "required": true,
166 "type": "string",
167 "description": "The name of the route table."
168 },
169 {
170 "name": "parameters",
171 "in": "body",
172 "required": true,
173 "schema": {
174 "$ref": "#/definitions/RouteTable"
175 },
176 "description": "Parameters supplied to the create or update route table operation."
177 },
178 {
179 "$ref": "./network.json#/parameters/ApiVersionParameter"
180 },
181 {
182 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
183 }
184 ],
185 "responses": {
186 "200": {
187 "description": "Request successful. The operation returns the resulting RouteTable resource.",
188 "schema": {
189 "$ref": "#/definitions/RouteTable"
190 }
191 },
192 "201": {
193 "description": "Create successful. The operation returns the resulting RouteTable resource.",
194 "schema": {
195 "$ref": "#/definitions/RouteTable"
196 }
197 },
198 "default": {
199 "description": "Error response describing why the operation failed.",
200 "schema": {
201 "$ref": "./network.json#/definitions/CloudError"
202 }
203 }
204 },
205 "x-ms-examples": {
206 "Create route table": {
207 "$ref": "./examples/RouteTableCreate.json"
208 },
209 "Create route table with route": {
210 "$ref": "./examples/RouteTableCreateWithRoute.json"
211 }
212 },
213 "x-ms-long-running-operation": true,
214 "x-ms-long-running-operation-options": {
215 "final-state-via": "azure-async-operation"
216 }
217 },
218 "patch": {
219 "tags": [
220 "RouteTables"
221 ],
222 "operationId": "RouteTables_UpdateTags",
223 "description": "Updates a route table tags.",
224 "parameters": [
225 {
226 "name": "resourceGroupName",
227 "in": "path",
228 "required": true,
229 "type": "string",
230 "description": "The name of the resource group."
231 },
232 {
233 "name": "routeTableName",
234 "in": "path",
235 "required": true,
236 "type": "string",
237 "description": "The name of the route table."
238 },
239 {
240 "name": "parameters",
241 "in": "body",
242 "required": true,
243 "schema": {
244 "$ref": "./network.json#/definitions/TagsObject"
245 },
246 "description": "Parameters supplied to update route table tags."
247 },
248 {
249 "$ref": "./network.json#/parameters/ApiVersionParameter"
250 },
251 {
252 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
253 }
254 ],
255 "responses": {
256 "200": {
257 "description": "Request successful. The operation returns the resulting RouteTable resource.",
258 "schema": {
259 "$ref": "#/definitions/RouteTable"
260 }
261 },
262 "default": {
263 "description": "Error response describing why the operation failed.",
264 "schema": {
265 "$ref": "./network.json#/definitions/CloudError"
266 }
267 }
268 },
269 "x-ms-examples": {
270 "Update route table tags": {
271 "$ref": "./examples/RouteTableUpdateTags.json"
272 }
273 }
274 }
275 },
276 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": {
277 "get": {
278 "tags": [
279 "RouteTables"
280 ],
281 "operationId": "RouteTables_List",
282 "description": "Gets all route tables in a resource group.",
283 "parameters": [
284 {
285 "name": "resourceGroupName",
286 "in": "path",
287 "required": true,
288 "type": "string",
289 "description": "The name of the resource group."
290 },
291 {
292 "$ref": "./network.json#/parameters/ApiVersionParameter"
293 },
294 {
295 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
296 }
297 ],
298 "responses": {
299 "200": {
300 "description": "Request successful. The operation returns a list of RouteTable resources.",
301 "schema": {
302 "$ref": "#/definitions/RouteTableListResult"
303 }
304 },
305 "default": {
306 "description": "Error response describing why the operation failed.",
307 "schema": {
308 "$ref": "./network.json#/definitions/CloudError"
309 }
310 }
311 },
312 "x-ms-examples": {
313 "List route tables in resource group": {
314 "$ref": "./examples/RouteTableList.json"
315 }
316 },
317 "x-ms-pageable": {
318 "nextLinkName": "nextLink"
319 }
320 }
321 },
322 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": {
323 "get": {
324 "tags": [
325 "RouteTables"
326 ],
327 "operationId": "RouteTables_ListAll",
328 "description": "Gets all route tables in a subscription.",
329 "parameters": [
330 {
331 "$ref": "./network.json#/parameters/ApiVersionParameter"
332 },
333 {
334 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
335 }
336 ],
337 "responses": {
338 "200": {
339 "description": "Request successful. The operation returns a list of RouteTable resources.",
340 "schema": {
341 "$ref": "#/definitions/RouteTableListResult"
342 }
343 },
344 "default": {
345 "description": "Error response describing why the operation failed.",
346 "schema": {
347 "$ref": "./network.json#/definitions/CloudError"
348 }
349 }
350 },
351 "x-ms-examples": {
352 "List all route tables": {
353 "$ref": "./examples/RouteTableListAll.json"
354 }
355 },
356 "x-ms-pageable": {
357 "nextLinkName": "nextLink"
358 }
359 }
360 },
361 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": {
362 "delete": {
363 "tags": [
364 "Routes"
365 ],
366 "operationId": "Routes_Delete",
367 "description": "Deletes the specified route from a route table.",
368 "parameters": [
369 {
370 "name": "resourceGroupName",
371 "in": "path",
372 "required": true,
373 "type": "string",
374 "description": "The name of the resource group."
375 },
376 {
377 "name": "routeTableName",
378 "in": "path",
379 "required": true,
380 "type": "string",
381 "description": "The name of the route table."
382 },
383 {
384 "name": "routeName",
385 "in": "path",
386 "required": true,
387 "type": "string",
388 "description": "The name of the route."
389 },
390 {
391 "$ref": "./network.json#/parameters/ApiVersionParameter"
392 },
393 {
394 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
395 }
396 ],
397 "responses": {
398 "202": {
399 "description": "Accepted and the operation will complete asynchronously."
400 },
401 "200": {
402 "description": "Accepted."
403 },
404 "204": {
405 "description": "Route was deleted or not found."
406 },
407 "default": {
408 "description": "Error response describing why the operation failed.",
409 "schema": {
410 "$ref": "./network.json#/definitions/CloudError"
411 }
412 }
413 },
414 "x-ms-examples": {
415 "Delete route": {
416 "$ref": "./examples/RouteTableRouteDelete.json"
417 }
418 },
419 "x-ms-long-running-operation": true,
420 "x-ms-long-running-operation-options": {
421 "final-state-via": "location"
422 }
423 },
424 "get": {
425 "tags": [
426 "Routes"
427 ],
428 "operationId": "Routes_Get",
429 "description": "Gets the specified route from a route table.",
430 "parameters": [
431 {
432 "name": "resourceGroupName",
433 "in": "path",
434 "required": true,
435 "type": "string",
436 "description": "The name of the resource group."
437 },
438 {
439 "name": "routeTableName",
440 "in": "path",
441 "required": true,
442 "type": "string",
443 "description": "The name of the route table."
444 },
445 {
446 "name": "routeName",
447 "in": "path",
448 "required": true,
449 "type": "string",
450 "description": "The name of the route."
451 },
452 {
453 "$ref": "./network.json#/parameters/ApiVersionParameter"
454 },
455 {
456 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
457 }
458 ],
459 "responses": {
460 "200": {
461 "description": "Request successful. The operation returns the resulting Route resource.",
462 "schema": {
463 "$ref": "#/definitions/Route"
464 }
465 },
466 "default": {
467 "description": "Error response describing why the operation failed.",
468 "schema": {
469 "$ref": "./network.json#/definitions/CloudError"
470 }
471 }
472 },
473 "x-ms-examples": {
474 "Get route": {
475 "$ref": "./examples/RouteTableRouteGet.json"
476 }
477 }
478 },
479 "put": {
480 "tags": [
481 "Routes"
482 ],
483 "operationId": "Routes_CreateOrUpdate",
484 "description": "Creates or updates a route in the specified route table.",
485 "parameters": [
486 {
487 "name": "resourceGroupName",
488 "in": "path",
489 "required": true,
490 "type": "string",
491 "description": "The name of the resource group."
492 },
493 {
494 "name": "routeTableName",
495 "in": "path",
496 "required": true,
497 "type": "string",
498 "description": "The name of the route table."
499 },
500 {
501 "name": "routeName",
502 "in": "path",
503 "required": true,
504 "type": "string",
505 "description": "The name of the route."
506 },
507 {
508 "name": "routeParameters",
509 "in": "body",
510 "required": true,
511 "schema": {
512 "$ref": "#/definitions/Route"
513 },
514 "description": "Parameters supplied to the create or update route operation."
515 },
516 {
517 "$ref": "./network.json#/parameters/ApiVersionParameter"
518 },
519 {
520 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
521 }
522 ],
523 "responses": {
524 "200": {
525 "description": "Update successful. The operation returns the resulting Route resource.",
526 "schema": {
527 "$ref": "#/definitions/Route"
528 }
529 },
530 "201": {
531 "description": "Create successful. The operation returns the resulting Route resource.",
532 "schema": {
533 "$ref": "#/definitions/Route"
534 }
535 },
536 "default": {
537 "description": "Error response describing why the operation failed.",
538 "schema": {
539 "$ref": "./network.json#/definitions/CloudError"
540 }
541 }
542 },
543 "x-ms-examples": {
544 "Create route": {
545 "$ref": "./examples/RouteTableRouteCreate.json"
546 }
547 },
548 "x-ms-long-running-operation": true,
549 "x-ms-long-running-operation-options": {
550 "final-state-via": "azure-async-operation"
551 }
552 }
553 },
554 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": {
555 "get": {
556 "tags": [
557 "Routes"
558 ],
559 "operationId": "Routes_List",
560 "description": "Gets all routes in a route table.",
561 "parameters": [
562 {
563 "name": "resourceGroupName",
564 "in": "path",
565 "required": true,
566 "type": "string",
567 "description": "The name of the resource group."
568 },
569 {
570 "name": "routeTableName",
571 "in": "path",
572 "required": true,
573 "type": "string",
574 "description": "The name of the route table."
575 },
576 {
577 "$ref": "./network.json#/parameters/ApiVersionParameter"
578 },
579 {
580 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
581 }
582 ],
583 "responses": {
584 "200": {
585 "description": "Request successful. The operation returns a list of Route resources.",
586 "schema": {
587 "$ref": "#/definitions/RouteListResult"
588 }
589 },
590 "default": {
591 "description": "Error response describing why the operation failed.",
592 "schema": {
593 "$ref": "./network.json#/definitions/CloudError"
594 }
595 }
596 },
597 "x-ms-pageable": {
598 "nextLinkName": "nextLink"
599 },
600 "x-ms-examples": {
601 "List routes": {
602 "$ref": "./examples/RouteTableRouteList.json"
603 }
604 }
605 }
606 }
607 },
608 "definitions": {
609 "RoutePropertiesFormat": {
610 "properties": {
611 "addressPrefix": {
612 "type": "string",
613 "description": "The destination CIDR to which the route applies."
614 },
615 "nextHopType": {
616 "$ref": "#/definitions/RouteNextHopType",
617 "description": "The type of Azure hop the packet should be sent to."
618 },
619 "nextHopIpAddress": {
620 "type": "string",
621 "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance."
622 },
623 "provisioningState": {
624 "readOnly": true,
625 "$ref": "./network.json#/definitions/ProvisioningState",
626 "description": "The provisioning state of the route resource."
627 }
628 },
629 "required": [
630 "nextHopType"
631 ],
632 "description": "Route resource."
633 },
634 "Route": {
635 "properties": {
636 "properties": {
637 "x-ms-client-flatten": true,
638 "$ref": "#/definitions/RoutePropertiesFormat",
639 "description": "Properties of the route."
640 },
641 "name": {
642 "type": "string",
643 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
644 },
645 "etag": {
646 "readOnly": true,
647 "type": "string",
648 "description": "A unique read-only string that changes whenever the resource is updated."
649 }
650 },
651 "allOf": [
652 {
653 "$ref": "./network.json#/definitions/SubResource"
654 }
655 ],
656 "description": "Route resource."
657 },
658 "RouteTablePropertiesFormat": {
659 "properties": {
660 "routes": {
661 "type": "array",
662 "items": {
663 "$ref": "#/definitions/Route"
664 },
665 "description": "Collection of routes contained within a route table."
666 },
667 "subnets": {
668 "readOnly": true,
669 "type": "array",
670 "items": {
671 "$ref": "./virtualNetwork.json#/definitions/Subnet"
672 },
673 "description": "A collection of references to subnets."
674 },
675 "disableBgpRoutePropagation": {
676 "type": "boolean",
677 "description": "Whether to disable the routes learned by BGP on that route table. True means disable."
678 },
679 "provisioningState": {
680 "readOnly": true,
681 "$ref": "./network.json#/definitions/ProvisioningState",
682 "description": "The provisioning state of the route table resource."
683 }
684 },
685 "description": "Route Table resource."
686 },
687 "RouteTable": {
688 "properties": {
689 "properties": {
690 "x-ms-client-flatten": true,
691 "$ref": "#/definitions/RouteTablePropertiesFormat",
692 "description": "Properties of the route table."
693 },
694 "etag": {
695 "readOnly": true,
696 "type": "string",
697 "description": "A unique read-only string that changes whenever the resource is updated."
698 }
699 },
700 "allOf": [
701 {
702 "$ref": "./network.json#/definitions/Resource"
703 }
704 ],
705 "description": "Route table resource."
706 },
707 "RouteTableListResult": {
708 "properties": {
709 "value": {
710 "type": "array",
711 "items": {
712 "$ref": "#/definitions/RouteTable"
713 },
714 "description": "A list of route tables in a resource group."
715 },
716 "nextLink": {
717 "type": "string",
718 "description": "The URL to get the next set of results."
719 }
720 },
721 "description": "Response for the ListRouteTable API service call."
722 },
723 "RouteListResult": {
724 "properties": {
725 "value": {
726 "type": "array",
727 "items": {
728 "$ref": "#/definitions/Route"
729 },
730 "description": "A list of routes in a resource group."
731 },
732 "nextLink": {
733 "type": "string",
734 "description": "The URL to get the next set of results."
735 }
736 },
737 "description": "Response for the ListRoute API service call."
738 },
739 "RouteNextHopType": {
740 "type": "string",
741 "description": "The type of Azure hop the packet should be sent to.",
742 "enum": [
743 "VirtualNetworkGateway",
744 "VnetLocal",
745 "Internet",
746 "VirtualAppliance",
747 "None"
748 ],
749 "x-ms-enum": {
750 "name": "RouteNextHopType",
751 "modelAsString": true
752 }
753 }
754 }
755}
View as plain text