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/publicIPAddresses/{publicIpAddressName}": {
38 "delete": {
39 "tags": [
40 "PublicIPAddresses"
41 ],
42 "operationId": "PublicIPAddresses_Delete",
43 "description": "Deletes the specified public IP address.",
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": "publicIpAddressName",
54 "in": "path",
55 "required": true,
56 "type": "string",
57 "description": "The name of the subnet."
58 },
59 {
60 "$ref": "./network.json#/parameters/ApiVersionParameter"
61 },
62 {
63 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
64 }
65 ],
66 "responses": {
67 "204": {
68 "description": "Request successful. Resource does not exist."
69 },
70 "202": {
71 "description": "Accepted and the operation will complete asynchronously."
72 },
73 "200": {
74 "description": "Delete successful."
75 },
76 "default": {
77 "description": "Error response describing why the operation failed.",
78 "schema": {
79 "$ref": "./network.json#/definitions/CloudError"
80 }
81 }
82 },
83 "x-ms-examples": {
84 "Delete public IP address": {
85 "$ref": "./examples/PublicIpAddressDelete.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 "PublicIPAddresses"
96 ],
97 "operationId": "PublicIPAddresses_Get",
98 "description": "Gets the specified public IP address 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": "publicIpAddressName",
109 "in": "path",
110 "required": true,
111 "type": "string",
112 "description": "The name of the subnet."
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 PublicIPAddress resource.",
131 "schema": {
132 "$ref": "#/definitions/PublicIPAddress"
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 public IP address": {
144 "$ref": "./examples/PublicIpAddressGet.json"
145 }
146 }
147 },
148 "put": {
149 "tags": [
150 "PublicIPAddresses"
151 ],
152 "operationId": "PublicIPAddresses_CreateOrUpdate",
153 "description": "Creates or updates a static or dynamic public IP address.",
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": "publicIpAddressName",
164 "in": "path",
165 "required": true,
166 "type": "string",
167 "description": "The name of the public IP address."
168 },
169 {
170 "name": "parameters",
171 "in": "body",
172 "required": true,
173 "schema": {
174 "$ref": "#/definitions/PublicIPAddress"
175 },
176 "description": "Parameters supplied to the create or update public IP address 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 PublicIPAddress resource.",
188 "schema": {
189 "$ref": "#/definitions/PublicIPAddress"
190 }
191 },
192 "200": {
193 "description": "Update successful. The operation returns the resulting PublicIPAddress resource.",
194 "schema": {
195 "$ref": "#/definitions/PublicIPAddress"
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 public IP address defaults": {
207 "$ref": "./examples/PublicIpAddressCreateDefaults.json"
208 },
209 "Create public IP address allocation method": {
210 "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json"
211 },
212 "Create public IP address DNS": {
213 "$ref": "./examples/PublicIpAddressCreateDns.json"
214 }
215 },
216 "x-ms-long-running-operation": true,
217 "x-ms-long-running-operation-options": {
218 "final-state-via": "azure-async-operation"
219 }
220 },
221 "patch": {
222 "tags": [
223 "PublicIPAddresses"
224 ],
225 "operationId": "PublicIPAddresses_UpdateTags",
226 "description": "Updates public IP address tags.",
227 "parameters": [
228 {
229 "name": "resourceGroupName",
230 "in": "path",
231 "required": true,
232 "type": "string",
233 "description": "The name of the resource group."
234 },
235 {
236 "name": "publicIpAddressName",
237 "in": "path",
238 "required": true,
239 "type": "string",
240 "description": "The name of the public IP address."
241 },
242 {
243 "name": "parameters",
244 "in": "body",
245 "required": true,
246 "schema": {
247 "$ref": "./network.json#/definitions/TagsObject"
248 },
249 "description": "Parameters supplied to update public IP address tags."
250 },
251 {
252 "$ref": "./network.json#/parameters/ApiVersionParameter"
253 },
254 {
255 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
256 }
257 ],
258 "responses": {
259 "200": {
260 "description": "Update successful. The operation returns the resulting PublicIPAddress resource.",
261 "schema": {
262 "$ref": "#/definitions/PublicIPAddress"
263 }
264 },
265 "default": {
266 "description": "Error response describing why the operation failed.",
267 "schema": {
268 "$ref": "./network.json#/definitions/CloudError"
269 }
270 }
271 },
272 "x-ms-examples": {
273 "Update public IP address tags": {
274 "$ref": "./examples/PublicIpAddressUpdateTags.json"
275 }
276 }
277 }
278 },
279 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": {
280 "get": {
281 "tags": [
282 "PublicIPAddresses"
283 ],
284 "operationId": "PublicIPAddresses_ListAll",
285 "description": "Gets all the public IP addresses in a subscription.",
286 "parameters": [
287 {
288 "$ref": "./network.json#/parameters/ApiVersionParameter"
289 },
290 {
291 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
292 }
293 ],
294 "responses": {
295 "200": {
296 "description": "Request successful. The operation returns a list of PublicIPAddress resources.",
297 "schema": {
298 "$ref": "#/definitions/PublicIPAddressListResult"
299 }
300 },
301 "default": {
302 "description": "Error response describing why the operation failed.",
303 "schema": {
304 "$ref": "./network.json#/definitions/CloudError"
305 }
306 }
307 },
308 "x-ms-examples": {
309 "List all public IP addresses": {
310 "$ref": "./examples/PublicIpAddressListAll.json"
311 }
312 },
313 "x-ms-pageable": {
314 "nextLinkName": "nextLink"
315 }
316 }
317 },
318 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": {
319 "get": {
320 "tags": [
321 "PublicIPAddresses"
322 ],
323 "operationId": "PublicIPAddresses_List",
324 "description": "Gets all public IP addresses in a resource group.",
325 "parameters": [
326 {
327 "name": "resourceGroupName",
328 "in": "path",
329 "required": true,
330 "type": "string",
331 "description": "The name of the resource group."
332 },
333 {
334 "$ref": "./network.json#/parameters/ApiVersionParameter"
335 },
336 {
337 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
338 }
339 ],
340 "responses": {
341 "200": {
342 "description": "Request successful. The operation returns a list of PublicIPAddress resources.",
343 "schema": {
344 "$ref": "#/definitions/PublicIPAddressListResult"
345 }
346 },
347 "default": {
348 "description": "Error response describing why the operation failed.",
349 "schema": {
350 "$ref": "./network.json#/definitions/CloudError"
351 }
352 }
353 },
354 "x-ms-examples": {
355 "List resource group public IP addresses": {
356 "$ref": "./examples/PublicIpAddressList.json"
357 }
358 },
359 "x-ms-pageable": {
360 "nextLinkName": "nextLink"
361 }
362 }
363 }
364 },
365 "definitions": {
366 "PublicIPAddressSku": {
367 "properties": {
368 "name": {
369 "type": "string",
370 "description": "Name of a public IP address SKU.",
371 "enum": [
372 "Basic",
373 "Standard"
374 ],
375 "x-ms-enum": {
376 "name": "PublicIPAddressSkuName",
377 "modelAsString": true
378 }
379 }
380 },
381 "description": "SKU of a public IP address."
382 },
383 "PublicIPAddressPropertiesFormat": {
384 "properties": {
385 "publicIPAllocationMethod": {
386 "$ref": "./network.json#/definitions/IPAllocationMethod",
387 "description": "The public IP address allocation method."
388 },
389 "publicIPAddressVersion": {
390 "$ref": "./network.json#/definitions/IPVersion",
391 "description": "The public IP address version."
392 },
393 "ipConfiguration": {
394 "readOnly": true,
395 "$ref": "./networkInterface.json#/definitions/IPConfiguration",
396 "description": "The IP configuration associated with the public IP address."
397 },
398 "dnsSettings": {
399 "$ref": "#/definitions/PublicIPAddressDnsSettings",
400 "description": "The FQDN of the DNS record associated with the public IP address."
401 },
402 "ddosSettings": {
403 "$ref": "#/definitions/DdosSettings",
404 "description": "The DDoS protection custom policy associated with the public IP address."
405 },
406 "ipTags": {
407 "type": "array",
408 "items": {
409 "$ref": "#/definitions/IpTag"
410 },
411 "description": "The list of tags associated with the public IP address."
412 },
413 "ipAddress": {
414 "type": "string",
415 "description": "The IP address associated with the public IP address resource."
416 },
417 "publicIPPrefix": {
418 "$ref": "./network.json#/definitions/SubResource",
419 "description": "The Public IP Prefix this Public IP Address should be allocated from."
420 },
421 "idleTimeoutInMinutes": {
422 "type": "integer",
423 "format": "int32",
424 "description": "The idle timeout of the public IP address."
425 },
426 "resourceGuid": {
427 "readOnly": true,
428 "type": "string",
429 "description": "The resource GUID property of the public IP address resource."
430 },
431 "provisioningState": {
432 "readOnly": true,
433 "$ref": "./network.json#/definitions/ProvisioningState",
434 "description": "The provisioning state of the public IP address resource."
435 }
436 },
437 "description": "Public IP address properties."
438 },
439 "PublicIPAddress": {
440 "properties": {
441 "sku": {
442 "$ref": "#/definitions/PublicIPAddressSku",
443 "description": "The public IP address SKU."
444 },
445 "properties": {
446 "x-ms-client-flatten": true,
447 "$ref": "#/definitions/PublicIPAddressPropertiesFormat",
448 "description": "Public IP address properties."
449 },
450 "etag": {
451 "readOnly": true,
452 "type": "string",
453 "description": "A unique read-only string that changes whenever the resource is updated."
454 },
455 "zones": {
456 "type": "array",
457 "items": {
458 "type": "string"
459 },
460 "description": "A list of availability zones denoting the IP allocated for the resource needs to come from."
461 }
462 },
463 "allOf": [
464 {
465 "$ref": "./network.json#/definitions/Resource"
466 }
467 ],
468 "description": "Public IP address resource."
469 },
470 "PublicIPAddressListResult": {
471 "properties": {
472 "value": {
473 "type": "array",
474 "items": {
475 "$ref": "#/definitions/PublicIPAddress"
476 },
477 "description": "A list of public IP addresses that exists in a resource group."
478 },
479 "nextLink": {
480 "type": "string",
481 "description": "The URL to get the next set of results."
482 }
483 },
484 "description": "Response for ListPublicIpAddresses API service call."
485 },
486 "PublicIPAddressDnsSettings": {
487 "properties": {
488 "domainNameLabel": {
489 "type": "string",
490 "description": "The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system."
491 },
492 "fqdn": {
493 "type": "string",
494 "description": "The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone."
495 },
496 "reverseFqdn": {
497 "type": "string",
498 "description": "The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN."
499 }
500 },
501 "description": "Contains FQDN of the DNS record associated with the public IP address."
502 },
503 "DdosSettings": {
504 "properties": {
505 "ddosCustomPolicy": {
506 "readOnly": false,
507 "$ref": "./network.json#/definitions/SubResource",
508 "description": "The DDoS custom policy associated with the public IP."
509 },
510 "protectionCoverage": {
511 "readOnly": false,
512 "type": "string",
513 "enum": [
514 "Basic",
515 "Standard"
516 ],
517 "x-ms-enum": {
518 "name": "DdosSettingsProtectionCoverage",
519 "modelAsString": true
520 },
521 "description": "The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized."
522 },
523 "protectedIP": {
524 "readOnly": false,
525 "type": "boolean",
526 "description": "Enables DDoS protection on the public IP."
527 }
528 },
529 "description": "Contains the DDoS protection settings of the public IP."
530 },
531 "IpTag": {
532 "properties": {
533 "ipTagType": {
534 "type": "string",
535 "description": "The IP tag type. Example: FirstPartyUsage."
536 },
537 "tag": {
538 "type": "string",
539 "description": "The value of the IP tag associated with the public IP. Example: SQL."
540 }
541 },
542 "description": "Contains the IpTag associated with the object."
543 }
544 }
545}
View as plain text