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/privateEndpoints/{privateEndpointName}": {
38 "delete": {
39 "tags": [
40 "PrivateEndpoints"
41 ],
42 "operationId": "PrivateEndpoints_Delete",
43 "description": "Deletes the specified private endpoint.",
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": "privateEndpointName",
54 "in": "path",
55 "required": true,
56 "type": "string",
57 "description": "The name of the private endpoint."
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 "204": {
71 "description": "Delete successful."
72 },
73 "200": {
74 "description": "Delete successful."
75 },
76 "default": {
77 "description": "Error.",
78 "schema": {
79 "$ref": "./network.json#/definitions/Error"
80 }
81 }
82 },
83 "x-ms-long-running-operation": true,
84 "x-ms-long-running-operation-options": {
85 "final-state-via": "location"
86 },
87 "x-ms-examples": {
88 "Delete private endpoint": {
89 "$ref": "./examples/PrivateEndpointDelete.json"
90 }
91 }
92 },
93 "get": {
94 "tags": [
95 "PrivateEndpoints"
96 ],
97 "operationId": "PrivateEndpoints_Get",
98 "description": "Gets the specified private endpoint by 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": "privateEndpointName",
109 "in": "path",
110 "required": true,
111 "type": "string",
112 "description": "The name of the private endpoint."
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 private endpoint resource.",
131 "schema": {
132 "$ref": "#/definitions/PrivateEndpoint"
133 }
134 },
135 "default": {
136 "description": "Error.",
137 "schema": {
138 "$ref": "./network.json#/definitions/Error"
139 }
140 }
141 },
142 "x-ms-examples": {
143 "Get private endpoint": {
144 "$ref": "./examples/PrivateEndpointGet.json"
145 },
146 "Get private endpoint with manual approval connection": {
147 "$ref": "./examples/PrivateEndpointGetForManualApproval.json"
148 }
149 }
150 },
151 "put": {
152 "tags": [
153 "PrivateEndpoints"
154 ],
155 "operationId": "PrivateEndpoints_CreateOrUpdate",
156 "description": "Creates or updates an private endpoint in the specified resource group.",
157 "parameters": [
158 {
159 "name": "resourceGroupName",
160 "in": "path",
161 "required": true,
162 "type": "string",
163 "description": "The name of the resource group."
164 },
165 {
166 "name": "privateEndpointName",
167 "in": "path",
168 "required": true,
169 "type": "string",
170 "description": "The name of the private endpoint."
171 },
172 {
173 "name": "parameters",
174 "in": "body",
175 "required": true,
176 "schema": {
177 "$ref": "#/definitions/PrivateEndpoint"
178 },
179 "description": "Parameters supplied to the create or update private endpoint operation."
180 },
181 {
182 "$ref": "./network.json#/parameters/ApiVersionParameter"
183 },
184 {
185 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
186 }
187 ],
188 "responses": {
189 "200": {
190 "description": "Update successful. The operation returns the resulting private endpoint resource.",
191 "schema": {
192 "$ref": "#/definitions/PrivateEndpoint"
193 }
194 },
195 "201": {
196 "description": "Create successful. The operation returns the resulting private endpoint resource.",
197 "schema": {
198 "$ref": "#/definitions/PrivateEndpoint"
199 }
200 },
201 "default": {
202 "description": "Error.",
203 "schema": {
204 "$ref": "./network.json#/definitions/Error"
205 }
206 }
207 },
208 "x-ms-long-running-operation": true,
209 "x-ms-long-running-operation-options": {
210 "final-state-via": "azure-async-operation"
211 },
212 "x-ms-examples": {
213 "Create private endpoint": {
214 "$ref": "./examples/PrivateEndpointCreate.json"
215 },
216 "Create private endpoint with manual approval connection": {
217 "$ref": "./examples/PrivateEndpointCreateForManualApproval.json"
218 }
219 }
220 }
221 },
222 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints": {
223 "get": {
224 "tags": [
225 "PrivateEndpoints"
226 ],
227 "operationId": "PrivateEndpoints_List",
228 "description": "Gets all private endpoints in a resource group.",
229 "parameters": [
230 {
231 "name": "resourceGroupName",
232 "in": "path",
233 "required": true,
234 "type": "string",
235 "description": "The name of the resource group."
236 },
237 {
238 "$ref": "./network.json#/parameters/ApiVersionParameter"
239 },
240 {
241 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
242 }
243 ],
244 "responses": {
245 "200": {
246 "description": "Request successful. The operation returns a list of private endpoint resources.",
247 "schema": {
248 "$ref": "#/definitions/PrivateEndpointListResult"
249 }
250 },
251 "default": {
252 "description": "Error.",
253 "schema": {
254 "$ref": "./network.json#/definitions/Error"
255 }
256 }
257 },
258 "x-ms-examples": {
259 "List private endpoints in resource group": {
260 "$ref": "./examples/PrivateEndpointList.json"
261 }
262 },
263 "x-ms-pageable": {
264 "nextLinkName": "nextLink"
265 }
266 }
267 },
268 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints": {
269 "get": {
270 "tags": [
271 "PrivateEndpoints"
272 ],
273 "operationId": "PrivateEndpoints_ListBySubscription",
274 "description": "Gets all private endpoints in a subscription.",
275 "parameters": [
276 {
277 "$ref": "./network.json#/parameters/ApiVersionParameter"
278 },
279 {
280 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
281 }
282 ],
283 "responses": {
284 "200": {
285 "description": "Request successful. The operation returns a list of private endpoint resources.",
286 "schema": {
287 "$ref": "#/definitions/PrivateEndpointListResult"
288 }
289 },
290 "default": {
291 "description": "Error.",
292 "schema": {
293 "$ref": "./network.json#/definitions/Error"
294 }
295 }
296 },
297 "x-ms-examples": {
298 "List all private endpoints": {
299 "$ref": "./examples/PrivateEndpointListAll.json"
300 }
301 },
302 "x-ms-pageable": {
303 "nextLinkName": "nextLink"
304 }
305 }
306 },
307 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": {
308 "get": {
309 "operationId": "AvailablePrivateEndpointTypes_List",
310 "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.",
311 "parameters": [
312 {
313 "name": "location",
314 "in": "path",
315 "required": true,
316 "type": "string",
317 "description": "The location of the domain name."
318 },
319 {
320 "$ref": "./network.json#/parameters/ApiVersionParameter"
321 },
322 {
323 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
324 }
325 ],
326 "responses": {
327 "200": {
328 "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.",
329 "schema": {
330 "$ref": "#/definitions/AvailablePrivateEndpointTypesResult"
331 }
332 },
333 "default": {
334 "description": "Error response describing why the operation failed.",
335 "schema": {
336 "$ref": "./network.json#/definitions/CloudError"
337 }
338 }
339 },
340 "x-ms-examples": {
341 "Get available PrivateEndpoint types": {
342 "$ref": "./examples/AvailablePrivateEndpointTypesGet.json"
343 }
344 },
345 "x-ms-pageable": {
346 "nextLinkName": "nextLink"
347 }
348 }
349 },
350 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": {
351 "get": {
352 "operationId": "AvailablePrivateEndpointTypes_ListByResourceGroup",
353 "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.",
354 "parameters": [
355 {
356 "name": "location",
357 "in": "path",
358 "required": true,
359 "type": "string",
360 "description": "The location of the domain name."
361 },
362 {
363 "name": "resourceGroupName",
364 "in": "path",
365 "required": true,
366 "type": "string",
367 "description": "The name of the resource group."
368 },
369 {
370 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
371 },
372 {
373 "$ref": "./network.json#/parameters/ApiVersionParameter"
374 }
375 ],
376 "responses": {
377 "200": {
378 "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.",
379 "schema": {
380 "$ref": "#/definitions/AvailablePrivateEndpointTypesResult"
381 }
382 },
383 "default": {
384 "description": "Error response describing why the operation failed.",
385 "schema": {
386 "$ref": "./network.json#/definitions/CloudError"
387 }
388 }
389 },
390 "x-ms-examples": {
391 "Get available PrivateEndpoint types in the resource group": {
392 "$ref": "./examples/AvailablePrivateEndpointTypesResourceGroupGet.json"
393 }
394 },
395 "x-ms-pageable": {
396 "nextLinkName": "nextLink"
397 }
398 }
399 },
400 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}": {
401 "delete": {
402 "tags": [
403 "PrivateDnsZoneGroups"
404 ],
405 "operationId": "PrivateDnsZoneGroups_Delete",
406 "description": "Deletes the specified private dns zone group.",
407 "parameters": [
408 {
409 "name": "resourceGroupName",
410 "in": "path",
411 "required": true,
412 "type": "string",
413 "description": "The name of the resource group."
414 },
415 {
416 "name": "privateEndpointName",
417 "in": "path",
418 "required": true,
419 "type": "string",
420 "description": "The name of the private endpoint."
421 },
422 {
423 "name": "privateDnsZoneGroupName",
424 "in": "path",
425 "required": true,
426 "type": "string",
427 "description": "The name of the private dns zone group."
428 },
429 {
430 "$ref": "./network.json#/parameters/ApiVersionParameter"
431 },
432 {
433 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
434 }
435 ],
436 "responses": {
437 "202": {
438 "description": "Accepted and the operation will complete asynchronously."
439 },
440 "204": {
441 "description": "Request successful. Resource does not exist."
442 },
443 "200": {
444 "description": "Delete successful."
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 "x-ms-examples": {
458 "Delete private dns zone group": {
459 "$ref": "./examples/PrivateEndpointDnsZoneGroupDelete.json"
460 }
461 }
462 },
463 "get": {
464 "tags": [
465 "PrivateDnsZoneGroups"
466 ],
467 "operationId": "PrivateDnsZoneGroups_Get",
468 "description": "Gets the private dns zone group resource by specified private dns zone group name.",
469 "parameters": [
470 {
471 "name": "resourceGroupName",
472 "in": "path",
473 "required": true,
474 "type": "string",
475 "description": "The name of the resource group."
476 },
477 {
478 "name": "privateEndpointName",
479 "in": "path",
480 "required": true,
481 "type": "string",
482 "description": "The name of the private endpoint."
483 },
484 {
485 "name": "privateDnsZoneGroupName",
486 "in": "path",
487 "required": true,
488 "type": "string",
489 "description": "The name of the private dns zone group."
490 },
491 {
492 "$ref": "./network.json#/parameters/ApiVersionParameter"
493 },
494 {
495 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
496 }
497 ],
498 "responses": {
499 "200": {
500 "description": "Request successful. The operation returns the resulting privateDnsZoneGroup resource.",
501 "schema": {
502 "$ref": "#/definitions/PrivateDnsZoneGroup"
503 }
504 },
505 "default": {
506 "description": "Error response describing why the operation failed.",
507 "schema": {
508 "$ref": "./network.json#/definitions/CloudError"
509 }
510 }
511 },
512 "x-ms-examples": {
513 "Get private dns zone group": {
514 "$ref": "./examples/PrivateEndpointDnsZoneGroupGet.json"
515 }
516 }
517 },
518 "put": {
519 "tags": [
520 "PrivateDnsZoneGroups"
521 ],
522 "operationId": "PrivateDnsZoneGroups_CreateOrUpdate",
523 "description": "Creates or updates a private dns zone group in the specified private endpoint.",
524 "parameters": [
525 {
526 "name": "resourceGroupName",
527 "in": "path",
528 "required": true,
529 "type": "string",
530 "description": "The name of the resource group."
531 },
532 {
533 "name": "privateEndpointName",
534 "in": "path",
535 "required": true,
536 "type": "string",
537 "description": "The name of the private endpoint."
538 },
539 {
540 "name": "privateDnsZoneGroupName",
541 "in": "path",
542 "required": true,
543 "type": "string",
544 "description": "The name of the private dns zone group."
545 },
546 {
547 "name": "parameters",
548 "in": "body",
549 "required": true,
550 "schema": {
551 "$ref": "#/definitions/PrivateDnsZoneGroup"
552 },
553 "description": "Parameters supplied to the create or update private dns zone group operation."
554 },
555 {
556 "$ref": "./network.json#/parameters/ApiVersionParameter"
557 },
558 {
559 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
560 }
561 ],
562 "responses": {
563 "200": {
564 "description": "Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.",
565 "schema": {
566 "$ref": "#/definitions/PrivateDnsZoneGroup"
567 }
568 },
569 "201": {
570 "description": "Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.",
571 "schema": {
572 "$ref": "#/definitions/PrivateDnsZoneGroup"
573 }
574 },
575 "default": {
576 "description": "Error response describing why the operation failed.",
577 "schema": {
578 "$ref": "./network.json#/definitions/CloudError"
579 }
580 }
581 },
582 "x-ms-long-running-operation": true,
583 "x-ms-long-running-operation-options": {
584 "final-state-via": "azure-async-operation"
585 },
586 "x-ms-examples": {
587 "Create private dns zone group": {
588 "$ref": "./examples/PrivateEndpointDnsZoneGroupCreate.json"
589 }
590 }
591 }
592 },
593 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups": {
594 "get": {
595 "tags": [
596 "PrivateDnsZoneGroups"
597 ],
598 "operationId": "PrivateDnsZoneGroups_List",
599 "description": "Gets all private dns zone groups in a private endpoint.",
600 "parameters": [
601 {
602 "name": "privateEndpointName",
603 "in": "path",
604 "required": true,
605 "type": "string",
606 "description": "The name of the private endpoint."
607 },
608 {
609 "name": "resourceGroupName",
610 "in": "path",
611 "required": true,
612 "type": "string",
613 "description": "The name of the resource group."
614 },
615 {
616 "$ref": "./network.json#/parameters/ApiVersionParameter"
617 },
618 {
619 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
620 }
621 ],
622 "responses": {
623 "200": {
624 "description": "Request successful. The operation returns a list of private dns zone group resources.",
625 "schema": {
626 "$ref": "#/definitions/PrivateDnsZoneGroupListResult"
627 }
628 },
629 "default": {
630 "description": "Error.",
631 "schema": {
632 "$ref": "./network.json#/definitions/Error"
633 }
634 }
635 },
636 "x-ms-examples": {
637 "List private endpoints in resource group": {
638 "$ref": "./examples/PrivateEndpointDnsZoneGroupList.json"
639 }
640 },
641 "x-ms-pageable": {
642 "nextLinkName": "nextLink"
643 }
644 }
645 }
646 },
647 "definitions": {
648 "PrivateEndpoint": {
649 "properties": {
650 "properties": {
651 "x-ms-client-flatten": true,
652 "$ref": "#/definitions/PrivateEndpointProperties",
653 "description": "Properties of the private endpoint."
654 },
655 "etag": {
656 "readOnly": true,
657 "type": "string",
658 "description": "A unique read-only string that changes whenever the resource is updated."
659 }
660 },
661 "allOf": [
662 {
663 "$ref": "./network.json#/definitions/Resource"
664 }
665 ],
666 "description": "Private endpoint resource."
667 },
668 "PrivateEndpointProperties": {
669 "properties": {
670 "subnet": {
671 "$ref": "./virtualNetwork.json#/definitions/Subnet",
672 "description": "The ID of the subnet from which the private IP will be allocated."
673 },
674 "networkInterfaces": {
675 "type": "array",
676 "readOnly": true,
677 "items": {
678 "$ref": "./networkInterface.json#/definitions/NetworkInterface"
679 },
680 "description": "An array of references to the network interfaces created for this private endpoint."
681 },
682 "provisioningState": {
683 "readOnly": true,
684 "$ref": "./network.json#/definitions/ProvisioningState",
685 "description": "The provisioning state of the private endpoint resource."
686 },
687 "privateLinkServiceConnections": {
688 "type": "array",
689 "items": {
690 "$ref": "#/definitions/PrivateLinkServiceConnection"
691 },
692 "description": "A grouping of information about the connection to the remote resource."
693 },
694 "manualPrivateLinkServiceConnections": {
695 "type": "array",
696 "items": {
697 "$ref": "#/definitions/PrivateLinkServiceConnection"
698 },
699 "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource."
700 },
701 "customDnsConfigs": {
702 "type": "array",
703 "items": {
704 "$ref": "#/definitions/CustomDnsConfigPropertiesFormat"
705 },
706 "description": "An array of custom dns configurations."
707 }
708 },
709 "description": "Properties of the private endpoint."
710 },
711 "CustomDnsConfigPropertiesFormat": {
712 "properties": {
713 "fqdn": {
714 "type": "string",
715 "description": "Fqdn that resolves to private endpoint ip address."
716 },
717 "ipAddresses": {
718 "type": "array",
719 "items": {
720 "type": "string"
721 },
722 "description": "A list of private ip addresses of the private endpoint."
723 }
724 },
725 "description": "Contains custom Dns resolution configuration from customer."
726 },
727 "PrivateLinkServiceConnection": {
728 "properties": {
729 "properties": {
730 "x-ms-client-flatten": true,
731 "$ref": "#/definitions/PrivateLinkServiceConnectionProperties",
732 "description": "Properties of the private link service connection."
733 },
734 "name": {
735 "type": "string",
736 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
737 },
738 "type": {
739 "readOnly": true,
740 "type": "string",
741 "description": "The resource type."
742 },
743 "etag": {
744 "readOnly": true,
745 "type": "string",
746 "description": "A unique read-only string that changes whenever the resource is updated."
747 }
748 },
749 "allOf": [
750 {
751 "$ref": "./network.json#/definitions/SubResource"
752 }
753 ],
754 "description": "PrivateLinkServiceConnection resource."
755 },
756 "PrivateLinkServiceConnectionProperties": {
757 "properties": {
758 "provisioningState": {
759 "readOnly": true,
760 "$ref": "./network.json#/definitions/ProvisioningState",
761 "description": "The provisioning state of the private link service connection resource."
762 },
763 "privateLinkServiceId": {
764 "type": "string",
765 "description": "The resource id of private link service."
766 },
767 "groupIds": {
768 "type": "array",
769 "items": {
770 "type": "string"
771 },
772 "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to."
773 },
774 "requestMessage": {
775 "type": "string",
776 "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars."
777 },
778 "privateLinkServiceConnectionState": {
779 "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState",
780 "description": "A collection of read-only information about the state of the connection to the remote resource."
781 }
782 },
783 "description": "Properties of the PrivateLinkServiceConnection."
784 },
785 "PrivateEndpointListResult": {
786 "properties": {
787 "value": {
788 "type": "array",
789 "items": {
790 "$ref": "#/definitions/PrivateEndpoint"
791 },
792 "description": "A list of private endpoint resources in a resource group."
793 },
794 "nextLink": {
795 "type": "string",
796 "description": "The URL to get the next set of results.",
797 "readOnly": true
798 }
799 },
800 "description": "Response for the ListPrivateEndpoints API service call."
801 },
802 "PrivateDnsZoneGroupListResult": {
803 "properties": {
804 "value": {
805 "type": "array",
806 "items": {
807 "$ref": "#/definitions/PrivateDnsZoneGroup"
808 },
809 "description": "A list of private dns zone group resources in a private endpoint."
810 },
811 "nextLink": {
812 "type": "string",
813 "description": "The URL to get the next set of results.",
814 "readOnly": true
815 }
816 },
817 "description": "Response for the ListPrivateDnsZoneGroups API service call."
818 },
819 "AvailablePrivateEndpointTypesResult": {
820 "properties": {
821 "value": {
822 "type": "array",
823 "items": {
824 "$ref": "#/definitions/AvailablePrivateEndpointType"
825 },
826 "description": "An array of available privateEndpoint type."
827 },
828 "nextLink": {
829 "readOnly": true,
830 "type": "string",
831 "description": "The URL to get the next set of results."
832 }
833 },
834 "description": "An array of available PrivateEndpoint types."
835 },
836 "AvailablePrivateEndpointType": {
837 "properties": {
838 "name": {
839 "type": "string",
840 "description": "The name of the service and resource."
841 },
842 "id": {
843 "type": "string",
844 "description": "A unique identifier of the AvailablePrivateEndpoint Type resource."
845 },
846 "type": {
847 "type": "string",
848 "description": "Resource type."
849 },
850 "resourceName": {
851 "type": "string",
852 "description": "The name of the service and resource."
853 }
854 },
855 "description": "The information of an AvailablePrivateEndpointType."
856 },
857 "PrivateDnsZoneGroup": {
858 "properties": {
859 "name": {
860 "type": "string",
861 "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource."
862 },
863 "etag": {
864 "readOnly": true,
865 "type": "string",
866 "description": "A unique read-only string that changes whenever the resource is updated."
867 },
868 "properties": {
869 "x-ms-client-flatten": true,
870 "$ref": "#/definitions/PrivateDnsZoneGroupPropertiesFormat",
871 "description": "Properties of the private dns zone group."
872 }
873 },
874 "allOf": [
875 {
876 "$ref": "./network.json#/definitions/SubResource"
877 }
878 ],
879 "description": "Private dns zone group resource."
880 },
881 "PrivateDnsZoneGroupPropertiesFormat": {
882 "properties": {
883 "provisioningState": {
884 "readOnly": true,
885 "$ref": "./network.json#/definitions/ProvisioningState",
886 "description": "The provisioning state of the private dns zone group resource."
887 },
888 "privateDnsZoneConfigs": {
889 "type": "array",
890 "items": {
891 "$ref": "#/definitions/PrivateDnsZoneConfig"
892 },
893 "description": "A collection of private dns zone configurations of the private dns zone group."
894 }
895 },
896 "description": "Properties of the private dns zone group."
897 },
898 "PrivateDnsZoneConfig": {
899 "properties": {
900 "name": {
901 "type": "string",
902 "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource."
903 },
904 "properties": {
905 "x-ms-client-flatten": true,
906 "$ref": "#/definitions/PrivateDnsZonePropertiesFormat",
907 "description": "Properties of the private dns zone configuration."
908 }
909 },
910 "description": "PrivateDnsZoneConfig resource."
911 },
912 "PrivateDnsZonePropertiesFormat": {
913 "properties": {
914 "privateDnsZoneId": {
915 "type": "string",
916 "description": "The resource id of the private dns zone."
917 },
918 "recordSets": {
919 "type": "array",
920 "readOnly": true,
921 "items": {
922 "$ref": "#/definitions/RecordSet"
923 },
924 "description": "A collection of information regarding a recordSet, holding information to identify private resources."
925 }
926 },
927 "description": "Properties of the private dns zone configuration resource."
928 },
929 "RecordSet": {
930 "properties": {
931 "recordType": {
932 "type": "string",
933 "description": "Resource record type."
934 },
935 "recordSetName": {
936 "type": "string",
937 "description": "Recordset name."
938 },
939 "fqdn": {
940 "type": "string",
941 "description": "Fqdn that resolves to private endpoint ip address."
942 },
943 "provisioningState": {
944 "readOnly": true,
945 "$ref": "./network.json#/definitions/ProvisioningState",
946 "description": "The provisioning state of the recordset."
947 },
948 "ttl": {
949 "type": "integer",
950 "description": "Recordset time to live."
951 },
952 "ipAddresses": {
953 "type": "array",
954 "items": {
955 "type": "string"
956 },
957 "description": "The private ip address of the private endpoint."
958 }
959 },
960 "description": "A collective group of information about the record set information."
961 }
962 }
963}
View as plain text