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/networkInterfaces/{networkInterfaceName}": {
38 "delete": {
39 "tags": [
40 "NetworkInterfaces"
41 ],
42 "operationId": "NetworkInterfaces_Delete",
43 "description": "Deletes the specified network interface.",
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": "networkInterfaceName",
54 "in": "path",
55 "required": true,
56 "type": "string",
57 "description": "The name of the network interface."
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 "202": {
71 "description": "Accepted and the operation will complete asynchronously."
72 },
73 "200": {
74 "description": "Delete successful."
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-examples": {
84 "Delete network interface": {
85 "$ref": "./examples/NetworkInterfaceDelete.json"
86 }
87 },
88 "x-ms-long-running-operation": true,
89 "x-ms-long-running-operation-options": {
90 "final-state-via": "location"
91 }
92 },
93 "get": {
94 "tags": [
95 "NetworkInterfaces"
96 ],
97 "operationId": "NetworkInterfaces_Get",
98 "description": "Gets information about the specified network interface.",
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": "networkInterfaceName",
109 "in": "path",
110 "required": true,
111 "type": "string",
112 "description": "The name of the network interface."
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 NetworkInterface resource.",
131 "schema": {
132 "$ref": "#/definitions/NetworkInterface"
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 network interface": {
144 "$ref": "./examples/NetworkInterfaceGet.json"
145 }
146 }
147 },
148 "put": {
149 "tags": [
150 "NetworkInterfaces"
151 ],
152 "operationId": "NetworkInterfaces_CreateOrUpdate",
153 "description": "Creates or updates a network interface.",
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": "networkInterfaceName",
164 "in": "path",
165 "required": true,
166 "type": "string",
167 "description": "The name of the network interface."
168 },
169 {
170 "name": "parameters",
171 "in": "body",
172 "required": true,
173 "schema": {
174 "$ref": "#/definitions/NetworkInterface"
175 },
176 "description": "Parameters supplied to the create or update network interface operation."
177 },
178 {
179 "$ref": "./network.json#/parameters/ApiVersionParameter"
180 },
181 {
182 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
183 }
184 ],
185 "responses": {
186 "201": {
187 "description": "Create successful. The operation returns the resulting NetworkInterface resource.",
188 "schema": {
189 "$ref": "#/definitions/NetworkInterface"
190 }
191 },
192 "200": {
193 "description": "Update successful. The operation returns the resulting NetworkInterface resource.",
194 "schema": {
195 "$ref": "#/definitions/NetworkInterface"
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 network interface": {
207 "$ref": "./examples/NetworkInterfaceCreate.json"
208 }
209 },
210 "x-ms-long-running-operation": true,
211 "x-ms-long-running-operation-options": {
212 "final-state-via": "azure-async-operation"
213 }
214 },
215 "patch": {
216 "tags": [
217 "NetworkInterfaces"
218 ],
219 "operationId": "NetworkInterfaces_UpdateTags",
220 "description": "Updates a network interface tags.",
221 "parameters": [
222 {
223 "name": "resourceGroupName",
224 "in": "path",
225 "required": true,
226 "type": "string",
227 "description": "The name of the resource group."
228 },
229 {
230 "name": "networkInterfaceName",
231 "in": "path",
232 "required": true,
233 "type": "string",
234 "description": "The name of the network interface."
235 },
236 {
237 "name": "parameters",
238 "in": "body",
239 "required": true,
240 "schema": {
241 "$ref": "./network.json#/definitions/TagsObject"
242 },
243 "description": "Parameters supplied to update network interface tags."
244 },
245 {
246 "$ref": "./network.json#/parameters/ApiVersionParameter"
247 },
248 {
249 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
250 }
251 ],
252 "responses": {
253 "200": {
254 "description": "Update successful. The operation returns the resulting NetworkInterface resource.",
255 "schema": {
256 "$ref": "#/definitions/NetworkInterface"
257 }
258 },
259 "default": {
260 "description": "Error response describing why the operation failed.",
261 "schema": {
262 "$ref": "./network.json#/definitions/CloudError"
263 }
264 }
265 },
266 "x-ms-examples": {
267 "Update network interface tags": {
268 "$ref": "./examples/NetworkInterfaceUpdateTags.json"
269 }
270 }
271 }
272 },
273 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces": {
274 "get": {
275 "tags": [
276 "NetworkInterfaces"
277 ],
278 "operationId": "NetworkInterfaces_ListAll",
279 "description": "Gets all network interfaces in a subscription.",
280 "parameters": [
281 {
282 "$ref": "./network.json#/parameters/ApiVersionParameter"
283 },
284 {
285 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
286 }
287 ],
288 "responses": {
289 "200": {
290 "description": "Request successful. The operation returns a list of NetworkInterface resources.",
291 "schema": {
292 "$ref": "#/definitions/NetworkInterfaceListResult"
293 }
294 },
295 "default": {
296 "description": "Error response describing why the operation failed.",
297 "schema": {
298 "$ref": "./network.json#/definitions/CloudError"
299 }
300 }
301 },
302 "x-ms-examples": {
303 "List all network interfaces": {
304 "$ref": "./examples/NetworkInterfaceListAll.json"
305 }
306 },
307 "x-ms-pageable": {
308 "nextLinkName": "nextLink"
309 }
310 }
311 },
312 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces": {
313 "get": {
314 "tags": [
315 "NetworkInterfaces"
316 ],
317 "operationId": "NetworkInterfaces_List",
318 "description": "Gets all network interfaces in a resource group.",
319 "parameters": [
320 {
321 "name": "resourceGroupName",
322 "in": "path",
323 "required": true,
324 "type": "string",
325 "description": "The name of the resource group."
326 },
327 {
328 "$ref": "./network.json#/parameters/ApiVersionParameter"
329 },
330 {
331 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
332 }
333 ],
334 "responses": {
335 "200": {
336 "description": "Request successful. The operation returns a list of NetworkInterface resources.",
337 "schema": {
338 "$ref": "#/definitions/NetworkInterfaceListResult"
339 }
340 },
341 "default": {
342 "description": "Error response describing why the operation failed.",
343 "schema": {
344 "$ref": "./network.json#/definitions/CloudError"
345 }
346 }
347 },
348 "x-ms-examples": {
349 "List network interfaces in resource group": {
350 "$ref": "./examples/NetworkInterfaceList.json"
351 }
352 },
353 "x-ms-pageable": {
354 "nextLinkName": "nextLink"
355 }
356 }
357 },
358 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable": {
359 "post": {
360 "tags": [
361 "NetworkInterfaces"
362 ],
363 "operationId": "NetworkInterfaces_GetEffectiveRouteTable",
364 "description": "Gets all route tables applied to a network interface.",
365 "parameters": [
366 {
367 "name": "resourceGroupName",
368 "in": "path",
369 "required": true,
370 "type": "string",
371 "description": "The name of the resource group."
372 },
373 {
374 "name": "networkInterfaceName",
375 "in": "path",
376 "required": true,
377 "type": "string",
378 "description": "The name of the network interface."
379 },
380 {
381 "$ref": "./network.json#/parameters/ApiVersionParameter"
382 },
383 {
384 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
385 }
386 ],
387 "responses": {
388 "200": {
389 "description": "Request successful. The operation returns a list of EffectRoute resources.",
390 "schema": {
391 "$ref": "#/definitions/EffectiveRouteListResult"
392 }
393 },
394 "202": {
395 "description": "Accepted and the operation will complete asynchronously."
396 },
397 "default": {
398 "description": "Error response describing why the operation failed.",
399 "schema": {
400 "$ref": "./network.json#/definitions/CloudError"
401 }
402 }
403 },
404 "x-ms-examples": {
405 "Show network interface effective route tables": {
406 "$ref": "./examples/NetworkInterfaceEffectiveRouteTableList.json"
407 }
408 },
409 "x-ms-long-running-operation": true,
410 "x-ms-long-running-operation-options": {
411 "final-state-via": "location"
412 }
413 }
414 },
415 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups": {
416 "post": {
417 "tags": [
418 "NetworkInterfaces"
419 ],
420 "operationId": "NetworkInterfaces_ListEffectiveNetworkSecurityGroups",
421 "description": "Gets all network security groups applied to a network interface.",
422 "parameters": [
423 {
424 "name": "resourceGroupName",
425 "in": "path",
426 "required": true,
427 "type": "string",
428 "description": "The name of the resource group."
429 },
430 {
431 "name": "networkInterfaceName",
432 "in": "path",
433 "required": true,
434 "type": "string",
435 "description": "The name of the network interface."
436 },
437 {
438 "$ref": "./network.json#/parameters/ApiVersionParameter"
439 },
440 {
441 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
442 }
443 ],
444 "responses": {
445 "200": {
446 "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.",
447 "schema": {
448 "$ref": "#/definitions/EffectiveNetworkSecurityGroupListResult"
449 }
450 },
451 "202": {
452 "description": "Accepted and the operation will complete asynchronously."
453 },
454 "default": {
455 "description": "Error response describing why the operation failed.",
456 "schema": {
457 "$ref": "./network.json#/definitions/CloudError"
458 }
459 }
460 },
461 "x-ms-examples": {
462 "List network interface effective network security groups": {
463 "$ref": "./examples/NetworkInterfaceEffectiveNSGList.json"
464 }
465 },
466 "x-ms-long-running-operation": true,
467 "x-ms-long-running-operation-options": {
468 "final-state-via": "location"
469 }
470 }
471 },
472 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations": {
473 "get": {
474 "tags": [
475 "NetworkInterfaces"
476 ],
477 "operationId": "NetworkInterfaceIPConfigurations_List",
478 "description": "Get all ip configurations in a network interface.",
479 "parameters": [
480 {
481 "name": "resourceGroupName",
482 "in": "path",
483 "required": true,
484 "type": "string",
485 "description": "The name of the resource group."
486 },
487 {
488 "name": "networkInterfaceName",
489 "in": "path",
490 "required": true,
491 "type": "string",
492 "description": "The name of the network interface."
493 },
494 {
495 "$ref": "./network.json#/parameters/ApiVersionParameter"
496 },
497 {
498 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
499 }
500 ],
501 "responses": {
502 "200": {
503 "description": "Request successful. The operation returns a list of NetworkInterface IPConfiguration resources.",
504 "schema": {
505 "$ref": "#/definitions/NetworkInterfaceIPConfigurationListResult"
506 }
507 },
508 "default": {
509 "description": "Error response describing why the operation failed.",
510 "schema": {
511 "$ref": "./network.json#/definitions/CloudError"
512 }
513 }
514 },
515 "x-ms-pageable": {
516 "nextLinkName": "nextLink"
517 },
518 "x-ms-examples": {
519 "NetworkInterfaceIPConfigurationList": {
520 "$ref": "./examples/NetworkInterfaceIPConfigurationList.json"
521 }
522 }
523 }
524 },
525 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": {
526 "get": {
527 "tags": [
528 "NetworkInterfaces"
529 ],
530 "operationId": "NetworkInterfaceIPConfigurations_Get",
531 "description": "Gets the specified network interface ip configuration.",
532 "parameters": [
533 {
534 "name": "resourceGroupName",
535 "in": "path",
536 "required": true,
537 "type": "string",
538 "description": "The name of the resource group."
539 },
540 {
541 "name": "networkInterfaceName",
542 "in": "path",
543 "required": true,
544 "type": "string",
545 "description": "The name of the network interface."
546 },
547 {
548 "name": "ipConfigurationName",
549 "in": "path",
550 "required": true,
551 "type": "string",
552 "description": "The name of the ip configuration name."
553 },
554 {
555 "$ref": "./network.json#/parameters/ApiVersionParameter"
556 },
557 {
558 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
559 }
560 ],
561 "responses": {
562 "200": {
563 "description": "Request successful. The operation returns the resulting NetworkInterface IPConfiguration resource.",
564 "schema": {
565 "$ref": "#/definitions/NetworkInterfaceIPConfiguration"
566 }
567 },
568 "default": {
569 "description": "Error response describing why the operation failed.",
570 "schema": {
571 "$ref": "./network.json#/definitions/CloudError"
572 }
573 }
574 },
575 "x-ms-examples": {
576 "NetworkInterfaceIPConfigurationGet": {
577 "$ref": "./examples/NetworkInterfaceIPConfigurationGet.json"
578 }
579 }
580 }
581 },
582 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers": {
583 "get": {
584 "tags": [
585 "NetworkInterfaces"
586 ],
587 "operationId": "NetworkInterfaceLoadBalancers_List",
588 "description": "List all load balancers in a network interface.",
589 "parameters": [
590 {
591 "name": "resourceGroupName",
592 "in": "path",
593 "required": true,
594 "type": "string",
595 "description": "The name of the resource group."
596 },
597 {
598 "name": "networkInterfaceName",
599 "in": "path",
600 "required": true,
601 "type": "string",
602 "description": "The name of the network interface."
603 },
604 {
605 "$ref": "./network.json#/parameters/ApiVersionParameter"
606 },
607 {
608 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
609 }
610 ],
611 "responses": {
612 "200": {
613 "description": "Request successful. The operation returns a list of NetworkInterface LoadBalancer resources.",
614 "schema": {
615 "$ref": "#/definitions/NetworkInterfaceLoadBalancerListResult"
616 }
617 },
618 "default": {
619 "description": "Error response describing why the operation failed.",
620 "schema": {
621 "$ref": "./network.json#/definitions/CloudError"
622 }
623 }
624 },
625 "x-ms-pageable": {
626 "nextLinkName": "nextLink"
627 },
628 "x-ms-examples": {
629 "NetworkInterfaceLoadBalancerList": {
630 "$ref": "./examples/NetworkInterfaceLoadBalancerList.json"
631 }
632 }
633 }
634 },
635 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}": {
636 "delete": {
637 "tags": [
638 "Network Interfaces"
639 ],
640 "operationId": "NetworkInterfaceTapConfigurations_Delete",
641 "description": "Deletes the specified tap configuration from the NetworkInterface.",
642 "parameters": [
643 {
644 "name": "resourceGroupName",
645 "in": "path",
646 "required": true,
647 "type": "string",
648 "description": "The name of the resource group."
649 },
650 {
651 "name": "networkInterfaceName",
652 "in": "path",
653 "required": true,
654 "type": "string",
655 "description": "The name of the network interface."
656 },
657 {
658 "name": "tapConfigurationName",
659 "in": "path",
660 "required": true,
661 "type": "string",
662 "description": "The name of the tap configuration."
663 },
664 {
665 "$ref": "./network.json#/parameters/ApiVersionParameter"
666 },
667 {
668 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
669 }
670 ],
671 "responses": {
672 "200": {
673 "description": "Delete successful."
674 },
675 "202": {
676 "description": "Accepted and the operation will complete asynchronously."
677 },
678 "204": {
679 "description": "Delete successful."
680 },
681 "default": {
682 "description": "Error response describing why the operation failed.",
683 "schema": {
684 "$ref": "./network.json#/definitions/CloudError"
685 }
686 }
687 },
688 "x-ms-examples": {
689 "Delete tap configuration": {
690 "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json"
691 }
692 },
693 "x-ms-long-running-operation": true,
694 "x-ms-long-running-operation-options": {
695 "final-state-via": "location"
696 }
697 },
698 "get": {
699 "tags": [
700 "NetworkInterfaces"
701 ],
702 "operationId": "NetworkInterfaceTapConfigurations_Get",
703 "description": "Get the specified tap configuration on a network interface.",
704 "parameters": [
705 {
706 "name": "resourceGroupName",
707 "in": "path",
708 "required": true,
709 "type": "string",
710 "description": "The name of the resource group."
711 },
712 {
713 "name": "networkInterfaceName",
714 "in": "path",
715 "required": true,
716 "type": "string",
717 "description": "The name of the network interface."
718 },
719 {
720 "name": "tapConfigurationName",
721 "in": "path",
722 "required": true,
723 "type": "string",
724 "description": "The name of the tap configuration."
725 },
726 {
727 "$ref": "./network.json#/parameters/ApiVersionParameter"
728 },
729 {
730 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
731 }
732 ],
733 "responses": {
734 "200": {
735 "description": "Request successful. The operation returns a tap configuration.",
736 "schema": {
737 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
738 }
739 },
740 "default": {
741 "description": "Error response describing why the operation failed.",
742 "schema": {
743 "$ref": "./network.json#/definitions/CloudError"
744 }
745 }
746 },
747 "x-ms-examples": {
748 "Get Network Interface Tap Configurations": {
749 "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json"
750 }
751 }
752 },
753 "put": {
754 "tags": [
755 "Network Interfaces"
756 ],
757 "operationId": "NetworkInterfaceTapConfigurations_CreateOrUpdate",
758 "description": "Creates or updates a Tap configuration in the specified NetworkInterface.",
759 "parameters": [
760 {
761 "name": "resourceGroupName",
762 "in": "path",
763 "required": true,
764 "type": "string",
765 "description": "The name of the resource group."
766 },
767 {
768 "name": "networkInterfaceName",
769 "in": "path",
770 "required": true,
771 "type": "string",
772 "description": "The name of the network interface."
773 },
774 {
775 "name": "tapConfigurationName",
776 "in": "path",
777 "required": true,
778 "type": "string",
779 "description": "The name of the tap configuration."
780 },
781 {
782 "name": "tapConfigurationParameters",
783 "in": "body",
784 "required": true,
785 "schema": {
786 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
787 },
788 "description": "Parameters supplied to the create or update tap configuration operation."
789 },
790 {
791 "$ref": "./network.json#/parameters/ApiVersionParameter"
792 },
793 {
794 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
795 }
796 ],
797 "responses": {
798 "200": {
799 "description": "Update successful. The operation returns the resulting Tap Configuration resource.",
800 "schema": {
801 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
802 }
803 },
804 "201": {
805 "description": "Create successful. The operation returns the resulting Tap configuration resource.",
806 "schema": {
807 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
808 }
809 },
810 "default": {
811 "description": "Error response describing why the operation failed.",
812 "schema": {
813 "$ref": "./network.json#/definitions/CloudError"
814 }
815 }
816 },
817 "x-ms-examples": {
818 "Create Network Interface Tap Configurations": {
819 "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json"
820 }
821 },
822 "x-ms-long-running-operation": true,
823 "x-ms-long-running-operation-options": {
824 "final-state-via": "azure-async-operation"
825 }
826 }
827 },
828 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations": {
829 "get": {
830 "tags": [
831 "NetworkInterfaces"
832 ],
833 "operationId": "NetworkInterfaceTapConfigurations_List",
834 "description": "Get all Tap configurations in a network interface.",
835 "parameters": [
836 {
837 "name": "resourceGroupName",
838 "in": "path",
839 "required": true,
840 "type": "string",
841 "description": "The name of the resource group."
842 },
843 {
844 "name": "networkInterfaceName",
845 "in": "path",
846 "required": true,
847 "type": "string",
848 "description": "The name of the network interface."
849 },
850 {
851 "$ref": "./network.json#/parameters/ApiVersionParameter"
852 },
853 {
854 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
855 }
856 ],
857 "responses": {
858 "200": {
859 "description": "Request successful. The operation returns a list of NetworkInterface TapConfiguration resources.",
860 "schema": {
861 "$ref": "#/definitions/NetworkInterfaceTapConfigurationListResult"
862 }
863 },
864 "default": {
865 "description": "Error response describing why the operation failed.",
866 "schema": {
867 "$ref": "./network.json#/definitions/CloudError"
868 }
869 }
870 },
871 "x-ms-examples": {
872 "List virtual network tap configurations": {
873 "$ref": "./examples/NetworkInterfaceTapConfigurationList.json"
874 }
875 },
876 "x-ms-pageable": {
877 "nextLinkName": "nextLink"
878 }
879 }
880 }
881 },
882 "definitions": {
883 "NetworkInterfaceTapConfiguration": {
884 "properties": {
885 "properties": {
886 "x-ms-client-flatten": true,
887 "$ref": "#/definitions/NetworkInterfaceTapConfigurationPropertiesFormat",
888 "description": "Properties of the Virtual Network Tap configuration."
889 },
890 "name": {
891 "type": "string",
892 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
893 },
894 "etag": {
895 "readOnly": true,
896 "type": "string",
897 "description": "A unique read-only string that changes whenever the resource is updated."
898 },
899 "type": {
900 "readOnly": true,
901 "type": "string",
902 "description": "Sub Resource type."
903 }
904 },
905 "allOf": [
906 {
907 "$ref": "./network.json#/definitions/SubResource"
908 }
909 ],
910 "description": "Tap configuration in a Network Interface."
911 },
912 "NetworkInterfaceTapConfigurationPropertiesFormat": {
913 "properties": {
914 "virtualNetworkTap": {
915 "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap",
916 "description": "The reference to the Virtual Network Tap resource."
917 },
918 "provisioningState": {
919 "readOnly": true,
920 "$ref": "./network.json#/definitions/ProvisioningState",
921 "description": "The provisioning state of the network interface tap configuration resource."
922 }
923 },
924 "description": "Properties of Virtual Network Tap configuration."
925 },
926 "NetworkInterfaceIPConfigurationPropertiesFormat": {
927 "properties": {
928 "virtualNetworkTaps": {
929 "type": "array",
930 "items": {
931 "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap"
932 },
933 "description": "The reference to Virtual Network Taps."
934 },
935 "applicationGatewayBackendAddressPools": {
936 "type": "array",
937 "items": {
938 "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool"
939 },
940 "description": "The reference to ApplicationGatewayBackendAddressPool resource."
941 },
942 "loadBalancerBackendAddressPools": {
943 "type": "array",
944 "items": {
945 "$ref": "./loadBalancer.json#/definitions/BackendAddressPool"
946 },
947 "description": "The reference to LoadBalancerBackendAddressPool resource."
948 },
949 "loadBalancerInboundNatRules": {
950 "type": "array",
951 "items": {
952 "$ref": "./loadBalancer.json#/definitions/InboundNatRule"
953 },
954 "description": "A list of references of LoadBalancerInboundNatRules."
955 },
956 "privateIPAddress": {
957 "type": "string",
958 "description": "Private IP address of the IP configuration."
959 },
960 "privateIPAllocationMethod": {
961 "$ref": "./network.json#/definitions/IPAllocationMethod",
962 "description": "The private IP address allocation method."
963 },
964 "privateIPAddressVersion": {
965 "$ref": "./network.json#/definitions/IPVersion",
966 "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4."
967 },
968 "subnet": {
969 "$ref": "./virtualNetwork.json#/definitions/Subnet",
970 "description": "Subnet bound to the IP configuration."
971 },
972 "primary": {
973 "type": "boolean",
974 "description": "Whether this is a primary customer address on the network interface."
975 },
976 "publicIPAddress": {
977 "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress",
978 "description": "Public IP address bound to the IP configuration."
979 },
980 "applicationSecurityGroups": {
981 "type": "array",
982 "items": {
983 "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup"
984 },
985 "description": "Application security groups in which the IP configuration is included."
986 },
987 "provisioningState": {
988 "readOnly": true,
989 "$ref": "./network.json#/definitions/ProvisioningState",
990 "description": "The provisioning state of the network interface IP configuration."
991 },
992 "privateLinkConnectionProperties": {
993 "$ref": "#/definitions/NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties",
994 "description": "PrivateLinkConnection properties for the network interface.",
995 "readOnly": true
996 }
997 },
998 "description": "Properties of IP configuration."
999 },
1000 "NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties": {
1001 "properties": {
1002 "groupId": {
1003 "type": "string",
1004 "readOnly": true,
1005 "description": "The group ID for current private link connection."
1006 },
1007 "requiredMemberName": {
1008 "type": "string",
1009 "readOnly": true,
1010 "description": "The required member name for current private link connection."
1011 },
1012 "fqdns": {
1013 "type": "array",
1014 "items": {
1015 "type": "string"
1016 },
1017 "readOnly": true,
1018 "description": "List of FQDNs for current private link connection."
1019 }
1020 },
1021 "description": "PrivateLinkConnection properties for the network interface."
1022 },
1023 "NetworkInterfaceIPConfiguration": {
1024 "properties": {
1025 "properties": {
1026 "x-ms-client-flatten": true,
1027 "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat",
1028 "description": "Network interface IP configuration properties."
1029 },
1030 "name": {
1031 "type": "string",
1032 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
1033 },
1034 "etag": {
1035 "readOnly": true,
1036 "type": "string",
1037 "description": "A unique read-only string that changes whenever the resource is updated."
1038 }
1039 },
1040 "allOf": [
1041 {
1042 "$ref": "./network.json#/definitions/SubResource"
1043 }
1044 ],
1045 "description": "IPConfiguration in a network interface."
1046 },
1047 "NetworkInterfaceDnsSettings": {
1048 "properties": {
1049 "dnsServers": {
1050 "type": "array",
1051 "items": {
1052 "type": "string"
1053 },
1054 "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection."
1055 },
1056 "appliedDnsServers": {
1057 "readOnly": true,
1058 "type": "array",
1059 "items": {
1060 "type": "string"
1061 },
1062 "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs."
1063 },
1064 "internalDnsNameLabel": {
1065 "type": "string",
1066 "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network."
1067 },
1068 "internalFqdn": {
1069 "readOnly": true,
1070 "type": "string",
1071 "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network."
1072 },
1073 "internalDomainNameSuffix": {
1074 "readOnly": true,
1075 "type": "string",
1076 "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix."
1077 }
1078 },
1079 "description": "DNS settings of a network interface."
1080 },
1081 "NetworkInterfacePropertiesFormat": {
1082 "properties": {
1083 "virtualMachine": {
1084 "$ref": "./network.json#/definitions/SubResource",
1085 "description": "The reference to a virtual machine.",
1086 "readOnly": true
1087 },
1088 "networkSecurityGroup": {
1089 "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup",
1090 "description": "The reference to the NetworkSecurityGroup resource."
1091 },
1092 "privateEndpoint": {
1093 "readOnly": true,
1094 "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint",
1095 "description": "A reference to the private endpoint to which the network interface is linked."
1096 },
1097 "ipConfigurations": {
1098 "type": "array",
1099 "items": {
1100 "$ref": "#/definitions/NetworkInterfaceIPConfiguration"
1101 },
1102 "description": "A list of IPConfigurations of the network interface."
1103 },
1104 "tapConfigurations": {
1105 "readOnly": true,
1106 "type": "array",
1107 "items": {
1108 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
1109 },
1110 "description": "A list of TapConfigurations of the network interface."
1111 },
1112 "dnsSettings": {
1113 "$ref": "#/definitions/NetworkInterfaceDnsSettings",
1114 "description": "The DNS settings in network interface."
1115 },
1116 "macAddress": {
1117 "readOnly": true,
1118 "type": "string",
1119 "description": "The MAC address of the network interface."
1120 },
1121 "primary": {
1122 "readOnly": true,
1123 "type": "boolean",
1124 "description": "Whether this is a primary network interface on a virtual machine."
1125 },
1126 "enableAcceleratedNetworking": {
1127 "type": "boolean",
1128 "description": "If the network interface is accelerated networking enabled."
1129 },
1130 "enableIPForwarding": {
1131 "type": "boolean",
1132 "description": "Indicates whether IP forwarding is enabled on this network interface."
1133 },
1134 "hostedWorkloads": {
1135 "type": "array",
1136 "items": {
1137 "type": "string"
1138 },
1139 "readOnly": true,
1140 "description": "A list of references to linked BareMetal resources."
1141 },
1142 "resourceGuid": {
1143 "readOnly": true,
1144 "type": "string",
1145 "description": "The resource GUID property of the network interface resource."
1146 },
1147 "provisioningState": {
1148 "readOnly": true,
1149 "$ref": "./network.json#/definitions/ProvisioningState",
1150 "description": "The provisioning state of the network interface resource."
1151 }
1152 },
1153 "description": "NetworkInterface properties."
1154 },
1155 "NetworkInterface": {
1156 "properties": {
1157 "properties": {
1158 "x-ms-client-flatten": true,
1159 "$ref": "#/definitions/NetworkInterfacePropertiesFormat",
1160 "description": "Properties of the network interface."
1161 },
1162 "etag": {
1163 "readOnly": true,
1164 "type": "string",
1165 "description": "A unique read-only string that changes whenever the resource is updated."
1166 }
1167 },
1168 "allOf": [
1169 {
1170 "$ref": "./network.json#/definitions/Resource"
1171 }
1172 ],
1173 "description": "A network interface in a resource group."
1174 },
1175 "NetworkInterfaceListResult": {
1176 "properties": {
1177 "value": {
1178 "type": "array",
1179 "items": {
1180 "$ref": "#/definitions/NetworkInterface"
1181 },
1182 "description": "A list of network interfaces in a resource group."
1183 },
1184 "nextLink": {
1185 "readOnly": true,
1186 "type": "string",
1187 "description": "The URL to get the next set of results."
1188 }
1189 },
1190 "description": "Response for the ListNetworkInterface API service call."
1191 },
1192 "NetworkInterfaceTapConfigurationListResult": {
1193 "properties": {
1194 "value": {
1195 "type": "array",
1196 "items": {
1197 "$ref": "#/definitions/NetworkInterfaceTapConfiguration"
1198 },
1199 "description": "A list of tap configurations."
1200 },
1201 "nextLink": {
1202 "readOnly": true,
1203 "type": "string",
1204 "description": "The URL to get the next set of results."
1205 }
1206 },
1207 "description": "Response for list tap configurations API service call."
1208 },
1209 "NetworkInterfaceIPConfigurationListResult": {
1210 "properties": {
1211 "value": {
1212 "type": "array",
1213 "items": {
1214 "$ref": "#/definitions/NetworkInterfaceIPConfiguration"
1215 },
1216 "description": "A list of ip configurations."
1217 },
1218 "nextLink": {
1219 "readOnly": true,
1220 "type": "string",
1221 "description": "The URL to get the next set of results."
1222 }
1223 },
1224 "description": "Response for list ip configurations API service call."
1225 },
1226 "NetworkInterfaceLoadBalancerListResult": {
1227 "properties": {
1228 "value": {
1229 "type": "array",
1230 "items": {
1231 "$ref": "./loadBalancer.json#/definitions/LoadBalancer"
1232 },
1233 "description": "A list of load balancers."
1234 },
1235 "nextLink": {
1236 "readOnly": true,
1237 "type": "string",
1238 "description": "The URL to get the next set of results."
1239 }
1240 },
1241 "description": "Response for list ip configurations API service call."
1242 },
1243 "EffectiveNetworkSecurityGroup": {
1244 "properties": {
1245 "networkSecurityGroup": {
1246 "$ref": "./network.json#/definitions/SubResource",
1247 "description": "The ID of network security group that is applied."
1248 },
1249 "association": {
1250 "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation",
1251 "description": "Associated resources."
1252 },
1253 "effectiveSecurityRules": {
1254 "type": "array",
1255 "items": {
1256 "$ref": "#/definitions/EffectiveNetworkSecurityRule"
1257 },
1258 "description": "A collection of effective security rules."
1259 },
1260 "tagMap": {
1261 "type": "string",
1262 "additionalProperties": {
1263 "type": "array",
1264 "items": {
1265 "type": "string"
1266 },
1267 "description": "List of IP Addresses within the tag (key)."
1268 },
1269 "description": "Mapping of tags to list of IP Addresses included within the tag."
1270 }
1271 },
1272 "description": "Effective network security group."
1273 },
1274 "EffectiveNetworkSecurityGroupAssociation": {
1275 "properties": {
1276 "subnet": {
1277 "$ref": "./network.json#/definitions/SubResource",
1278 "description": "The ID of the subnet if assigned."
1279 },
1280 "networkInterface": {
1281 "$ref": "./network.json#/definitions/SubResource",
1282 "description": "The ID of the network interface if assigned."
1283 }
1284 },
1285 "description": "The effective network security group association."
1286 },
1287 "EffectiveNetworkSecurityRule": {
1288 "properties": {
1289 "name": {
1290 "type": "string",
1291 "description": "The name of the security rule specified by the user (if created by the user)."
1292 },
1293 "protocol": {
1294 "type": "string",
1295 "description": "The network protocol this rule applies to.",
1296 "enum": [
1297 "Tcp",
1298 "Udp",
1299 "All"
1300 ],
1301 "x-ms-enum": {
1302 "name": "EffectiveSecurityRuleProtocol",
1303 "modelAsString": true
1304 }
1305 },
1306 "sourcePortRange": {
1307 "type": "string",
1308 "description": "The source port or range."
1309 },
1310 "destinationPortRange": {
1311 "type": "string",
1312 "description": "The destination port or range."
1313 },
1314 "sourcePortRanges": {
1315 "type": "array",
1316 "items": {
1317 "type": "string"
1318 },
1319 "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)."
1320 },
1321 "destinationPortRanges": {
1322 "type": "array",
1323 "items": {
1324 "type": "string"
1325 },
1326 "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)."
1327 },
1328 "sourceAddressPrefix": {
1329 "type": "string",
1330 "description": "The source address prefix."
1331 },
1332 "destinationAddressPrefix": {
1333 "type": "string",
1334 "description": "The destination address prefix."
1335 },
1336 "sourceAddressPrefixes": {
1337 "type": "array",
1338 "items": {
1339 "type": "string"
1340 },
1341 "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)."
1342 },
1343 "destinationAddressPrefixes": {
1344 "type": "array",
1345 "items": {
1346 "type": "string"
1347 },
1348 "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)."
1349 },
1350 "expandedSourceAddressPrefix": {
1351 "type": "array",
1352 "items": {
1353 "type": "string"
1354 },
1355 "description": "The expanded source address prefix."
1356 },
1357 "expandedDestinationAddressPrefix": {
1358 "type": "array",
1359 "items": {
1360 "type": "string"
1361 },
1362 "description": "Expanded destination address prefix."
1363 },
1364 "access": {
1365 "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess",
1366 "description": "Whether network traffic is allowed or denied."
1367 },
1368 "priority": {
1369 "type": "integer",
1370 "format": "int32",
1371 "description": "The priority of the rule."
1372 },
1373 "direction": {
1374 "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleDirection",
1375 "description": "The direction of the rule."
1376 }
1377 },
1378 "description": "Effective network security rules."
1379 },
1380 "EffectiveNetworkSecurityGroupListResult": {
1381 "properties": {
1382 "value": {
1383 "type": "array",
1384 "items": {
1385 "$ref": "#/definitions/EffectiveNetworkSecurityGroup"
1386 },
1387 "description": "A list of effective network security groups."
1388 },
1389 "nextLink": {
1390 "readOnly": true,
1391 "type": "string",
1392 "description": "The URL to get the next set of results."
1393 }
1394 },
1395 "description": "Response for list effective network security groups API service call."
1396 },
1397 "EffectiveRoute": {
1398 "properties": {
1399 "name": {
1400 "type": "string",
1401 "description": "The name of the user defined route. This is optional."
1402 },
1403 "disableBgpRoutePropagation": {
1404 "type": "boolean",
1405 "description": "If true, on-premises routes are not propagated to the network interfaces in the subnet."
1406 },
1407 "source": {
1408 "type": "string",
1409 "description": "Who created the route.",
1410 "enum": [
1411 "Unknown",
1412 "User",
1413 "VirtualNetworkGateway",
1414 "Default"
1415 ],
1416 "x-ms-enum": {
1417 "name": "EffectiveRouteSource",
1418 "modelAsString": true
1419 }
1420 },
1421 "state": {
1422 "type": "string",
1423 "description": "The value of effective route.",
1424 "enum": [
1425 "Active",
1426 "Invalid"
1427 ],
1428 "x-ms-enum": {
1429 "name": "EffectiveRouteState",
1430 "modelAsString": true
1431 }
1432 },
1433 "addressPrefix": {
1434 "type": "array",
1435 "items": {
1436 "type": "string"
1437 },
1438 "description": "The address prefixes of the effective routes in CIDR notation."
1439 },
1440 "nextHopIpAddress": {
1441 "type": "array",
1442 "items": {
1443 "type": "string"
1444 },
1445 "description": "The IP address of the next hop of the effective route."
1446 },
1447 "nextHopType": {
1448 "$ref": "./routeTable.json#/definitions/RouteNextHopType",
1449 "description": "The type of Azure hop the packet should be sent to."
1450 }
1451 },
1452 "description": "Effective Route."
1453 },
1454 "EffectiveRouteListResult": {
1455 "properties": {
1456 "value": {
1457 "type": "array",
1458 "items": {
1459 "$ref": "#/definitions/EffectiveRoute"
1460 },
1461 "description": "A list of effective routes."
1462 },
1463 "nextLink": {
1464 "readOnly": true,
1465 "type": "string",
1466 "description": "The URL to get the next set of results."
1467 }
1468 },
1469 "description": "Response for list effective route API service call."
1470 },
1471 "IPConfigurationPropertiesFormat": {
1472 "properties": {
1473 "privateIPAddress": {
1474 "type": "string",
1475 "description": "The private IP address of the IP configuration."
1476 },
1477 "privateIPAllocationMethod": {
1478 "$ref": "./network.json#/definitions/IPAllocationMethod",
1479 "description": "The private IP address allocation method."
1480 },
1481 "subnet": {
1482 "$ref": "./virtualNetwork.json#/definitions/Subnet",
1483 "description": "The reference to the subnet resource."
1484 },
1485 "publicIPAddress": {
1486 "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress",
1487 "description": "The reference to the public IP resource."
1488 },
1489 "provisioningState": {
1490 "readOnly": true,
1491 "$ref": "./network.json#/definitions/ProvisioningState",
1492 "description": "The provisioning state of the IP configuration resource."
1493 }
1494 },
1495 "description": "Properties of IP configuration."
1496 },
1497 "IPConfiguration": {
1498 "properties": {
1499 "properties": {
1500 "x-ms-client-flatten": true,
1501 "$ref": "#/definitions/IPConfigurationPropertiesFormat",
1502 "description": "Properties of the IP configuration."
1503 },
1504 "name": {
1505 "type": "string",
1506 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
1507 },
1508 "etag": {
1509 "readOnly": true,
1510 "type": "string",
1511 "description": "A unique read-only string that changes whenever the resource is updated."
1512 }
1513 },
1514 "allOf": [
1515 {
1516 "$ref": "./network.json#/definitions/SubResource"
1517 }
1518 ],
1519 "description": "IP configuration."
1520 }
1521 }
1522}
View as plain text