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/serviceEndpointPolicies/{serviceEndpointPolicyName}": {
38      "delete": {
39        "tags": [
40          "ServiceEndpointPolicies"
41        ],
42        "operationId": "ServiceEndpointPolicies_Delete",
43        "description": "Deletes the specified service endpoint policy.",
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": "serviceEndpointPolicyName",
54            "in": "path",
55            "required": true,
56            "type": "string",
57            "description": "The name of the service endpoint policy."
58          },
59          {
60            "$ref": "./network.json#/parameters/ApiVersionParameter"
61          },
62          {
63            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
64          }
65        ],
66        "responses": {
67          "202": {
68            "description": "Accepted and the operation will complete asynchronously."
69          },
70          "200": {
71            "description": "Delete successful."
72          },
73          "204": {
74            "description": "Request successful. Resource does not exist."
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 service endpoint policy": {
85            "$ref": "./examples/ServiceEndpointPolicyDelete.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          "ServiceEndpointPolicies"
96        ],
97        "operationId": "ServiceEndpointPolicies_Get",
98        "description": "Gets the specified service Endpoint Policies in a specified resource group.",
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": "serviceEndpointPolicyName",
109            "in": "path",
110            "required": true,
111            "type": "string",
112            "description": "The name of the service endpoint policy."
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 ServiceEndpointPolicy resource.",
131            "schema": {
132              "$ref": "#/definitions/ServiceEndpointPolicy"
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 service endPoint Policy": {
144            "$ref": "./examples/ServiceEndpointPolicyGet.json"
145          }
146        }
147      },
148      "put": {
149        "tags": [
150          "ServiceEndpointPolicies"
151        ],
152        "operationId": "ServiceEndpointPolicies_CreateOrUpdate",
153        "description": "Creates or updates a service Endpoint Policies.",
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": "serviceEndpointPolicyName",
164            "in": "path",
165            "required": true,
166            "type": "string",
167            "description": "The name of the service endpoint policy."
168          },
169          {
170            "name": "parameters",
171            "in": "body",
172            "required": true,
173            "schema": {
174              "$ref": "#/definitions/ServiceEndpointPolicy"
175            },
176            "description": "Parameters supplied to the create or update service endpoint policy 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 ServiceEndpointPolicy resource.",
188            "schema": {
189              "$ref": "#/definitions/ServiceEndpointPolicy"
190            }
191          },
192          "200": {
193            "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.",
194            "schema": {
195              "$ref": "#/definitions/ServiceEndpointPolicy"
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 service endpoint policy": {
207            "$ref": "./examples/ServiceEndpointPolicyCreate.json"
208          },
209          "Create service endpoint policy with definition": {
210            "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json"
211          }
212        },
213        "x-ms-long-running-operation": true,
214        "x-ms-long-running-operation-options": {
215          "final-state-via": "azure-async-operation"
216        }
217      },
218      "patch": {
219        "tags": [
220          "ServiceEndpointPolicies"
221        ],
222        "operationId": "ServiceEndpointPolicies_UpdateTags",
223        "description": "Updates tags of a service endpoint policy.",
224        "parameters": [
225          {
226            "name": "resourceGroupName",
227            "in": "path",
228            "required": true,
229            "type": "string",
230            "description": "The name of the resource group."
231          },
232          {
233            "name": "serviceEndpointPolicyName",
234            "in": "path",
235            "required": true,
236            "type": "string",
237            "description": "The name of the service endpoint policy."
238          },
239          {
240            "name": "parameters",
241            "in": "body",
242            "required": true,
243            "schema": {
244              "$ref": "./network.json#/definitions/TagsObject"
245            },
246            "description": "Parameters supplied to update service endpoint policy tags."
247          },
248          {
249            "$ref": "./network.json#/parameters/ApiVersionParameter"
250          },
251          {
252            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
253          }
254        ],
255        "responses": {
256          "200": {
257            "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.",
258            "schema": {
259              "$ref": "#/definitions/ServiceEndpointPolicy"
260            }
261          },
262          "default": {
263            "description": "Error response describing why the operation failed.",
264            "schema": {
265              "$ref": "./network.json#/definitions/CloudError"
266            }
267          }
268        },
269        "x-ms-examples": {
270          "Update service endpoint policy tags": {
271            "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json"
272          }
273        }
274      }
275    },
276    "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": {
277      "get": {
278        "tags": [
279          "ServiceEndpointPolicies"
280        ],
281        "operationId": "ServiceEndpointPolicies_List",
282        "description": "Gets all the service endpoint policies in a subscription.",
283        "parameters": [
284          {
285            "$ref": "./network.json#/parameters/ApiVersionParameter"
286          },
287          {
288            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
289          }
290        ],
291        "responses": {
292          "200": {
293            "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.",
294            "schema": {
295              "$ref": "#/definitions/ServiceEndpointPolicyListResult"
296            }
297          },
298          "default": {
299            "description": "Error response describing why the operation failed.",
300            "schema": {
301              "$ref": "./network.json#/definitions/CloudError"
302            }
303          }
304        },
305        "x-ms-examples": {
306          "List all service endpoint policy": {
307            "$ref": "./examples/ServiceEndpointPolicyListAll.json"
308          }
309        },
310        "x-ms-pageable": {
311          "nextLinkName": "nextLink"
312        }
313      }
314    },
315    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": {
316      "get": {
317        "tags": [
318          "ServiceEndpointPolicies"
319        ],
320        "operationId": "ServiceEndpointPolicies_ListByResourceGroup",
321        "description": "Gets all service endpoint Policies in a resource group.",
322        "parameters": [
323          {
324            "name": "resourceGroupName",
325            "in": "path",
326            "required": true,
327            "type": "string",
328            "description": "The name of the resource group."
329          },
330          {
331            "$ref": "./network.json#/parameters/ApiVersionParameter"
332          },
333          {
334            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
335          }
336        ],
337        "responses": {
338          "200": {
339            "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.",
340            "schema": {
341              "$ref": "#/definitions/ServiceEndpointPolicyListResult"
342            }
343          },
344          "default": {
345            "description": "Error response describing why the operation failed.",
346            "schema": {
347              "$ref": "./network.json#/definitions/CloudError"
348            }
349          }
350        },
351        "x-ms-examples": {
352          "List resource group service endpoint policies": {
353            "$ref": "./examples/ServiceEndpointPolicyList.json"
354          }
355        },
356        "x-ms-pageable": {
357          "nextLinkName": "nextLink"
358        }
359      }
360    },
361    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": {
362      "delete": {
363        "tags": [
364          "ServiceEndpointPolicyDefinitions"
365        ],
366        "operationId": "ServiceEndpointPolicyDefinitions_Delete",
367        "description": "Deletes the specified ServiceEndpoint policy definitions.",
368        "parameters": [
369          {
370            "name": "resourceGroupName",
371            "in": "path",
372            "required": true,
373            "type": "string",
374            "description": "The name of the resource group."
375          },
376          {
377            "name": "serviceEndpointPolicyName",
378            "in": "path",
379            "required": true,
380            "type": "string",
381            "description": "The name of the Service Endpoint Policy."
382          },
383          {
384            "name": "serviceEndpointPolicyDefinitionName",
385            "in": "path",
386            "required": true,
387            "type": "string",
388            "description": "The name of the service endpoint policy definition."
389          },
390          {
391            "$ref": "./network.json#/parameters/ApiVersionParameter"
392          },
393          {
394            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
395          }
396        ],
397        "responses": {
398          "204": {
399            "description": "Request successful. Resource does not exist."
400          },
401          "202": {
402            "description": "Accepted and the operation will complete asynchronously."
403          },
404          "200": {
405            "description": "Delete successful."
406          },
407          "default": {
408            "description": "Error response describing why the operation failed.",
409            "schema": {
410              "$ref": "./network.json#/definitions/CloudError"
411            }
412          }
413        },
414        "x-ms-examples": {
415          "Delete service endpoint policy definitions from service endpoint policy": {
416            "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json"
417          }
418        },
419        "x-ms-long-running-operation": true,
420        "x-ms-long-running-operation-options": {
421          "final-state-via": "location"
422        }
423      },
424      "get": {
425        "tags": [
426          "serviceEndpointPolicyDefinitions"
427        ],
428        "operationId": "ServiceEndpointPolicyDefinitions_Get",
429        "description": "Get the specified service endpoint policy definitions from service endpoint policy.",
430        "parameters": [
431          {
432            "name": "resourceGroupName",
433            "in": "path",
434            "required": true,
435            "type": "string",
436            "description": "The name of the resource group."
437          },
438          {
439            "name": "serviceEndpointPolicyName",
440            "in": "path",
441            "required": true,
442            "type": "string",
443            "description": "The name of the service endpoint policy name."
444          },
445          {
446            "name": "serviceEndpointPolicyDefinitionName",
447            "in": "path",
448            "required": true,
449            "type": "string",
450            "description": "The name of the service endpoint policy definition name."
451          },
452          {
453            "$ref": "./network.json#/parameters/ApiVersionParameter"
454          },
455          {
456            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
457          }
458        ],
459        "responses": {
460          "200": {
461            "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.",
462            "schema": {
463              "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
464            }
465          },
466          "default": {
467            "description": "Error response describing why the operation failed.",
468            "schema": {
469              "$ref": "./network.json#/definitions/CloudError"
470            }
471          }
472        },
473        "x-ms-examples": {
474          "Get service endpoint definition in service endpoint policy": {
475            "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json"
476          }
477        }
478      },
479      "put": {
480        "tags": [
481          "serviceEndpointPolicyDefinitions"
482        ],
483        "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate",
484        "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.",
485        "parameters": [
486          {
487            "name": "resourceGroupName",
488            "in": "path",
489            "required": true,
490            "type": "string",
491            "description": "The name of the resource group."
492          },
493          {
494            "name": "serviceEndpointPolicyName",
495            "in": "path",
496            "required": true,
497            "type": "string",
498            "description": "The name of the service endpoint policy."
499          },
500          {
501            "name": "serviceEndpointPolicyDefinitionName",
502            "in": "path",
503            "required": true,
504            "type": "string",
505            "description": "The name of the service endpoint policy definition name."
506          },
507          {
508            "name": "ServiceEndpointPolicyDefinitions",
509            "in": "body",
510            "required": true,
511            "schema": {
512              "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
513            },
514            "description": "Parameters supplied to the create or update service endpoint policy operation."
515          },
516          {
517            "$ref": "./network.json#/parameters/ApiVersionParameter"
518          },
519          {
520            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
521          }
522        ],
523        "responses": {
524          "200": {
525            "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.",
526            "schema": {
527              "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
528            }
529          },
530          "201": {
531            "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.",
532            "schema": {
533              "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
534            }
535          },
536          "default": {
537            "description": "Error response describing why the operation failed.",
538            "schema": {
539              "$ref": "./network.json#/definitions/CloudError"
540            }
541          }
542        },
543        "x-ms-examples": {
544          "Create service endpoint policy definition": {
545            "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json"
546          }
547        },
548        "x-ms-long-running-operation": true,
549        "x-ms-long-running-operation-options": {
550          "final-state-via": "azure-async-operation"
551        }
552      }
553    },
554    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": {
555      "get": {
556        "tags": [
557          "ServiceEndpointPolicyDefinitions"
558        ],
559        "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup",
560        "description": "Gets all service endpoint policy definitions in a service end point policy.",
561        "parameters": [
562          {
563            "name": "resourceGroupName",
564            "in": "path",
565            "required": true,
566            "type": "string",
567            "description": "The name of the resource group."
568          },
569          {
570            "name": "serviceEndpointPolicyName",
571            "in": "path",
572            "required": true,
573            "type": "string",
574            "description": "The name of the service endpoint policy name."
575          },
576          {
577            "$ref": "./network.json#/parameters/ApiVersionParameter"
578          },
579          {
580            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
581          }
582        ],
583        "responses": {
584          "200": {
585            "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.",
586            "schema": {
587              "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult"
588            }
589          },
590          "default": {
591            "description": "Error response describing why the operation failed.",
592            "schema": {
593              "$ref": "./network.json#/definitions/CloudError"
594            }
595          }
596        },
597        "x-ms-examples": {
598          "List service endpoint definitions in service end point policy": {
599            "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json"
600          }
601        },
602        "x-ms-pageable": {
603          "nextLinkName": "nextLink"
604        }
605      }
606    }
607  },
608  "definitions": {
609    "ServiceEndpointPolicyDefinitionPropertiesFormat": {
610      "properties": {
611        "description": {
612          "type": "string",
613          "description": "A description for this rule. Restricted to 140 chars."
614        },
615        "service": {
616          "type": "string",
617          "description": "Service endpoint name."
618        },
619        "serviceResources": {
620          "type": "array",
621          "items": {
622            "type": "string"
623          },
624          "description": "A list of service resources."
625        },
626        "provisioningState": {
627          "readOnly": true,
628          "$ref": "./network.json#/definitions/ProvisioningState",
629          "description": "The provisioning state of the service endpoint policy definition resource."
630        }
631      },
632      "description": "Service Endpoint policy definition resource."
633    },
634    "ServiceEndpointPolicyDefinition": {
635      "properties": {
636        "properties": {
637          "x-ms-client-flatten": true,
638          "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat",
639          "description": "Properties of the service endpoint policy definition."
640        },
641        "name": {
642          "type": "string",
643          "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
644        },
645        "etag": {
646          "readOnly": true,
647          "type": "string",
648          "description": "A unique read-only string that changes whenever the resource is updated."
649        }
650      },
651      "allOf": [
652        {
653          "$ref": "./network.json#/definitions/SubResource"
654        }
655      ],
656      "description": "Service Endpoint policy definitions."
657    },
658    "ServiceEndpointPolicyDefinitionListResult": {
659      "properties": {
660        "value": {
661          "type": "array",
662          "items": {
663            "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
664          },
665          "description": "The service endpoint policy definition in a service endpoint policy."
666        },
667        "nextLink": {
668          "type": "string",
669          "description": "The URL to get the next set of results."
670        }
671      },
672      "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy."
673    },
674    "ServiceEndpointPolicyPropertiesFormat": {
675      "properties": {
676        "serviceEndpointPolicyDefinitions": {
677          "type": "array",
678          "items": {
679            "$ref": "#/definitions/ServiceEndpointPolicyDefinition"
680          },
681          "description": "A collection of service endpoint policy definitions of the service endpoint policy."
682        },
683        "subnets": {
684          "readOnly": true,
685          "type": "array",
686          "items": {
687            "$ref": "./virtualNetwork.json#/definitions/Subnet"
688          },
689          "description": "A collection of references to subnets."
690        },
691        "resourceGuid": {
692          "type": "string",
693          "readOnly": true,
694          "description": "The resource GUID property of the service endpoint policy resource."
695        },
696        "provisioningState": {
697          "readOnly": true,
698          "$ref": "./network.json#/definitions/ProvisioningState",
699          "description": "The provisioning state of the service endpoint policy resource."
700        }
701      },
702      "description": "Service Endpoint Policy resource."
703    },
704    "ServiceEndpointPolicy": {
705      "properties": {
706        "properties": {
707          "x-ms-client-flatten": true,
708          "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat",
709          "description": "Properties of the service end point policy."
710        },
711        "etag": {
712          "readOnly": true,
713          "type": "string",
714          "description": "A unique read-only string that changes whenever the resource is updated."
715        }
716      },
717      "allOf": [
718        {
719          "$ref": "./network.json#/definitions/Resource"
720        }
721      ],
722      "description": "Service End point policy resource."
723    },
724    "ServiceEndpointPolicyListResult": {
725      "properties": {
726        "value": {
727          "type": "array",
728          "items": {
729            "$ref": "#/definitions/ServiceEndpointPolicy"
730          },
731          "description": "A list of ServiceEndpointPolicy resources."
732        },
733        "nextLink": {
734          "readOnly": true,
735          "type": "string",
736          "description": "The URL to get the next set of results."
737        }
738      },
739      "description": "Response for ListServiceEndpointPolicies API service call."
740    }
741  }
742}
743