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 "definitions": {
38 "ErrorDetails": {
39 "properties": {
40 "code": {
41 "type": "string",
42 "description": "Error code."
43 },
44 "target": {
45 "type": "string",
46 "description": "Error target."
47 },
48 "message": {
49 "type": "string",
50 "description": "Error message."
51 }
52 },
53 "description": "Common error details representation."
54 },
55 "Error": {
56 "properties": {
57 "code": {
58 "type": "string",
59 "description": "Error code."
60 },
61 "message": {
62 "type": "string",
63 "description": "Error message."
64 },
65 "target": {
66 "type": "string",
67 "description": "Error target."
68 },
69 "details": {
70 "type": "array",
71 "items": {
72 "$ref": "#/definitions/ErrorDetails"
73 },
74 "description": "Error details."
75 },
76 "innerError": {
77 "type": "string",
78 "description": "Inner error message."
79 }
80 },
81 "description": "Common error representation."
82 },
83 "CloudError": {
84 "x-ms-external": true,
85 "properties": {
86 "error": {
87 "$ref": "#/definitions/CloudErrorBody",
88 "description": "Cloud error body."
89 }
90 },
91 "description": "An error response from the service."
92 },
93 "CloudErrorBody": {
94 "x-ms-external": true,
95 "properties": {
96 "code": {
97 "type": "string",
98 "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
99 },
100 "message": {
101 "type": "string",
102 "description": "A message describing the error, intended to be suitable for display in a user interface."
103 },
104 "target": {
105 "type": "string",
106 "description": "The target of the particular error. For example, the name of the property in error."
107 },
108 "details": {
109 "type": "array",
110 "items": {
111 "$ref": "#/definitions/CloudErrorBody"
112 },
113 "description": "A list of additional details about the error."
114 }
115 },
116 "description": "An error response from the service."
117 },
118 "AzureAsyncOperationResult": {
119 "properties": {
120 "status": {
121 "type": "string",
122 "description": "Status of the Azure async operation.",
123 "enum": [
124 "InProgress",
125 "Succeeded",
126 "Failed"
127 ],
128 "x-ms-enum": {
129 "name": "NetworkOperationStatus",
130 "modelAsString": true
131 }
132 },
133 "error": {
134 "$ref": "#/definitions/Error",
135 "description": "Details of the error occurred during specified asynchronous operation."
136 }
137 },
138 "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure."
139 },
140 "Resource": {
141 "properties": {
142 "id": {
143 "type": "string",
144 "description": "Resource ID."
145 },
146 "name": {
147 "readOnly": true,
148 "type": "string",
149 "description": "Resource name."
150 },
151 "type": {
152 "readOnly": true,
153 "type": "string",
154 "description": "Resource type."
155 },
156 "location": {
157 "type": "string",
158 "description": "Resource location."
159 },
160 "tags": {
161 "type": "object",
162 "additionalProperties": {
163 "type": "string"
164 },
165 "description": "Resource tags."
166 }
167 },
168 "description": "Common resource representation.",
169 "x-ms-azure-resource": true
170 },
171 "SubResource": {
172 "properties": {
173 "id": {
174 "type": "string",
175 "description": "Resource ID."
176 }
177 },
178 "description": "Reference to another subresource.",
179 "x-ms-azure-resource": true
180 },
181 "TagsObject": {
182 "properties": {
183 "tags": {
184 "type": "object",
185 "additionalProperties": {
186 "type": "string"
187 },
188 "description": "Resource tags."
189 }
190 },
191 "description": "Tags object for patch operations."
192 },
193 "ManagedServiceIdentity": {
194 "properties": {
195 "principalId": {
196 "readOnly": true,
197 "type": "string",
198 "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity."
199 },
200 "tenantId": {
201 "readOnly": true,
202 "type": "string",
203 "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity."
204 },
205 "type": {
206 "type": "string",
207 "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.",
208 "enum": [
209 "SystemAssigned",
210 "UserAssigned",
211 "SystemAssigned, UserAssigned",
212 "None"
213 ],
214 "x-ms-enum": {
215 "name": "ResourceIdentityType",
216 "modelAsString": false
217 }
218 },
219 "userAssignedIdentities": {
220 "type": "object",
221 "additionalProperties": {
222 "type": "object",
223 "properties": {
224 "principalId": {
225 "readOnly": true,
226 "type": "string",
227 "description": "The principal id of user assigned identity."
228 },
229 "clientId": {
230 "readOnly": true,
231 "type": "string",
232 "description": "The client id of user assigned identity."
233 }
234 }
235 },
236 "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
237 }
238 },
239 "description": "Identity for the resource."
240 },
241 "ProvisioningState": {
242 "type": "string",
243 "readOnly": true,
244 "description": "The current provisioning state.",
245 "enum": [
246 "Succeeded",
247 "Updating",
248 "Deleting",
249 "Failed"
250 ],
251 "x-ms-enum": {
252 "name": "ProvisioningState",
253 "modelAsString": true
254 }
255 },
256 "Access": {
257 "type": "string",
258 "description": "Access to be allowed or denied.",
259 "enum": [
260 "Allow",
261 "Deny"
262 ],
263 "x-ms-enum": {
264 "name": "Access",
265 "modelAsString": true
266 }
267 },
268 "AuthenticationMethod": {
269 "type": "string",
270 "description": "VPN client authentication method.",
271 "enum": [
272 "EAPTLS",
273 "EAPMSCHAPv2"
274 ],
275 "x-ms-enum": {
276 "name": "AuthenticationMethod",
277 "modelAsString": true
278 }
279 },
280 "IPAllocationMethod": {
281 "type": "string",
282 "description": "IP address allocation method.",
283 "enum": [
284 "Static",
285 "Dynamic"
286 ],
287 "x-ms-enum": {
288 "name": "IPAllocationMethod",
289 "modelAsString": true
290 }
291 },
292 "IPVersion": {
293 "type": "string",
294 "description": "IP address version.",
295 "enum": [
296 "IPv4",
297 "IPv6"
298 ],
299 "x-ms-enum": {
300 "name": "IPVersion",
301 "modelAsString": true
302 }
303 }
304 },
305 "parameters": {
306 "SubscriptionIdParameter": {
307 "name": "subscriptionId",
308 "in": "path",
309 "required": true,
310 "type": "string",
311 "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
312 },
313 "ApiVersionParameter": {
314 "name": "api-version",
315 "in": "query",
316 "required": true,
317 "type": "string",
318 "description": "Client API version."
319 },
320 "ApiVersionVmssParameter": {
321 "name": "api-version",
322 "in": "query",
323 "required": true,
324 "type": "string",
325 "enum": [
326 "2017-03-30"
327 ],
328 "x-ms-enum": {
329 "name": "ApiVersion",
330 "modelAsString": true
331 },
332 "description": "Client API version."
333 }
334 }
335}
View as plain text