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/applicationGateways/{applicationGatewayName}": {
38 "delete": {
39 "tags": [
40 "ApplicationGateways"
41 ],
42 "operationId": "ApplicationGateways_Delete",
43 "x-ms-examples": {
44 "Delete ApplicationGateway": {
45 "$ref": "./examples/ApplicationGatewayDelete.json"
46 }
47 },
48 "description": "Deletes the specified application gateway.",
49 "parameters": [
50 {
51 "name": "resourceGroupName",
52 "in": "path",
53 "required": true,
54 "type": "string",
55 "description": "The name of the resource group."
56 },
57 {
58 "name": "applicationGatewayName",
59 "in": "path",
60 "required": true,
61 "type": "string",
62 "description": "The name of the application gateway."
63 },
64 {
65 "$ref": "./network.json#/parameters/ApiVersionParameter"
66 },
67 {
68 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
69 }
70 ],
71 "responses": {
72 "202": {
73 "description": "Accepted and the operation will complete asynchronously."
74 },
75 "204": {
76 "description": "Request successful. Resource with the specified name does not exist."
77 },
78 "200": {
79 "description": "Delete successful."
80 },
81 "default": {
82 "description": "Error response describing why the operation failed.",
83 "schema": {
84 "$ref": "./network.json#/definitions/CloudError"
85 }
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 "ApplicationGateways"
96 ],
97 "operationId": "ApplicationGateways_Get",
98 "x-ms-examples": {
99 "Get ApplicationGateway": {
100 "$ref": "./examples/ApplicationGatewayGet.json"
101 }
102 },
103 "description": "Gets the specified application gateway.",
104 "parameters": [
105 {
106 "name": "resourceGroupName",
107 "in": "path",
108 "required": true,
109 "type": "string",
110 "description": "The name of the resource group."
111 },
112 {
113 "name": "applicationGatewayName",
114 "in": "path",
115 "required": true,
116 "type": "string",
117 "description": "The name of the application gateway."
118 },
119 {
120 "$ref": "./network.json#/parameters/ApiVersionParameter"
121 },
122 {
123 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
124 }
125 ],
126 "responses": {
127 "200": {
128 "description": "Request successful. The operation returns an ApplicationGateway resource.",
129 "schema": {
130 "$ref": "#/definitions/ApplicationGateway"
131 }
132 },
133 "default": {
134 "description": "Error response describing why the operation failed.",
135 "schema": {
136 "$ref": "./network.json#/definitions/CloudError"
137 }
138 }
139 }
140 },
141 "put": {
142 "tags": [
143 "ApplicationGateways"
144 ],
145 "operationId": "ApplicationGateways_CreateOrUpdate",
146 "description": "Creates or updates the specified application gateway.",
147 "parameters": [
148 {
149 "name": "resourceGroupName",
150 "in": "path",
151 "required": true,
152 "type": "string",
153 "description": "The name of the resource group."
154 },
155 {
156 "name": "applicationGatewayName",
157 "in": "path",
158 "required": true,
159 "type": "string",
160 "description": "The name of the application gateway."
161 },
162 {
163 "name": "parameters",
164 "in": "body",
165 "required": true,
166 "schema": {
167 "$ref": "#/definitions/ApplicationGateway"
168 },
169 "description": "Parameters supplied to the create or update application gateway operation."
170 },
171 {
172 "$ref": "./network.json#/parameters/ApiVersionParameter"
173 },
174 {
175 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
176 }
177 ],
178 "responses": {
179 "201": {
180 "description": "Create successful. The operation returns the resulting ApplicationGateway resource.",
181 "schema": {
182 "$ref": "#/definitions/ApplicationGateway"
183 }
184 },
185 "200": {
186 "description": "Update successful. The operation returns the resulting ApplicationGateway resource.",
187 "schema": {
188 "$ref": "#/definitions/ApplicationGateway"
189 }
190 },
191 "default": {
192 "description": "Error response describing why the operation failed.",
193 "schema": {
194 "$ref": "./network.json#/definitions/CloudError"
195 }
196 }
197 },
198 "x-ms-examples": {
199 "Create Application Gateway": {
200 "$ref": "./examples/ApplicationGatewayCreate.json"
201 }
202 },
203 "x-ms-long-running-operation": true,
204 "x-ms-long-running-operation-options": {
205 "final-state-via": "azure-async-operation"
206 }
207 },
208 "patch": {
209 "tags": [
210 "ApplicationGateways"
211 ],
212 "operationId": "ApplicationGateways_UpdateTags",
213 "x-ms-examples": {
214 "Update Application Gateway tags": {
215 "$ref": "./examples/ApplicationGatewayUpdateTags.json"
216 }
217 },
218 "description": "Updates the specified application gateway tags.",
219 "parameters": [
220 {
221 "name": "resourceGroupName",
222 "in": "path",
223 "required": true,
224 "type": "string",
225 "description": "The name of the resource group."
226 },
227 {
228 "name": "applicationGatewayName",
229 "in": "path",
230 "required": true,
231 "type": "string",
232 "description": "The name of the application gateway."
233 },
234 {
235 "name": "parameters",
236 "in": "body",
237 "required": true,
238 "schema": {
239 "$ref": "./network.json#/definitions/TagsObject"
240 },
241 "description": "Parameters supplied to update application gateway tags."
242 },
243 {
244 "$ref": "./network.json#/parameters/ApiVersionParameter"
245 },
246 {
247 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
248 }
249 ],
250 "responses": {
251 "200": {
252 "description": "Update successful. The operation returns the resulting ApplicationGateway resource.",
253 "schema": {
254 "$ref": "#/definitions/ApplicationGateway"
255 }
256 },
257 "default": {
258 "description": "Error response describing why the operation failed.",
259 "schema": {
260 "$ref": "./network.json#/definitions/CloudError"
261 }
262 }
263 }
264 }
265 },
266 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": {
267 "get": {
268 "tags": [
269 "ApplicationGateways"
270 ],
271 "operationId": "ApplicationGateways_List",
272 "x-ms-examples": {
273 "Lists all application gateways in a resource group": {
274 "$ref": "./examples/ApplicationGatewayList.json"
275 }
276 },
277 "description": "Lists all application gateways in a resource group.",
278 "parameters": [
279 {
280 "name": "resourceGroupName",
281 "in": "path",
282 "required": true,
283 "type": "string",
284 "description": "The name of the resource group."
285 },
286 {
287 "$ref": "./network.json#/parameters/ApiVersionParameter"
288 },
289 {
290 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
291 }
292 ],
293 "responses": {
294 "200": {
295 "description": "Success. The operation returns a list of ApplicationGateway resources.",
296 "schema": {
297 "$ref": "#/definitions/ApplicationGatewayListResult"
298 }
299 },
300 "default": {
301 "description": "Error response describing why the operation failed.",
302 "schema": {
303 "$ref": "./network.json#/definitions/CloudError"
304 }
305 }
306 },
307 "x-ms-pageable": {
308 "nextLinkName": "nextLink"
309 }
310 }
311 },
312 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": {
313 "get": {
314 "tags": [
315 "ApplicationGateways"
316 ],
317 "operationId": "ApplicationGateways_ListAll",
318 "x-ms-examples": {
319 "Lists all application gateways in a subscription": {
320 "$ref": "./examples/ApplicationGatewayListAll.json"
321 }
322 },
323 "description": "Gets all the application gateways in a subscription.",
324 "parameters": [
325 {
326 "$ref": "./network.json#/parameters/ApiVersionParameter"
327 },
328 {
329 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
330 }
331 ],
332 "responses": {
333 "200": {
334 "description": "Success. The operation returns a list of ApplicationGateway resources.",
335 "schema": {
336 "$ref": "#/definitions/ApplicationGatewayListResult"
337 }
338 },
339 "default": {
340 "description": "Error response describing why the operation failed.",
341 "schema": {
342 "$ref": "./network.json#/definitions/CloudError"
343 }
344 }
345 },
346 "x-ms-pageable": {
347 "nextLinkName": "nextLink"
348 }
349 }
350 },
351 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": {
352 "post": {
353 "tags": [
354 "ApplicationGateways"
355 ],
356 "operationId": "ApplicationGateways_Start",
357 "x-ms-examples": {
358 "Start Application Gateway": {
359 "$ref": "./examples/ApplicationGatewayStart.json"
360 }
361 },
362 "description": "Starts the specified application gateway.",
363 "parameters": [
364 {
365 "name": "resourceGroupName",
366 "in": "path",
367 "required": true,
368 "type": "string",
369 "description": "The name of the resource group."
370 },
371 {
372 "name": "applicationGatewayName",
373 "in": "path",
374 "required": true,
375 "type": "string",
376 "description": "The name of the application gateway."
377 },
378 {
379 "$ref": "./network.json#/parameters/ApiVersionParameter"
380 },
381 {
382 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
383 }
384 ],
385 "responses": {
386 "200": {
387 "description": "Request successful. The operation starts the ApplicationGateway resource."
388 },
389 "202": {
390 "description": "Accepted and the operation will complete asynchronously."
391 },
392 "default": {
393 "description": "Error response describing why the operation failed.",
394 "schema": {
395 "$ref": "./network.json#/definitions/CloudError"
396 }
397 }
398 },
399 "x-ms-long-running-operation": true,
400 "x-ms-long-running-operation-options": {
401 "final-state-via": "location"
402 }
403 }
404 },
405 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": {
406 "post": {
407 "tags": [
408 "ApplicationGateways"
409 ],
410 "operationId": "ApplicationGateways_Stop",
411 "x-ms-examples": {
412 "Stop Application Gateway": {
413 "$ref": "./examples/ApplicationGatewayStop.json"
414 }
415 },
416 "description": "Stops the specified application gateway in a resource group.",
417 "parameters": [
418 {
419 "name": "resourceGroupName",
420 "in": "path",
421 "required": true,
422 "type": "string",
423 "description": "The name of the resource group."
424 },
425 {
426 "name": "applicationGatewayName",
427 "in": "path",
428 "required": true,
429 "type": "string",
430 "description": "The name of the application gateway."
431 },
432 {
433 "$ref": "./network.json#/parameters/ApiVersionParameter"
434 },
435 {
436 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
437 }
438 ],
439 "responses": {
440 "200": {
441 "description": "Request successful. The operation stops the ApplicationGateway resource."
442 },
443 "202": {
444 "description": "Accepted and the operation will complete asynchronously."
445 },
446 "default": {
447 "description": "Error response describing why the operation failed.",
448 "schema": {
449 "$ref": "./network.json#/definitions/CloudError"
450 }
451 }
452 },
453 "x-ms-long-running-operation": true,
454 "x-ms-long-running-operation-options": {
455 "final-state-via": "location"
456 }
457 }
458 },
459 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": {
460 "post": {
461 "tags": [
462 "ApplicationGateways"
463 ],
464 "operationId": "ApplicationGateways_BackendHealth",
465 "description": "Gets the backend health of the specified application gateway in a resource group.",
466 "x-ms-examples": {
467 "Get Backend Health": {
468 "$ref": "./examples/ApplicationGatewayBackendHealthGet.json"
469 }
470 },
471 "parameters": [
472 {
473 "name": "resourceGroupName",
474 "in": "path",
475 "required": true,
476 "type": "string",
477 "description": "The name of the resource group."
478 },
479 {
480 "name": "applicationGatewayName",
481 "in": "path",
482 "required": true,
483 "type": "string",
484 "description": "The name of the application gateway."
485 },
486 {
487 "$ref": "./network.json#/parameters/ApiVersionParameter"
488 },
489 {
490 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
491 },
492 {
493 "name": "$expand",
494 "in": "query",
495 "required": false,
496 "type": "string",
497 "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health."
498 }
499 ],
500 "responses": {
501 "200": {
502 "description": "Request successful.",
503 "schema": {
504 "$ref": "#/definitions/ApplicationGatewayBackendHealth"
505 }
506 },
507 "202": {
508 "description": "Accepted and the operation will complete asynchronously."
509 },
510 "default": {
511 "description": "Error response describing why the operation failed.",
512 "schema": {
513 "$ref": "./network.json#/definitions/CloudError"
514 }
515 }
516 },
517 "x-ms-long-running-operation": true,
518 "x-ms-long-running-operation-options": {
519 "final-state-via": "location"
520 }
521 }
522 },
523 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": {
524 "post": {
525 "tags": [
526 "ApplicationGateways"
527 ],
528 "operationId": "ApplicationGateways_BackendHealthOnDemand",
529 "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.",
530 "x-ms-examples": {
531 "Test Backend Health": {
532 "$ref": "./examples/ApplicationGatewayBackendHealthTest.json"
533 }
534 },
535 "parameters": [
536 {
537 "name": "resourceGroupName",
538 "in": "path",
539 "required": true,
540 "type": "string",
541 "description": "The name of the resource group."
542 },
543 {
544 "name": "applicationGatewayName",
545 "in": "path",
546 "required": true,
547 "type": "string",
548 "description": "The name of the application gateway."
549 },
550 {
551 "$ref": "./network.json#/parameters/ApiVersionParameter"
552 },
553 {
554 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
555 },
556 {
557 "name": "$expand",
558 "in": "query",
559 "required": false,
560 "type": "string",
561 "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health."
562 },
563 {
564 "name": "probeRequest",
565 "in": "body",
566 "required": true,
567 "schema": {
568 "$ref": "#/definitions/ApplicationGatewayOnDemandProbe"
569 },
570 "description": "Request body for on-demand test probe operation."
571 }
572 ],
573 "responses": {
574 "200": {
575 "description": "Request successful.",
576 "schema": {
577 "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand"
578 }
579 },
580 "202": {
581 "description": "Accepted and the operation will complete asynchronously."
582 },
583 "default": {
584 "description": "Error response describing why the operation failed.",
585 "schema": {
586 "$ref": "./network.json#/definitions/CloudError"
587 }
588 }
589 },
590 "x-ms-long-running-operation": true,
591 "x-ms-long-running-operation-options": {
592 "final-state-via": "location"
593 }
594 }
595 },
596 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": {
597 "get": {
598 "tags": [
599 "ApplicationGateways"
600 ],
601 "operationId": "ApplicationGateways_ListAvailableServerVariables",
602 "x-ms-examples": {
603 "Get Available Server Variables": {
604 "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json"
605 }
606 },
607 "description": "Lists all available server variables.",
608 "parameters": [
609 {
610 "$ref": "./network.json#/parameters/ApiVersionParameter"
611 },
612 {
613 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
614 }
615 ],
616 "responses": {
617 "200": {
618 "description": "Success. The operation returns a list of all available server variables.",
619 "schema": {
620 "$ref": "#/definitions/ApplicationGatewayAvailableServerVariablesResult"
621 }
622 },
623 "default": {
624 "description": "Unexpected error.",
625 "schema": {
626 "$ref": "./network.json#/definitions/Error"
627 }
628 }
629 }
630 }
631 },
632 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": {
633 "get": {
634 "tags": [
635 "ApplicationGateways"
636 ],
637 "operationId": "ApplicationGateways_ListAvailableRequestHeaders",
638 "x-ms-examples": {
639 "Get Available Request Headers": {
640 "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json"
641 }
642 },
643 "description": "Lists all available request headers.",
644 "parameters": [
645 {
646 "$ref": "./network.json#/parameters/ApiVersionParameter"
647 },
648 {
649 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
650 }
651 ],
652 "responses": {
653 "200": {
654 "description": "Success. The operation returns a list of all available request headers.",
655 "schema": {
656 "$ref": "#/definitions/ApplicationGatewayAvailableRequestHeadersResult"
657 }
658 },
659 "default": {
660 "description": "Unexpected error.",
661 "schema": {
662 "$ref": "./network.json#/definitions/Error"
663 }
664 }
665 }
666 }
667 },
668 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": {
669 "get": {
670 "tags": [
671 "ApplicationGateways"
672 ],
673 "operationId": "ApplicationGateways_ListAvailableResponseHeaders",
674 "x-ms-examples": {
675 "Get Available Response Headers": {
676 "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json"
677 }
678 },
679 "description": "Lists all available response headers.",
680 "parameters": [
681 {
682 "$ref": "./network.json#/parameters/ApiVersionParameter"
683 },
684 {
685 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
686 }
687 ],
688 "responses": {
689 "200": {
690 "description": "Success. The operation returns a list of all available response headers.",
691 "schema": {
692 "$ref": "#/definitions/ApplicationGatewayAvailableResponseHeadersResult"
693 }
694 },
695 "default": {
696 "description": "Unexpected error.",
697 "schema": {
698 "$ref": "./network.json#/definitions/Error"
699 }
700 }
701 }
702 }
703 },
704 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": {
705 "get": {
706 "tags": [
707 "ApplicationGateways"
708 ],
709 "operationId": "ApplicationGateways_ListAvailableWafRuleSets",
710 "x-ms-examples": {
711 "Get Available Waf Rule Sets": {
712 "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json"
713 }
714 },
715 "description": "Lists all available web application firewall rule sets.",
716 "parameters": [
717 {
718 "$ref": "./network.json#/parameters/ApiVersionParameter"
719 },
720 {
721 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
722 }
723 ],
724 "responses": {
725 "200": {
726 "description": "Success. The operation returns a list of all available web application firewall rule sets.",
727 "schema": {
728 "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult"
729 }
730 },
731 "default": {
732 "description": "Error response describing why the operation failed.",
733 "schema": {
734 "$ref": "./network.json#/definitions/CloudError"
735 }
736 }
737 }
738 }
739 },
740 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": {
741 "get": {
742 "tags": [
743 "ApplicationGateways"
744 ],
745 "operationId": "ApplicationGateways_ListAvailableSslOptions",
746 "x-ms-examples": {
747 "Get Available Ssl Options": {
748 "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json"
749 }
750 },
751 "description": "Lists available Ssl options for configuring Ssl policy.",
752 "parameters": [
753 {
754 "$ref": "./network.json#/parameters/ApiVersionParameter"
755 },
756 {
757 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
758 }
759 ],
760 "responses": {
761 "200": {
762 "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.",
763 "schema": {
764 "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions"
765 }
766 },
767 "default": {
768 "description": "Error response describing why the operation failed.",
769 "schema": {
770 "$ref": "./network.json#/definitions/CloudError"
771 }
772 }
773 }
774 }
775 },
776 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": {
777 "get": {
778 "tags": [
779 "ApplicationGateways"
780 ],
781 "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies",
782 "x-ms-examples": {
783 "Get Available Ssl Predefined Policies": {
784 "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json"
785 }
786 },
787 "x-ms-pageable": {
788 "nextLinkName": "nextLink"
789 },
790 "description": "Lists all SSL predefined policies for configuring Ssl policy.",
791 "parameters": [
792 {
793 "$ref": "./network.json#/parameters/ApiVersionParameter"
794 },
795 {
796 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
797 }
798 ],
799 "responses": {
800 "200": {
801 "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.",
802 "schema": {
803 "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies"
804 }
805 },
806 "default": {
807 "description": "Error response describing why the operation failed.",
808 "schema": {
809 "$ref": "./network.json#/definitions/CloudError"
810 }
811 }
812 }
813 }
814 },
815 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": {
816 "get": {
817 "tags": [
818 "ApplicationGateways"
819 ],
820 "operationId": "ApplicationGateways_GetSslPredefinedPolicy",
821 "x-ms-examples": {
822 "Get Available Ssl Predefined Policy by name": {
823 "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json"
824 }
825 },
826 "description": "Gets Ssl predefined policy with the specified policy name.",
827 "parameters": [
828 {
829 "$ref": "./network.json#/parameters/ApiVersionParameter"
830 },
831 {
832 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
833 },
834 {
835 "name": "predefinedPolicyName",
836 "in": "path",
837 "required": true,
838 "type": "string",
839 "description": "Name of Ssl predefined policy."
840 }
841 ],
842 "responses": {
843 "200": {
844 "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.",
845 "schema": {
846 "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy"
847 }
848 },
849 "default": {
850 "description": "Error response describing why the operation failed.",
851 "schema": {
852 "$ref": "./network.json#/definitions/CloudError"
853 }
854 }
855 }
856 }
857 }
858 },
859 "definitions": {
860 "ApplicationGatewayOnDemandProbe": {
861 "properties": {
862 "protocol": {
863 "$ref": "#/definitions/ApplicationGatewayProtocol",
864 "description": "The protocol used for the probe."
865 },
866 "host": {
867 "type": "string",
868 "description": "Host name to send the probe to."
869 },
870 "path": {
871 "type": "string",
872 "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>."
873 },
874 "timeout": {
875 "type": "integer",
876 "format": "int32",
877 "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds."
878 },
879 "pickHostNameFromBackendHttpSettings": {
880 "type": "boolean",
881 "description": "Whether the host header should be picked from the backend http settings. Default value is false."
882 },
883 "match": {
884 "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch",
885 "description": "Criterion for classifying a healthy probe response."
886 },
887 "backendAddressPool": {
888 "$ref": "./network.json#/definitions/SubResource",
889 "description": "Reference to backend pool of application gateway to which probe request will be sent."
890 },
891 "backendHttpSettings": {
892 "$ref": "./network.json#/definitions/SubResource",
893 "description": "Reference to backend http setting of application gateway to be used for test probe."
894 }
895 },
896 "description": "Details of on demand test probe request."
897 },
898 "ApplicationGatewayBackendHealthOnDemand": {
899 "properties": {
900 "backendAddressPool": {
901 "$ref": "#/definitions/ApplicationGatewayBackendAddressPool",
902 "description": "Reference to an ApplicationGatewayBackendAddressPool resource."
903 },
904 "backendHealthHttpSettings": {
905 "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings",
906 "description": "Application gateway BackendHealthHttp settings."
907 }
908 },
909 "description": "Result of on demand test probe."
910 },
911 "ApplicationGatewayBackendHealth": {
912 "properties": {
913 "backendAddressPools": {
914 "type": "array",
915 "items": {
916 "$ref": "#/definitions/ApplicationGatewayBackendHealthPool"
917 },
918 "description": "A list of ApplicationGatewayBackendHealthPool resources."
919 }
920 },
921 "description": "Response for ApplicationGatewayBackendHealth API service call."
922 },
923 "ApplicationGatewayBackendHealthPool": {
924 "properties": {
925 "backendAddressPool": {
926 "$ref": "#/definitions/ApplicationGatewayBackendAddressPool",
927 "description": "Reference to an ApplicationGatewayBackendAddressPool resource."
928 },
929 "backendHttpSettingsCollection": {
930 "type": "array",
931 "items": {
932 "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings"
933 },
934 "description": "List of ApplicationGatewayBackendHealthHttpSettings resources."
935 }
936 },
937 "description": "Application gateway BackendHealth pool."
938 },
939 "ApplicationGatewayBackendHealthHttpSettings": {
940 "properties": {
941 "backendHttpSettings": {
942 "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings",
943 "description": "Reference to an ApplicationGatewayBackendHttpSettings resource."
944 },
945 "servers": {
946 "type": "array",
947 "items": {
948 "$ref": "#/definitions/ApplicationGatewayBackendHealthServer"
949 },
950 "description": "List of ApplicationGatewayBackendHealthServer resources."
951 }
952 },
953 "description": "Application gateway BackendHealthHttp settings."
954 },
955 "ApplicationGatewayBackendHealthServer": {
956 "properties": {
957 "address": {
958 "type": "string",
959 "description": "IP address or FQDN of backend server."
960 },
961 "ipConfiguration": {
962 "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration",
963 "description": "Reference to IP configuration of backend server."
964 },
965 "health": {
966 "type": "string",
967 "description": "Health of backend server.",
968 "enum": [
969 "Unknown",
970 "Up",
971 "Down",
972 "Partial",
973 "Draining"
974 ],
975 "x-ms-enum": {
976 "name": "ApplicationGatewayBackendHealthServerHealth",
977 "modelAsString": true
978 }
979 },
980 "healthProbeLog": {
981 "type": "string",
982 "description": "Health Probe Log."
983 }
984 },
985 "description": "Application gateway backendhealth http settings."
986 },
987 "ApplicationGatewaySku": {
988 "properties": {
989 "name": {
990 "type": "string",
991 "description": "Name of an application gateway SKU.",
992 "enum": [
993 "Standard_Small",
994 "Standard_Medium",
995 "Standard_Large",
996 "WAF_Medium",
997 "WAF_Large",
998 "Standard_v2",
999 "WAF_v2"
1000 ],
1001 "x-ms-enum": {
1002 "name": "ApplicationGatewaySkuName",
1003 "modelAsString": true
1004 }
1005 },
1006 "tier": {
1007 "type": "string",
1008 "description": "Tier of an application gateway.",
1009 "enum": [
1010 "Standard",
1011 "WAF",
1012 "Standard_v2",
1013 "WAF_v2"
1014 ],
1015 "x-ms-enum": {
1016 "name": "ApplicationGatewayTier",
1017 "modelAsString": true
1018 }
1019 },
1020 "capacity": {
1021 "type": "integer",
1022 "format": "int32",
1023 "description": "Capacity (instance count) of an application gateway."
1024 }
1025 },
1026 "description": "SKU of an application gateway."
1027 },
1028 "ApplicationGatewaySslPolicy": {
1029 "properties": {
1030 "disabledSslProtocols": {
1031 "type": "array",
1032 "description": "Ssl protocols to be disabled on application gateway.",
1033 "items": {
1034 "type": "string",
1035 "$ref": "#/definitions/ProtocolsEnum"
1036 }
1037 },
1038 "policyType": {
1039 "type": "string",
1040 "description": "Type of Ssl Policy.",
1041 "enum": [
1042 "Predefined",
1043 "Custom"
1044 ],
1045 "x-ms-enum": {
1046 "name": "ApplicationGatewaySslPolicyType",
1047 "modelAsString": true
1048 }
1049 },
1050 "policyName": {
1051 "$ref": "#/definitions/PolicyNameEnum",
1052 "description": "Name of Ssl predefined policy."
1053 },
1054 "cipherSuites": {
1055 "type": "array",
1056 "items": {
1057 "$ref": "#/definitions/CipherSuitesEnum"
1058 },
1059 "description": "Ssl cipher suites to be enabled in the specified order to application gateway."
1060 },
1061 "minProtocolVersion": {
1062 "$ref": "#/definitions/ProtocolsEnum",
1063 "description": "Minimum version of Ssl protocol to be supported on application gateway."
1064 }
1065 },
1066 "description": "Application Gateway Ssl policy."
1067 },
1068 "ApplicationGatewayIPConfigurationPropertiesFormat": {
1069 "properties": {
1070 "subnet": {
1071 "$ref": "./network.json#/definitions/SubResource",
1072 "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address."
1073 },
1074 "provisioningState": {
1075 "readOnly": true,
1076 "$ref": "./network.json#/definitions/ProvisioningState",
1077 "description": "The provisioning state of the application gateway IP configuration resource."
1078 }
1079 },
1080 "description": "Properties of IP configuration of an application gateway."
1081 },
1082 "ApplicationGatewayIPConfiguration": {
1083 "properties": {
1084 "properties": {
1085 "x-ms-client-flatten": true,
1086 "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat",
1087 "description": "Properties of the application gateway IP configuration."
1088 },
1089 "name": {
1090 "type": "string",
1091 "description": "Name of the IP configuration that is unique within an Application Gateway."
1092 },
1093 "etag": {
1094 "readOnly": true,
1095 "type": "string",
1096 "description": "A unique read-only string that changes whenever the resource is updated."
1097 },
1098 "type": {
1099 "readOnly": true,
1100 "type": "string",
1101 "description": "Type of the resource."
1102 }
1103 },
1104 "allOf": [
1105 {
1106 "$ref": "./network.json#/definitions/SubResource"
1107 }
1108 ],
1109 "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed."
1110 },
1111 "ApplicationGatewayAuthenticationCertificatePropertiesFormat": {
1112 "properties": {
1113 "data": {
1114 "type": "string",
1115 "description": "Certificate public data."
1116 },
1117 "provisioningState": {
1118 "readOnly": true,
1119 "$ref": "./network.json#/definitions/ProvisioningState",
1120 "description": "The provisioning state of the authentication certificate resource."
1121 }
1122 },
1123 "description": "Authentication certificates properties of an application gateway."
1124 },
1125 "ApplicationGatewayAuthenticationCertificate": {
1126 "properties": {
1127 "properties": {
1128 "x-ms-client-flatten": true,
1129 "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat",
1130 "description": "Properties of the application gateway authentication certificate."
1131 },
1132 "name": {
1133 "type": "string",
1134 "description": "Name of the authentication certificate that is unique within an Application Gateway."
1135 },
1136 "etag": {
1137 "readOnly": true,
1138 "type": "string",
1139 "description": "A unique read-only string that changes whenever the resource is updated."
1140 },
1141 "type": {
1142 "readOnly": true,
1143 "type": "string",
1144 "description": "Type of the resource."
1145 }
1146 },
1147 "allOf": [
1148 {
1149 "$ref": "./network.json#/definitions/SubResource"
1150 }
1151 ],
1152 "description": "Authentication certificates of an application gateway."
1153 },
1154 "ApplicationGatewayTrustedRootCertificatePropertiesFormat": {
1155 "properties": {
1156 "data": {
1157 "type": "string",
1158 "description": "Certificate public data."
1159 },
1160 "keyVaultSecretId": {
1161 "type": "string",
1162 "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault."
1163 },
1164 "provisioningState": {
1165 "readOnly": true,
1166 "$ref": "./network.json#/definitions/ProvisioningState",
1167 "description": "The provisioning state of the trusted root certificate resource."
1168 }
1169 },
1170 "description": "Trusted Root certificates properties of an application gateway."
1171 },
1172 "ApplicationGatewayTrustedRootCertificate": {
1173 "properties": {
1174 "properties": {
1175 "x-ms-client-flatten": true,
1176 "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat",
1177 "description": "Properties of the application gateway trusted root certificate."
1178 },
1179 "name": {
1180 "type": "string",
1181 "description": "Name of the trusted root certificate that is unique within an Application Gateway."
1182 },
1183 "etag": {
1184 "readOnly": true,
1185 "type": "string",
1186 "description": "A unique read-only string that changes whenever the resource is updated."
1187 },
1188 "type": {
1189 "readOnly": true,
1190 "type": "string",
1191 "description": "Type of the resource."
1192 }
1193 },
1194 "allOf": [
1195 {
1196 "$ref": "./network.json#/definitions/SubResource"
1197 }
1198 ],
1199 "description": "Trusted Root certificates of an application gateway."
1200 },
1201 "ApplicationGatewaySslCertificatePropertiesFormat": {
1202 "properties": {
1203 "data": {
1204 "type": "string",
1205 "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request."
1206 },
1207 "password": {
1208 "type": "string",
1209 "description": "Password for the pfx file specified in data. Only applicable in PUT request."
1210 },
1211 "publicCertData": {
1212 "readOnly": true,
1213 "type": "string",
1214 "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request."
1215 },
1216 "keyVaultSecretId": {
1217 "type": "string",
1218 "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault."
1219 },
1220 "provisioningState": {
1221 "readOnly": true,
1222 "$ref": "./network.json#/definitions/ProvisioningState",
1223 "description": "The provisioning state of the SSL certificate resource."
1224 }
1225 },
1226 "description": "Properties of SSL certificates of an application gateway."
1227 },
1228 "ApplicationGatewaySslCertificate": {
1229 "properties": {
1230 "properties": {
1231 "x-ms-client-flatten": true,
1232 "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat",
1233 "description": "Properties of the application gateway SSL certificate."
1234 },
1235 "name": {
1236 "type": "string",
1237 "description": "Name of the SSL certificate that is unique within an Application Gateway."
1238 },
1239 "etag": {
1240 "readOnly": true,
1241 "type": "string",
1242 "description": "A unique read-only string that changes whenever the resource is updated."
1243 },
1244 "type": {
1245 "readOnly": true,
1246 "type": "string",
1247 "description": "Type of the resource."
1248 }
1249 },
1250 "allOf": [
1251 {
1252 "$ref": "./network.json#/definitions/SubResource"
1253 }
1254 ],
1255 "description": "SSL certificates of an application gateway."
1256 },
1257 "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": {
1258 "properties": {
1259 "privateIPAddress": {
1260 "type": "string",
1261 "description": "PrivateIPAddress of the network interface IP Configuration."
1262 },
1263 "privateIPAllocationMethod": {
1264 "$ref": "./network.json#/definitions/IPAllocationMethod",
1265 "description": "The private IP address allocation method."
1266 },
1267 "subnet": {
1268 "$ref": "./network.json#/definitions/SubResource",
1269 "description": "Reference to the subnet resource."
1270 },
1271 "publicIPAddress": {
1272 "$ref": "./network.json#/definitions/SubResource",
1273 "description": "Reference to the PublicIP resource."
1274 },
1275 "provisioningState": {
1276 "readOnly": true,
1277 "$ref": "./network.json#/definitions/ProvisioningState",
1278 "description": "The provisioning state of the frontend IP configuration resource."
1279 }
1280 },
1281 "description": "Properties of Frontend IP configuration of an application gateway."
1282 },
1283 "ApplicationGatewayFrontendIPConfiguration": {
1284 "properties": {
1285 "properties": {
1286 "x-ms-client-flatten": true,
1287 "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat",
1288 "description": "Properties of the application gateway frontend IP configuration."
1289 },
1290 "name": {
1291 "type": "string",
1292 "description": "Name of the frontend IP configuration that is unique within an Application Gateway."
1293 },
1294 "etag": {
1295 "readOnly": true,
1296 "type": "string",
1297 "description": "A unique read-only string that changes whenever the resource is updated."
1298 },
1299 "type": {
1300 "readOnly": true,
1301 "type": "string",
1302 "description": "Type of the resource."
1303 }
1304 },
1305 "allOf": [
1306 {
1307 "$ref": "./network.json#/definitions/SubResource"
1308 }
1309 ],
1310 "description": "Frontend IP configuration of an application gateway."
1311 },
1312 "ApplicationGatewayFrontendPortPropertiesFormat": {
1313 "properties": {
1314 "port": {
1315 "type": "integer",
1316 "format": "int32",
1317 "description": "Frontend port."
1318 },
1319 "provisioningState": {
1320 "readOnly": true,
1321 "$ref": "./network.json#/definitions/ProvisioningState",
1322 "description": "The provisioning state of the frontend port resource."
1323 }
1324 },
1325 "description": "Properties of Frontend port of an application gateway."
1326 },
1327 "ApplicationGatewayFrontendPort": {
1328 "properties": {
1329 "properties": {
1330 "x-ms-client-flatten": true,
1331 "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat",
1332 "description": "Properties of the application gateway frontend port."
1333 },
1334 "name": {
1335 "type": "string",
1336 "description": "Name of the frontend port that is unique within an Application Gateway."
1337 },
1338 "etag": {
1339 "readOnly": true,
1340 "type": "string",
1341 "description": "A unique read-only string that changes whenever the resource is updated."
1342 },
1343 "type": {
1344 "readOnly": true,
1345 "type": "string",
1346 "description": "Type of the resource."
1347 }
1348 },
1349 "allOf": [
1350 {
1351 "$ref": "./network.json#/definitions/SubResource"
1352 }
1353 ],
1354 "description": "Frontend port of an application gateway."
1355 },
1356 "ApplicationGatewayBackendAddress": {
1357 "properties": {
1358 "fqdn": {
1359 "type": "string",
1360 "description": "Fully qualified domain name (FQDN)."
1361 },
1362 "ipAddress": {
1363 "type": "string",
1364 "description": "IP address."
1365 }
1366 },
1367 "description": "Backend address of an application gateway."
1368 },
1369 "ApplicationGatewayBackendAddressPoolPropertiesFormat": {
1370 "properties": {
1371 "backendIPConfigurations": {
1372 "readOnly": true,
1373 "type": "array",
1374 "items": {
1375 "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration"
1376 },
1377 "description": "Collection of references to IPs defined in network interfaces."
1378 },
1379 "backendAddresses": {
1380 "type": "array",
1381 "items": {
1382 "$ref": "#/definitions/ApplicationGatewayBackendAddress"
1383 },
1384 "description": "Backend addresses."
1385 },
1386 "provisioningState": {
1387 "readOnly": true,
1388 "$ref": "./network.json#/definitions/ProvisioningState",
1389 "description": "The provisioning state of the backend address pool resource."
1390 }
1391 },
1392 "description": "Properties of Backend Address Pool of an application gateway."
1393 },
1394 "ApplicationGatewayBackendAddressPool": {
1395 "properties": {
1396 "properties": {
1397 "x-ms-client-flatten": true,
1398 "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat",
1399 "description": "Properties of the application gateway backend address pool."
1400 },
1401 "name": {
1402 "type": "string",
1403 "description": "Name of the backend address pool that is unique within an Application Gateway."
1404 },
1405 "etag": {
1406 "readOnly": true,
1407 "type": "string",
1408 "description": "A unique read-only string that changes whenever the resource is updated."
1409 },
1410 "type": {
1411 "readOnly": true,
1412 "type": "string",
1413 "description": "Type of the resource."
1414 }
1415 },
1416 "allOf": [
1417 {
1418 "$ref": "./network.json#/definitions/SubResource"
1419 }
1420 ],
1421 "description": "Backend Address Pool of an application gateway."
1422 },
1423 "ApplicationGatewayBackendHttpSettingsPropertiesFormat": {
1424 "properties": {
1425 "port": {
1426 "type": "integer",
1427 "format": "int32",
1428 "description": "The destination port on the backend."
1429 },
1430 "protocol": {
1431 "$ref": "#/definitions/ApplicationGatewayProtocol",
1432 "description": "The protocol used to communicate with the backend."
1433 },
1434 "cookieBasedAffinity": {
1435 "type": "string",
1436 "description": "Cookie based affinity.",
1437 "enum": [
1438 "Enabled",
1439 "Disabled"
1440 ],
1441 "x-ms-enum": {
1442 "name": "ApplicationGatewayCookieBasedAffinity",
1443 "modelAsString": true
1444 }
1445 },
1446 "requestTimeout": {
1447 "type": "integer",
1448 "format": "int32",
1449 "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds."
1450 },
1451 "probe": {
1452 "$ref": "./network.json#/definitions/SubResource",
1453 "description": "Probe resource of an application gateway."
1454 },
1455 "authenticationCertificates": {
1456 "type": "array",
1457 "items": {
1458 "$ref": "./network.json#/definitions/SubResource"
1459 },
1460 "description": "Array of references to application gateway authentication certificates."
1461 },
1462 "trustedRootCertificates": {
1463 "type": "array",
1464 "items": {
1465 "$ref": "./network.json#/definitions/SubResource"
1466 },
1467 "description": "Array of references to application gateway trusted root certificates."
1468 },
1469 "connectionDraining": {
1470 "$ref": "#/definitions/ApplicationGatewayConnectionDraining",
1471 "description": "Connection draining of the backend http settings resource."
1472 },
1473 "hostName": {
1474 "type": "string",
1475 "description": "Host header to be sent to the backend servers."
1476 },
1477 "pickHostNameFromBackendAddress": {
1478 "type": "boolean",
1479 "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false."
1480 },
1481 "affinityCookieName": {
1482 "type": "string",
1483 "description": "Cookie name to use for the affinity cookie."
1484 },
1485 "probeEnabled": {
1486 "type": "boolean",
1487 "description": "Whether the probe is enabled. Default value is false."
1488 },
1489 "path": {
1490 "type": "string",
1491 "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null."
1492 },
1493 "provisioningState": {
1494 "readOnly": true,
1495 "$ref": "./network.json#/definitions/ProvisioningState",
1496 "description": "The provisioning state of the backend HTTP settings resource."
1497 }
1498 },
1499 "description": "Properties of Backend address pool settings of an application gateway."
1500 },
1501 "ApplicationGatewayBackendHttpSettings": {
1502 "properties": {
1503 "properties": {
1504 "x-ms-client-flatten": true,
1505 "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat",
1506 "description": "Properties of the application gateway backend HTTP settings."
1507 },
1508 "name": {
1509 "type": "string",
1510 "description": "Name of the backend http settings that is unique within an Application Gateway."
1511 },
1512 "etag": {
1513 "readOnly": true,
1514 "type": "string",
1515 "description": "A unique read-only string that changes whenever the resource is updated."
1516 },
1517 "type": {
1518 "readOnly": true,
1519 "type": "string",
1520 "description": "Type of the resource."
1521 }
1522 },
1523 "allOf": [
1524 {
1525 "$ref": "./network.json#/definitions/SubResource"
1526 }
1527 ],
1528 "description": "Backend address pool settings of an application gateway."
1529 },
1530 "ApplicationGatewayHttpListenerPropertiesFormat": {
1531 "properties": {
1532 "frontendIPConfiguration": {
1533 "$ref": "./network.json#/definitions/SubResource",
1534 "description": "Frontend IP configuration resource of an application gateway."
1535 },
1536 "frontendPort": {
1537 "$ref": "./network.json#/definitions/SubResource",
1538 "description": "Frontend port resource of an application gateway."
1539 },
1540 "protocol": {
1541 "$ref": "#/definitions/ApplicationGatewayProtocol",
1542 "description": "Protocol of the HTTP listener."
1543 },
1544 "hostName": {
1545 "type": "string",
1546 "description": "Host name of HTTP listener."
1547 },
1548 "sslCertificate": {
1549 "$ref": "./network.json#/definitions/SubResource",
1550 "description": "SSL certificate resource of an application gateway."
1551 },
1552 "requireServerNameIndication": {
1553 "type": "boolean",
1554 "description": "Applicable only if protocol is https. Enables SNI for multi-hosting."
1555 },
1556 "provisioningState": {
1557 "readOnly": true,
1558 "$ref": "./network.json#/definitions/ProvisioningState",
1559 "description": "The provisioning state of the HTTP listener resource."
1560 },
1561 "customErrorConfigurations": {
1562 "type": "array",
1563 "items": {
1564 "$ref": "#/definitions/ApplicationGatewayCustomError"
1565 },
1566 "description": "Custom error configurations of the HTTP listener."
1567 },
1568 "firewallPolicy": {
1569 "$ref": "./network.json#/definitions/SubResource",
1570 "description": "Reference to the FirewallPolicy resource."
1571 },
1572 "hostNames": {
1573 "type": "array",
1574 "items": {
1575 "type": "string"
1576 },
1577 "description": "List of Host names for HTTP Listener that allows special wildcard characters as well."
1578 }
1579 },
1580 "description": "Properties of HTTP listener of an application gateway."
1581 },
1582 "ApplicationGatewayHttpListener": {
1583 "properties": {
1584 "properties": {
1585 "x-ms-client-flatten": true,
1586 "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat",
1587 "description": "Properties of the application gateway HTTP listener."
1588 },
1589 "name": {
1590 "type": "string",
1591 "description": "Name of the HTTP listener that is unique within an Application Gateway."
1592 },
1593 "etag": {
1594 "readOnly": true,
1595 "type": "string",
1596 "description": "A unique read-only string that changes whenever the resource is updated."
1597 },
1598 "type": {
1599 "readOnly": true,
1600 "type": "string",
1601 "description": "Type of the resource."
1602 }
1603 },
1604 "allOf": [
1605 {
1606 "$ref": "./network.json#/definitions/SubResource"
1607 }
1608 ],
1609 "description": "Http listener of an application gateway."
1610 },
1611 "ApplicationGatewayPathRulePropertiesFormat": {
1612 "properties": {
1613 "paths": {
1614 "type": "array",
1615 "items": {
1616 "type": "string"
1617 },
1618 "description": "Path rules of URL path map."
1619 },
1620 "backendAddressPool": {
1621 "$ref": "./network.json#/definitions/SubResource",
1622 "description": "Backend address pool resource of URL path map path rule."
1623 },
1624 "backendHttpSettings": {
1625 "$ref": "./network.json#/definitions/SubResource",
1626 "description": "Backend http settings resource of URL path map path rule."
1627 },
1628 "redirectConfiguration": {
1629 "$ref": "./network.json#/definitions/SubResource",
1630 "description": "Redirect configuration resource of URL path map path rule."
1631 },
1632 "rewriteRuleSet": {
1633 "$ref": "./network.json#/definitions/SubResource",
1634 "description": "Rewrite rule set resource of URL path map path rule."
1635 },
1636 "provisioningState": {
1637 "readOnly": true,
1638 "$ref": "./network.json#/definitions/ProvisioningState",
1639 "description": "The provisioning state of the path rule resource."
1640 },
1641 "firewallPolicy": {
1642 "$ref": "./network.json#/definitions/SubResource",
1643 "description": "Reference to the FirewallPolicy resource."
1644 }
1645 },
1646 "description": "Properties of path rule of an application gateway."
1647 },
1648 "ApplicationGatewayPathRule": {
1649 "properties": {
1650 "properties": {
1651 "x-ms-client-flatten": true,
1652 "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat",
1653 "description": "Properties of the application gateway path rule."
1654 },
1655 "name": {
1656 "type": "string",
1657 "description": "Name of the path rule that is unique within an Application Gateway."
1658 },
1659 "etag": {
1660 "readOnly": true,
1661 "type": "string",
1662 "description": "A unique read-only string that changes whenever the resource is updated."
1663 },
1664 "type": {
1665 "readOnly": true,
1666 "type": "string",
1667 "description": "Type of the resource."
1668 }
1669 },
1670 "allOf": [
1671 {
1672 "$ref": "./network.json#/definitions/SubResource"
1673 }
1674 ],
1675 "description": "Path rule of URL path map of an application gateway."
1676 },
1677 "ApplicationGatewayProbePropertiesFormat": {
1678 "properties": {
1679 "protocol": {
1680 "$ref": "#/definitions/ApplicationGatewayProtocol",
1681 "description": "The protocol used for the probe."
1682 },
1683 "host": {
1684 "type": "string",
1685 "description": "Host name to send the probe to."
1686 },
1687 "path": {
1688 "type": "string",
1689 "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>."
1690 },
1691 "interval": {
1692 "type": "integer",
1693 "format": "int32",
1694 "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds."
1695 },
1696 "timeout": {
1697 "type": "integer",
1698 "format": "int32",
1699 "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds."
1700 },
1701 "unhealthyThreshold": {
1702 "type": "integer",
1703 "format": "int32",
1704 "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20."
1705 },
1706 "pickHostNameFromBackendHttpSettings": {
1707 "type": "boolean",
1708 "description": "Whether the host header should be picked from the backend http settings. Default value is false."
1709 },
1710 "minServers": {
1711 "type": "integer",
1712 "format": "int32",
1713 "description": "Minimum number of servers that are always marked healthy. Default value is 0."
1714 },
1715 "match": {
1716 "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch",
1717 "description": "Criterion for classifying a healthy probe response."
1718 },
1719 "provisioningState": {
1720 "readOnly": true,
1721 "$ref": "./network.json#/definitions/ProvisioningState",
1722 "description": "The provisioning state of the probe resource."
1723 },
1724 "port": {
1725 "type": "integer",
1726 "format": "int32",
1727 "description": "Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.",
1728 "minimum": 1,
1729 "maximum": 65535
1730 }
1731 },
1732 "description": "Properties of probe of an application gateway."
1733 },
1734 "ApplicationGatewayProbeHealthResponseMatch": {
1735 "properties": {
1736 "body": {
1737 "type": "string",
1738 "description": "Body that must be contained in the health response. Default value is empty."
1739 },
1740 "statusCodes": {
1741 "type": "array",
1742 "items": {
1743 "type": "string"
1744 },
1745 "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399."
1746 }
1747 },
1748 "description": "Application gateway probe health response match."
1749 },
1750 "ApplicationGatewayProbe": {
1751 "properties": {
1752 "properties": {
1753 "x-ms-client-flatten": true,
1754 "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat",
1755 "description": "Properties of the application gateway probe."
1756 },
1757 "name": {
1758 "type": "string",
1759 "description": "Name of the probe that is unique within an Application Gateway."
1760 },
1761 "etag": {
1762 "readOnly": true,
1763 "type": "string",
1764 "description": "A unique read-only string that changes whenever the resource is updated."
1765 },
1766 "type": {
1767 "readOnly": true,
1768 "type": "string",
1769 "description": "Type of the resource."
1770 }
1771 },
1772 "allOf": [
1773 {
1774 "$ref": "./network.json#/definitions/SubResource"
1775 }
1776 ],
1777 "description": "Probe of the application gateway."
1778 },
1779 "ApplicationGatewayRequestRoutingRulePropertiesFormat": {
1780 "properties": {
1781 "ruleType": {
1782 "type": "string",
1783 "description": "Rule type.",
1784 "enum": [
1785 "Basic",
1786 "PathBasedRouting"
1787 ],
1788 "x-ms-enum": {
1789 "name": "ApplicationGatewayRequestRoutingRuleType",
1790 "modelAsString": true
1791 }
1792 },
1793 "priority": {
1794 "type": "integer",
1795 "format": "int32",
1796 "minimum": 1,
1797 "exclusiveMinimum": false,
1798 "maximum": 20000,
1799 "exclusiveMaximum": false,
1800 "description": "Priority of the request routing rule."
1801 },
1802 "backendAddressPool": {
1803 "$ref": "./network.json#/definitions/SubResource",
1804 "description": "Backend address pool resource of the application gateway."
1805 },
1806 "backendHttpSettings": {
1807 "$ref": "./network.json#/definitions/SubResource",
1808 "description": "Backend http settings resource of the application gateway."
1809 },
1810 "httpListener": {
1811 "$ref": "./network.json#/definitions/SubResource",
1812 "description": "Http listener resource of the application gateway."
1813 },
1814 "urlPathMap": {
1815 "$ref": "./network.json#/definitions/SubResource",
1816 "description": "URL path map resource of the application gateway."
1817 },
1818 "rewriteRuleSet": {
1819 "$ref": "./network.json#/definitions/SubResource",
1820 "description": "Rewrite Rule Set resource in Basic rule of the application gateway."
1821 },
1822 "redirectConfiguration": {
1823 "$ref": "./network.json#/definitions/SubResource",
1824 "description": "Redirect configuration resource of the application gateway."
1825 },
1826 "provisioningState": {
1827 "readOnly": true,
1828 "$ref": "./network.json#/definitions/ProvisioningState",
1829 "description": "The provisioning state of the request routing rule resource."
1830 }
1831 },
1832 "description": "Properties of request routing rule of the application gateway."
1833 },
1834 "ApplicationGatewayRequestRoutingRule": {
1835 "properties": {
1836 "properties": {
1837 "x-ms-client-flatten": true,
1838 "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat",
1839 "description": "Properties of the application gateway request routing rule."
1840 },
1841 "name": {
1842 "type": "string",
1843 "description": "Name of the request routing rule that is unique within an Application Gateway."
1844 },
1845 "etag": {
1846 "readOnly": true,
1847 "type": "string",
1848 "description": "A unique read-only string that changes whenever the resource is updated."
1849 },
1850 "type": {
1851 "readOnly": true,
1852 "type": "string",
1853 "description": "Type of the resource."
1854 }
1855 },
1856 "allOf": [
1857 {
1858 "$ref": "./network.json#/definitions/SubResource"
1859 }
1860 ],
1861 "description": "Request routing rule of an application gateway."
1862 },
1863 "ApplicationGatewayRewriteRuleSet": {
1864 "properties": {
1865 "properties": {
1866 "x-ms-client-flatten": true,
1867 "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat",
1868 "description": "Properties of the application gateway rewrite rule set."
1869 },
1870 "name": {
1871 "type": "string",
1872 "description": "Name of the rewrite rule set that is unique within an Application Gateway."
1873 },
1874 "etag": {
1875 "readOnly": true,
1876 "type": "string",
1877 "description": "A unique read-only string that changes whenever the resource is updated."
1878 }
1879 },
1880 "allOf": [
1881 {
1882 "$ref": "./network.json#/definitions/SubResource"
1883 }
1884 ],
1885 "description": "Rewrite rule set of an application gateway."
1886 },
1887 "ApplicationGatewayRewriteRuleSetPropertiesFormat": {
1888 "properties": {
1889 "rewriteRules": {
1890 "type": "array",
1891 "items": {
1892 "$ref": "#/definitions/ApplicationGatewayRewriteRule"
1893 },
1894 "description": "Rewrite rules in the rewrite rule set."
1895 },
1896 "provisioningState": {
1897 "readOnly": true,
1898 "$ref": "./network.json#/definitions/ProvisioningState",
1899 "description": "The provisioning state of the rewrite rule set resource."
1900 }
1901 },
1902 "description": "Properties of rewrite rule set of the application gateway."
1903 },
1904 "ApplicationGatewayRewriteRule": {
1905 "properties": {
1906 "name": {
1907 "type": "string",
1908 "description": "Name of the rewrite rule that is unique within an Application Gateway."
1909 },
1910 "ruleSequence": {
1911 "type": "integer",
1912 "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet."
1913 },
1914 "conditions": {
1915 "type": "array",
1916 "items": {
1917 "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition"
1918 },
1919 "description": "Conditions based on which the action set execution will be evaluated."
1920 },
1921 "actionSet": {
1922 "type": "object",
1923 "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet",
1924 "description": "Set of actions to be done as part of the rewrite Rule."
1925 }
1926 },
1927 "description": "Rewrite rule of an application gateway."
1928 },
1929 "ApplicationGatewayRewriteRuleCondition": {
1930 "properties": {
1931 "variable": {
1932 "type": "string",
1933 "description": "The condition parameter of the RewriteRuleCondition."
1934 },
1935 "pattern": {
1936 "type": "string",
1937 "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition."
1938 },
1939 "ignoreCase": {
1940 "type": "boolean",
1941 "description": "Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison."
1942 },
1943 "negate": {
1944 "type": "boolean",
1945 "description": "Setting this value as truth will force to check the negation of the condition given by the user."
1946 }
1947 },
1948 "description": "Set of conditions in the Rewrite Rule in Application Gateway."
1949 },
1950 "ApplicationGatewayRewriteRuleActionSet": {
1951 "properties": {
1952 "requestHeaderConfigurations": {
1953 "type": "array",
1954 "items": {
1955 "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration"
1956 },
1957 "description": "Request Header Actions in the Action Set."
1958 },
1959 "responseHeaderConfigurations": {
1960 "type": "array",
1961 "items": {
1962 "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration"
1963 },
1964 "description": "Response Header Actions in the Action Set."
1965 },
1966 "urlConfiguration": {
1967 "$ref": "#/definitions/ApplicationGatewayUrlConfiguration",
1968 "description": "Url Configuration Action in the Action Set."
1969 }
1970 },
1971 "description": "Set of actions in the Rewrite Rule in Application Gateway."
1972 },
1973 "ApplicationGatewayHeaderConfiguration": {
1974 "properties": {
1975 "headerName": {
1976 "type": "string",
1977 "description": "Header name of the header configuration."
1978 },
1979 "headerValue": {
1980 "type": "string",
1981 "description": "Header value of the header configuration."
1982 }
1983 },
1984 "description": "Header configuration of the Actions set in Application Gateway."
1985 },
1986 "ApplicationGatewayUrlConfiguration": {
1987 "properties": {
1988 "modifiedPath": {
1989 "type": "string",
1990 "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null."
1991 },
1992 "modifiedQueryString": {
1993 "type": "string",
1994 "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null."
1995 },
1996 "reroute": {
1997 "type": "boolean",
1998 "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false."
1999 }
2000 },
2001 "description": "Url configuration of the Actions set in Application Gateway."
2002 },
2003 "ApplicationGatewayRedirectConfigurationPropertiesFormat": {
2004 "properties": {
2005 "redirectType": {
2006 "type": "string",
2007 "$ref": "#/definitions/RedirectTypeEnum",
2008 "description": "HTTP redirection type."
2009 },
2010 "targetListener": {
2011 "$ref": "./network.json#/definitions/SubResource",
2012 "description": "Reference to a listener to redirect the request to."
2013 },
2014 "targetUrl": {
2015 "type": "string",
2016 "description": "Url to redirect the request to."
2017 },
2018 "includePath": {
2019 "type": "boolean",
2020 "description": "Include path in the redirected url."
2021 },
2022 "includeQueryString": {
2023 "type": "boolean",
2024 "description": "Include query string in the redirected url."
2025 },
2026 "requestRoutingRules": {
2027 "type": "array",
2028 "items": {
2029 "$ref": "./network.json#/definitions/SubResource"
2030 },
2031 "description": "Request routing specifying redirect configuration."
2032 },
2033 "urlPathMaps": {
2034 "type": "array",
2035 "items": {
2036 "$ref": "./network.json#/definitions/SubResource"
2037 },
2038 "description": "Url path maps specifying default redirect configuration."
2039 },
2040 "pathRules": {
2041 "type": "array",
2042 "items": {
2043 "$ref": "./network.json#/definitions/SubResource"
2044 },
2045 "description": "Path rules specifying redirect configuration."
2046 }
2047 },
2048 "description": "Properties of redirect configuration of the application gateway."
2049 },
2050 "ApplicationGatewayRedirectConfiguration": {
2051 "properties": {
2052 "properties": {
2053 "x-ms-client-flatten": true,
2054 "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat",
2055 "description": "Properties of the application gateway redirect configuration."
2056 },
2057 "name": {
2058 "type": "string",
2059 "description": "Name of the redirect configuration that is unique within an Application Gateway."
2060 },
2061 "etag": {
2062 "readOnly": true,
2063 "type": "string",
2064 "description": "A unique read-only string that changes whenever the resource is updated."
2065 },
2066 "type": {
2067 "readOnly": true,
2068 "type": "string",
2069 "description": "Type of the resource."
2070 }
2071 },
2072 "allOf": [
2073 {
2074 "$ref": "./network.json#/definitions/SubResource"
2075 }
2076 ],
2077 "description": "Redirect configuration of an application gateway."
2078 },
2079 "ApplicationGatewayPropertiesFormat": {
2080 "properties": {
2081 "sku": {
2082 "$ref": "#/definitions/ApplicationGatewaySku",
2083 "description": "SKU of the application gateway resource."
2084 },
2085 "sslPolicy": {
2086 "$ref": "#/definitions/ApplicationGatewaySslPolicy",
2087 "description": "SSL policy of the application gateway resource."
2088 },
2089 "operationalState": {
2090 "readOnly": true,
2091 "type": "string",
2092 "description": "Operational state of the application gateway resource.",
2093 "enum": [
2094 "Stopped",
2095 "Starting",
2096 "Running",
2097 "Stopping"
2098 ],
2099 "x-ms-enum": {
2100 "name": "ApplicationGatewayOperationalState",
2101 "modelAsString": true
2102 }
2103 },
2104 "gatewayIPConfigurations": {
2105 "type": "array",
2106 "items": {
2107 "$ref": "#/definitions/ApplicationGatewayIPConfiguration"
2108 },
2109 "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2110 },
2111 "authenticationCertificates": {
2112 "type": "array",
2113 "items": {
2114 "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate"
2115 },
2116 "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2117 },
2118 "trustedRootCertificates": {
2119 "type": "array",
2120 "items": {
2121 "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate"
2122 },
2123 "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2124 },
2125 "sslCertificates": {
2126 "type": "array",
2127 "items": {
2128 "$ref": "#/definitions/ApplicationGatewaySslCertificate"
2129 },
2130 "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2131 },
2132 "frontendIPConfigurations": {
2133 "type": "array",
2134 "items": {
2135 "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration"
2136 },
2137 "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2138 },
2139 "frontendPorts": {
2140 "type": "array",
2141 "items": {
2142 "$ref": "#/definitions/ApplicationGatewayFrontendPort"
2143 },
2144 "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2145 },
2146 "probes": {
2147 "type": "array",
2148 "items": {
2149 "$ref": "#/definitions/ApplicationGatewayProbe"
2150 },
2151 "description": "Probes of the application gateway resource."
2152 },
2153 "backendAddressPools": {
2154 "type": "array",
2155 "items": {
2156 "$ref": "#/definitions/ApplicationGatewayBackendAddressPool"
2157 },
2158 "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2159 },
2160 "backendHttpSettingsCollection": {
2161 "type": "array",
2162 "items": {
2163 "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings"
2164 },
2165 "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2166 },
2167 "httpListeners": {
2168 "type": "array",
2169 "items": {
2170 "$ref": "#/definitions/ApplicationGatewayHttpListener"
2171 },
2172 "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2173 },
2174 "urlPathMaps": {
2175 "type": "array",
2176 "items": {
2177 "$ref": "#/definitions/ApplicationGatewayUrlPathMap"
2178 },
2179 "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2180 },
2181 "requestRoutingRules": {
2182 "type": "array",
2183 "items": {
2184 "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule"
2185 },
2186 "description": "Request routing rules of the application gateway resource."
2187 },
2188 "rewriteRuleSets": {
2189 "type": "array",
2190 "items": {
2191 "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet"
2192 },
2193 "description": "Rewrite rules for the application gateway resource."
2194 },
2195 "redirectConfigurations": {
2196 "type": "array",
2197 "items": {
2198 "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration"
2199 },
2200 "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)."
2201 },
2202 "webApplicationFirewallConfiguration": {
2203 "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration",
2204 "description": "Web application firewall configuration."
2205 },
2206 "firewallPolicy": {
2207 "$ref": "./network.json#/definitions/SubResource",
2208 "description": "Reference to the FirewallPolicy resource."
2209 },
2210 "enableHttp2": {
2211 "type": "boolean",
2212 "description": "Whether HTTP2 is enabled on the application gateway resource."
2213 },
2214 "enableFips": {
2215 "type": "boolean",
2216 "description": "Whether FIPS is enabled on the application gateway resource."
2217 },
2218 "autoscaleConfiguration": {
2219 "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration",
2220 "description": "Autoscale Configuration."
2221 },
2222 "resourceGuid": {
2223 "readOnly": true,
2224 "type": "string",
2225 "description": "The resource GUID property of the application gateway resource."
2226 },
2227 "provisioningState": {
2228 "readOnly": true,
2229 "$ref": "./network.json#/definitions/ProvisioningState",
2230 "description": "The provisioning state of the application gateway resource."
2231 },
2232 "customErrorConfigurations": {
2233 "type": "array",
2234 "items": {
2235 "$ref": "#/definitions/ApplicationGatewayCustomError"
2236 },
2237 "description": "Custom error configurations of the application gateway resource."
2238 },
2239 "forceFirewallPolicyAssociation": {
2240 "type": "boolean",
2241 "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config."
2242 }
2243 },
2244 "description": "Properties of the application gateway."
2245 },
2246 "ApplicationGateway": {
2247 "properties": {
2248 "properties": {
2249 "x-ms-client-flatten": true,
2250 "$ref": "#/definitions/ApplicationGatewayPropertiesFormat",
2251 "description": "Properties of the application gateway."
2252 },
2253 "etag": {
2254 "readOnly": true,
2255 "type": "string",
2256 "description": "A unique read-only string that changes whenever the resource is updated."
2257 },
2258 "zones": {
2259 "type": "array",
2260 "items": {
2261 "type": "string"
2262 },
2263 "description": "A list of availability zones denoting where the resource needs to come from."
2264 },
2265 "identity": {
2266 "$ref": "./network.json#/definitions/ManagedServiceIdentity",
2267 "description": "The identity of the application gateway, if configured."
2268 }
2269 },
2270 "allOf": [
2271 {
2272 "$ref": "./network.json#/definitions/Resource"
2273 }
2274 ],
2275 "description": "Application gateway resource."
2276 },
2277 "ApplicationGatewayListResult": {
2278 "properties": {
2279 "value": {
2280 "type": "array",
2281 "items": {
2282 "$ref": "#/definitions/ApplicationGateway"
2283 },
2284 "description": "List of an application gateways in a resource group."
2285 },
2286 "nextLink": {
2287 "type": "string",
2288 "description": "URL to get the next set of results."
2289 }
2290 },
2291 "description": "Response for ListApplicationGateways API service call."
2292 },
2293 "ApplicationGatewayUrlPathMapPropertiesFormat": {
2294 "properties": {
2295 "defaultBackendAddressPool": {
2296 "$ref": "./network.json#/definitions/SubResource",
2297 "description": "Default backend address pool resource of URL path map."
2298 },
2299 "defaultBackendHttpSettings": {
2300 "$ref": "./network.json#/definitions/SubResource",
2301 "description": "Default backend http settings resource of URL path map."
2302 },
2303 "defaultRewriteRuleSet": {
2304 "$ref": "./network.json#/definitions/SubResource",
2305 "description": "Default Rewrite rule set resource of URL path map."
2306 },
2307 "defaultRedirectConfiguration": {
2308 "$ref": "./network.json#/definitions/SubResource",
2309 "description": "Default redirect configuration resource of URL path map."
2310 },
2311 "pathRules": {
2312 "type": "array",
2313 "items": {
2314 "$ref": "#/definitions/ApplicationGatewayPathRule"
2315 },
2316 "description": "Path rule of URL path map resource."
2317 },
2318 "provisioningState": {
2319 "readOnly": true,
2320 "$ref": "./network.json#/definitions/ProvisioningState",
2321 "description": "The provisioning state of the URL path map resource."
2322 }
2323 },
2324 "description": "Properties of UrlPathMap of the application gateway."
2325 },
2326 "ApplicationGatewayUrlPathMap": {
2327 "properties": {
2328 "properties": {
2329 "x-ms-client-flatten": true,
2330 "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat",
2331 "description": "Properties of the application gateway URL path map."
2332 },
2333 "name": {
2334 "type": "string",
2335 "description": "Name of the URL path map that is unique within an Application Gateway."
2336 },
2337 "etag": {
2338 "readOnly": true,
2339 "type": "string",
2340 "description": "A unique read-only string that changes whenever the resource is updated."
2341 },
2342 "type": {
2343 "readOnly": true,
2344 "type": "string",
2345 "description": "Type of the resource."
2346 }
2347 },
2348 "allOf": [
2349 {
2350 "$ref": "./network.json#/definitions/SubResource"
2351 }
2352 ],
2353 "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting."
2354 },
2355 "ApplicationGatewayWebApplicationFirewallConfiguration": {
2356 "properties": {
2357 "enabled": {
2358 "type": "boolean",
2359 "description": "Whether the web application firewall is enabled or not."
2360 },
2361 "firewallMode": {
2362 "type": "string",
2363 "description": "Web application firewall mode.",
2364 "enum": [
2365 "Detection",
2366 "Prevention"
2367 ],
2368 "x-ms-enum": {
2369 "name": "ApplicationGatewayFirewallMode",
2370 "modelAsString": true
2371 }
2372 },
2373 "ruleSetType": {
2374 "type": "string",
2375 "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'."
2376 },
2377 "ruleSetVersion": {
2378 "type": "string",
2379 "description": "The version of the rule set type."
2380 },
2381 "disabledRuleGroups": {
2382 "type": "array",
2383 "items": {
2384 "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup"
2385 },
2386 "description": "The disabled rule groups."
2387 },
2388 "requestBodyCheck": {
2389 "type": "boolean",
2390 "description": "Whether allow WAF to check request Body."
2391 },
2392 "maxRequestBodySize": {
2393 "type": "integer",
2394 "format": "int32",
2395 "maximum": 128,
2396 "exclusiveMaximum": false,
2397 "minimum": 8,
2398 "exclusiveMinimum": false,
2399 "description": "Maximum request body size for WAF."
2400 },
2401 "maxRequestBodySizeInKb": {
2402 "type": "integer",
2403 "format": "int32",
2404 "maximum": 128,
2405 "exclusiveMaximum": false,
2406 "minimum": 8,
2407 "exclusiveMinimum": false,
2408 "description": "Maximum request body size in Kb for WAF."
2409 },
2410 "fileUploadLimitInMb": {
2411 "type": "integer",
2412 "format": "int32",
2413 "minimum": 0,
2414 "exclusiveMinimum": false,
2415 "description": "Maximum file upload size in Mb for WAF."
2416 },
2417 "exclusions": {
2418 "type": "array",
2419 "items": {
2420 "$ref": "#/definitions/ApplicationGatewayFirewallExclusion"
2421 },
2422 "description": "The exclusion list."
2423 }
2424 },
2425 "required": [
2426 "enabled",
2427 "firewallMode",
2428 "ruleSetType",
2429 "ruleSetVersion"
2430 ],
2431 "description": "Application gateway web application firewall configuration."
2432 },
2433 "ApplicationGatewayAutoscaleConfiguration": {
2434 "properties": {
2435 "minCapacity": {
2436 "type": "integer",
2437 "format": "int32",
2438 "minimum": 0,
2439 "exclusiveMinimum": false,
2440 "description": "Lower bound on number of Application Gateway capacity."
2441 },
2442 "maxCapacity": {
2443 "type": "integer",
2444 "format": "int32",
2445 "minimum": 2,
2446 "exclusiveMinimum": false,
2447 "description": "Upper bound on number of Application Gateway capacity."
2448 }
2449 },
2450 "required": [
2451 "minCapacity"
2452 ],
2453 "description": "Application Gateway autoscale configuration."
2454 },
2455 "ApplicationGatewayConnectionDraining": {
2456 "properties": {
2457 "enabled": {
2458 "type": "boolean",
2459 "description": "Whether connection draining is enabled or not."
2460 },
2461 "drainTimeoutInSec": {
2462 "type": "integer",
2463 "format": "int32",
2464 "maximum": 3600,
2465 "exclusiveMaximum": false,
2466 "minimum": 1,
2467 "exclusiveMinimum": false,
2468 "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds."
2469 }
2470 },
2471 "required": [
2472 "enabled",
2473 "drainTimeoutInSec"
2474 ],
2475 "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration."
2476 },
2477 "ApplicationGatewayFirewallDisabledRuleGroup": {
2478 "properties": {
2479 "ruleGroupName": {
2480 "type": "string",
2481 "description": "The name of the rule group that will be disabled."
2482 },
2483 "rules": {
2484 "type": "array",
2485 "items": {
2486 "type": "integer",
2487 "format": "int32",
2488 "x-nullable": false
2489 },
2490 "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled."
2491 }
2492 },
2493 "required": [
2494 "ruleGroupName"
2495 ],
2496 "description": "Allows to disable rules within a rule group or an entire rule group."
2497 },
2498 "ApplicationGatewayAvailableServerVariablesResult": {
2499 "type": "array",
2500 "items": {
2501 "type": "string"
2502 },
2503 "description": "Response for ApplicationGatewayAvailableServerVariables API service call."
2504 },
2505 "ApplicationGatewayAvailableRequestHeadersResult": {
2506 "type": "array",
2507 "items": {
2508 "type": "string"
2509 },
2510 "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call."
2511 },
2512 "ApplicationGatewayAvailableResponseHeadersResult": {
2513 "type": "array",
2514 "items": {
2515 "type": "string"
2516 },
2517 "description": "Response for ApplicationGatewayAvailableResponseHeaders API service call."
2518 },
2519 "ApplicationGatewayFirewallExclusion": {
2520 "properties": {
2521 "matchVariable": {
2522 "type": "string",
2523 "description": "The variable to be excluded."
2524 },
2525 "selectorMatchOperator": {
2526 "type": "string",
2527 "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to."
2528 },
2529 "selector": {
2530 "type": "string",
2531 "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to."
2532 }
2533 },
2534 "required": [
2535 "matchVariable",
2536 "selectorMatchOperator",
2537 "selector"
2538 ],
2539 "description": "Allow to exclude some variable satisfy the condition for the WAF check."
2540 },
2541 "ApplicationGatewayAvailableWafRuleSetsResult": {
2542 "properties": {
2543 "value": {
2544 "type": "array",
2545 "items": {
2546 "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet"
2547 },
2548 "description": "The list of application gateway rule sets."
2549 }
2550 },
2551 "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call."
2552 },
2553 "ApplicationGatewayFirewallRuleSet": {
2554 "properties": {
2555 "properties": {
2556 "x-ms-client-flatten": true,
2557 "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat",
2558 "description": "Properties of the application gateway firewall rule set."
2559 }
2560 },
2561 "allOf": [
2562 {
2563 "$ref": "./network.json#/definitions/Resource"
2564 }
2565 ],
2566 "description": "A web application firewall rule set."
2567 },
2568 "ApplicationGatewayFirewallRuleSetPropertiesFormat": {
2569 "properties": {
2570 "provisioningState": {
2571 "readOnly": true,
2572 "$ref": "./network.json#/definitions/ProvisioningState",
2573 "description": "The provisioning state of the web application firewall rule set."
2574 },
2575 "ruleSetType": {
2576 "type": "string",
2577 "description": "The type of the web application firewall rule set."
2578 },
2579 "ruleSetVersion": {
2580 "type": "string",
2581 "description": "The version of the web application firewall rule set type."
2582 },
2583 "ruleGroups": {
2584 "type": "array",
2585 "items": {
2586 "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup"
2587 },
2588 "description": "The rule groups of the web application firewall rule set."
2589 }
2590 },
2591 "required": [
2592 "ruleSetType",
2593 "ruleSetVersion",
2594 "ruleGroups"
2595 ],
2596 "description": "Properties of the web application firewall rule set."
2597 },
2598 "ApplicationGatewayFirewallRuleGroup": {
2599 "properties": {
2600 "ruleGroupName": {
2601 "type": "string",
2602 "description": "The name of the web application firewall rule group."
2603 },
2604 "description": {
2605 "type": "string",
2606 "description": "The description of the web application firewall rule group."
2607 },
2608 "rules": {
2609 "type": "array",
2610 "items": {
2611 "$ref": "#/definitions/ApplicationGatewayFirewallRule"
2612 },
2613 "description": "The rules of the web application firewall rule group."
2614 }
2615 },
2616 "required": [
2617 "ruleGroupName",
2618 "rules"
2619 ],
2620 "description": "A web application firewall rule group."
2621 },
2622 "ApplicationGatewayFirewallRule": {
2623 "properties": {
2624 "ruleId": {
2625 "type": "integer",
2626 "format": "int32",
2627 "description": "The identifier of the web application firewall rule."
2628 },
2629 "description": {
2630 "type": "string",
2631 "description": "The description of the web application firewall rule."
2632 }
2633 },
2634 "required": [
2635 "ruleId"
2636 ],
2637 "description": "A web application firewall rule."
2638 },
2639 "ApplicationGatewayAvailableSslOptions": {
2640 "properties": {
2641 "properties": {
2642 "x-ms-client-flatten": true,
2643 "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat",
2644 "description": "Properties of the application gateway available SSL options."
2645 }
2646 },
2647 "allOf": [
2648 {
2649 "$ref": "./network.json#/definitions/Resource"
2650 }
2651 ],
2652 "description": "Response for ApplicationGatewayAvailableSslOptions API service call."
2653 },
2654 "ApplicationGatewayAvailableSslOptionsPropertiesFormat": {
2655 "properties": {
2656 "predefinedPolicies": {
2657 "type": "array",
2658 "items": {
2659 "$ref": "./network.json#/definitions/SubResource"
2660 },
2661 "description": "List of available Ssl predefined policy."
2662 },
2663 "defaultPolicy": {
2664 "$ref": "#/definitions/PolicyNameEnum",
2665 "description": "Name of the Ssl predefined policy applied by default to application gateway."
2666 },
2667 "availableCipherSuites": {
2668 "type": "array",
2669 "items": {
2670 "$ref": "#/definitions/CipherSuitesEnum"
2671 },
2672 "description": "List of available Ssl cipher suites."
2673 },
2674 "availableProtocols": {
2675 "type": "array",
2676 "items": {
2677 "$ref": "#/definitions/ProtocolsEnum"
2678 },
2679 "description": "List of available Ssl protocols."
2680 }
2681 },
2682 "description": "Properties of ApplicationGatewayAvailableSslOptions."
2683 },
2684 "ApplicationGatewayAvailableSslPredefinedPolicies": {
2685 "properties": {
2686 "value": {
2687 "type": "array",
2688 "items": {
2689 "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy"
2690 },
2691 "description": "List of available Ssl predefined policy."
2692 },
2693 "nextLink": {
2694 "type": "string",
2695 "description": "URL to get the next set of results."
2696 }
2697 },
2698 "description": "Response for ApplicationGatewayAvailableSslOptions API service call."
2699 },
2700 "ApplicationGatewaySslPredefinedPolicy": {
2701 "properties": {
2702 "name": {
2703 "type": "string",
2704 "description": "Name of the Ssl predefined policy."
2705 },
2706 "properties": {
2707 "x-ms-client-flatten": true,
2708 "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat",
2709 "description": "Properties of the application gateway SSL predefined policy."
2710 }
2711 },
2712 "allOf": [
2713 {
2714 "$ref": "./network.json#/definitions/SubResource"
2715 }
2716 ],
2717 "description": "An Ssl predefined policy."
2718 },
2719 "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": {
2720 "properties": {
2721 "cipherSuites": {
2722 "type": "array",
2723 "items": {
2724 "$ref": "#/definitions/CipherSuitesEnum"
2725 },
2726 "description": "Ssl cipher suites to be enabled in the specified order for application gateway."
2727 },
2728 "minProtocolVersion": {
2729 "$ref": "#/definitions/ProtocolsEnum",
2730 "description": "Minimum version of Ssl protocol to be supported on application gateway."
2731 }
2732 },
2733 "description": "Properties of ApplicationGatewaySslPredefinedPolicy."
2734 },
2735 "ApplicationGatewayCustomError": {
2736 "properties": {
2737 "statusCode": {
2738 "type": "string",
2739 "description": "Status code of the application gateway customer error.",
2740 "enum": [
2741 "HttpStatus403",
2742 "HttpStatus502"
2743 ],
2744 "x-ms-enum": {
2745 "name": "ApplicationGatewayCustomErrorStatusCode",
2746 "modelAsString": true
2747 }
2748 },
2749 "customErrorPageUrl": {
2750 "type": "string",
2751 "description": "Error page URL of the application gateway customer error."
2752 }
2753 },
2754 "description": "Customer error of an application gateway."
2755 },
2756 "PolicyNameEnum": {
2757 "type": "string",
2758 "description": "Ssl predefined policy name enums.",
2759 "enum": [
2760 "AppGwSslPolicy20150501",
2761 "AppGwSslPolicy20170401",
2762 "AppGwSslPolicy20170401S"
2763 ],
2764 "x-ms-enum": {
2765 "name": "ApplicationGatewaySslPolicyName",
2766 "modelAsString": true
2767 }
2768 },
2769 "ProtocolsEnum": {
2770 "type": "string",
2771 "description": "Ssl protocol enums.",
2772 "enum": [
2773 "TLSv1_0",
2774 "TLSv1_1",
2775 "TLSv1_2"
2776 ],
2777 "x-ms-enum": {
2778 "name": "ApplicationGatewaySslProtocol",
2779 "modelAsString": true
2780 }
2781 },
2782 "CipherSuitesEnum": {
2783 "type": "string",
2784 "description": "Ssl cipher suites enums.",
2785 "enum": [
2786 "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
2787 "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
2788 "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
2789 "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
2790 "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384",
2791 "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256",
2792 "TLS_DHE_RSA_WITH_AES_256_CBC_SHA",
2793 "TLS_DHE_RSA_WITH_AES_128_CBC_SHA",
2794 "TLS_RSA_WITH_AES_256_GCM_SHA384",
2795 "TLS_RSA_WITH_AES_128_GCM_SHA256",
2796 "TLS_RSA_WITH_AES_256_CBC_SHA256",
2797 "TLS_RSA_WITH_AES_128_CBC_SHA256",
2798 "TLS_RSA_WITH_AES_256_CBC_SHA",
2799 "TLS_RSA_WITH_AES_128_CBC_SHA",
2800 "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
2801 "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
2802 "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384",
2803 "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
2804 "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA",
2805 "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA",
2806 "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256",
2807 "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256",
2808 "TLS_DHE_DSS_WITH_AES_256_CBC_SHA",
2809 "TLS_DHE_DSS_WITH_AES_128_CBC_SHA",
2810 "TLS_RSA_WITH_3DES_EDE_CBC_SHA",
2811 "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA",
2812 "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
2813 "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
2814 ],
2815 "x-ms-enum": {
2816 "name": "ApplicationGatewaySslCipherSuite",
2817 "modelAsString": true
2818 }
2819 },
2820 "RedirectTypeEnum": {
2821 "type": "string",
2822 "description": "Redirect type enum.",
2823 "enum": [
2824 "Permanent",
2825 "Found",
2826 "SeeOther",
2827 "Temporary"
2828 ],
2829 "x-ms-enum": {
2830 "name": "ApplicationGatewayRedirectType",
2831 "modelAsString": true
2832 }
2833 },
2834 "ApplicationGatewayProtocol": {
2835 "type": "string",
2836 "description": "Application Gateway protocol.",
2837 "enum": [
2838 "Http",
2839 "Https"
2840 ],
2841 "x-ms-enum": {
2842 "name": "ApplicationGatewayProtocol",
2843 "modelAsString": true
2844 }
2845 }
2846 }
2847}
View as plain text