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/privateLinkServices/{serviceName}": {
38 "delete": {
39 "tags": [
40 "PrivateLinkServices"
41 ],
42 "operationId": "PrivateLinkServices_Delete",
43 "description": "Deletes the specified private link service.",
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": "serviceName",
54 "in": "path",
55 "required": true,
56 "type": "string",
57 "description": "The name of the private link service."
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 link service": {
89 "$ref": "./examples/PrivateLinkServiceDelete.json"
90 }
91 }
92 },
93 "get": {
94 "tags": [
95 "PrivateLinkServices"
96 ],
97 "operationId": "PrivateLinkServices_Get",
98 "description": "Gets the specified private link service 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": "serviceName",
109 "in": "path",
110 "required": true,
111 "type": "string",
112 "description": "The name of the private link service."
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 PrivateLinkService resource.",
131 "schema": {
132 "$ref": "#/definitions/PrivateLinkService"
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 link service": {
144 "$ref": "./examples/PrivateLinkServiceGet.json"
145 }
146 }
147 },
148 "put": {
149 "tags": [
150 "PrivateLinkService"
151 ],
152 "operationId": "PrivateLinkServices_CreateOrUpdate",
153 "description": "Creates or updates an private link service in the specified resource group.",
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": "serviceName",
164 "in": "path",
165 "required": true,
166 "type": "string",
167 "description": "The name of the private link service."
168 },
169 {
170 "name": "parameters",
171 "in": "body",
172 "required": true,
173 "schema": {
174 "$ref": "#/definitions/PrivateLinkService"
175 },
176 "description": "Parameters supplied to the create or update private link service operation."
177 },
178 {
179 "$ref": "./network.json#/parameters/ApiVersionParameter"
180 },
181 {
182 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
183 }
184 ],
185 "responses": {
186 "200": {
187 "description": "Update successful. The operation returns the resulting privateLinkService resource.",
188 "schema": {
189 "$ref": "#/definitions/PrivateLinkService"
190 }
191 },
192 "201": {
193 "description": "Create successful. The operation returns the resulting privateLinkService resource.",
194 "schema": {
195 "$ref": "#/definitions/PrivateLinkService"
196 }
197 },
198 "default": {
199 "description": "Error.",
200 "schema": {
201 "$ref": "./network.json#/definitions/Error"
202 }
203 }
204 },
205 "x-ms-long-running-operation": true,
206 "x-ms-long-running-operation-options": {
207 "final-state-via": "azure-async-operation"
208 },
209 "x-ms-examples": {
210 "Create private link service": {
211 "$ref": "./examples/PrivateLinkServiceCreate.json"
212 }
213 }
214 }
215 },
216 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices": {
217 "get": {
218 "tags": [
219 "PrivateLinkServices"
220 ],
221 "operationId": "PrivateLinkServices_List",
222 "description": "Gets all private link services in a resource group.",
223 "parameters": [
224 {
225 "name": "resourceGroupName",
226 "in": "path",
227 "required": true,
228 "type": "string",
229 "description": "The name of the resource group."
230 },
231 {
232 "$ref": "./network.json#/parameters/ApiVersionParameter"
233 },
234 {
235 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
236 }
237 ],
238 "responses": {
239 "200": {
240 "description": "Request successful. The operation returns a list of privateLinkService resources.",
241 "schema": {
242 "$ref": "#/definitions/PrivateLinkServiceListResult"
243 }
244 },
245 "default": {
246 "description": "Error.",
247 "schema": {
248 "$ref": "./network.json#/definitions/Error"
249 }
250 }
251 },
252 "x-ms-examples": {
253 "List private link service in resource group": {
254 "$ref": "./examples/PrivateLinkServiceList.json"
255 }
256 },
257 "x-ms-pageable": {
258 "nextLinkName": "nextLink"
259 }
260 }
261 },
262 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices": {
263 "get": {
264 "tags": [
265 "PrivateLinkServices"
266 ],
267 "operationId": "PrivateLinkServices_ListBySubscription",
268 "description": "Gets all private link service in a subscription.",
269 "parameters": [
270 {
271 "$ref": "./network.json#/parameters/ApiVersionParameter"
272 },
273 {
274 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
275 }
276 ],
277 "responses": {
278 "200": {
279 "description": "Request successful. The operation returns a list of PrivateLinkService resources.",
280 "schema": {
281 "$ref": "#/definitions/PrivateLinkServiceListResult"
282 }
283 },
284 "default": {
285 "description": "Error.",
286 "schema": {
287 "$ref": "./network.json#/definitions/Error"
288 }
289 }
290 },
291 "x-ms-examples": {
292 "List all private list service": {
293 "$ref": "./examples/PrivateLinkServiceListAll.json"
294 }
295 },
296 "x-ms-pageable": {
297 "nextLinkName": "nextLink"
298 }
299 }
300 },
301 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}": {
302 "get": {
303 "tags": [
304 "PrivateLinkServices"
305 ],
306 "operationId": "PrivateLinkServices_GetPrivateEndpointConnection",
307 "description": "Get the specific private end point connection by specific private link service in the resource group.",
308 "parameters": [
309 {
310 "name": "resourceGroupName",
311 "in": "path",
312 "required": true,
313 "type": "string",
314 "description": "The name of the resource group."
315 },
316 {
317 "name": "serviceName",
318 "in": "path",
319 "required": true,
320 "type": "string",
321 "description": "The name of the private link service."
322 },
323 {
324 "name": "peConnectionName",
325 "in": "path",
326 "required": true,
327 "type": "string",
328 "description": "The name of the private end point connection."
329 },
330 {
331 "$ref": "./network.json#/parameters/ApiVersionParameter"
332 },
333 {
334 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
335 },
336 {
337 "name": "$expand",
338 "in": "query",
339 "required": false,
340 "type": "string",
341 "description": "Expands referenced resources."
342 }
343 ],
344 "responses": {
345 "200": {
346 "description": "Request successful. The operation returns the resulting private end point connection resource.",
347 "schema": {
348 "$ref": "#/definitions/PrivateEndpointConnection"
349 }
350 },
351 "default": {
352 "description": "Error.",
353 "schema": {
354 "$ref": "./network.json#/definitions/Error"
355 }
356 }
357 },
358 "x-ms-examples": {
359 "Get private end point connection": {
360 "$ref": "./examples/PrivateLinkServiceGetPrivateEndpointConnection.json"
361 }
362 }
363 },
364 "put": {
365 "tags": [
366 "PrivateLinkServices"
367 ],
368 "operationId": "PrivateLinkServices_UpdatePrivateEndpointConnection",
369 "description": "Approve or reject private end point connection for a private link service in a subscription.",
370 "parameters": [
371 {
372 "name": "resourceGroupName",
373 "in": "path",
374 "required": true,
375 "type": "string",
376 "description": "The name of the resource group."
377 },
378 {
379 "name": "serviceName",
380 "in": "path",
381 "required": true,
382 "type": "string",
383 "description": "The name of the private link service."
384 },
385 {
386 "name": "peConnectionName",
387 "in": "path",
388 "required": true,
389 "type": "string",
390 "description": "The name of the private end point connection."
391 },
392 {
393 "name": "parameters",
394 "in": "body",
395 "required": true,
396 "schema": {
397 "$ref": "#/definitions/PrivateEndpointConnection"
398 },
399 "description": "Parameters supplied to approve or reject the private end point connection."
400 },
401 {
402 "$ref": "./network.json#/parameters/ApiVersionParameter"
403 },
404 {
405 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
406 }
407 ],
408 "responses": {
409 "200": {
410 "description": "Update successful. The operation returns the resulting PrivateEndpointConnection resource.",
411 "schema": {
412 "$ref": "#/definitions/PrivateEndpointConnection"
413 }
414 },
415 "default": {
416 "description": "Error.",
417 "schema": {
418 "$ref": "./network.json#/definitions/Error"
419 }
420 }
421 },
422 "x-ms-examples": {
423 "approve or reject private end point connection for a private link service": {
424 "$ref": "./examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json"
425 }
426 }
427 },
428 "delete": {
429 "tags": [
430 "PrivateLinkServices"
431 ],
432 "operationId": "PrivateLinkServices_DeletePrivateEndpointConnection",
433 "description": "Delete private end point connection for a private link service in a subscription.",
434 "parameters": [
435 {
436 "name": "resourceGroupName",
437 "in": "path",
438 "required": true,
439 "type": "string",
440 "description": "The name of the resource group."
441 },
442 {
443 "name": "serviceName",
444 "in": "path",
445 "required": true,
446 "type": "string",
447 "description": "The name of the private link service."
448 },
449 {
450 "name": "peConnectionName",
451 "in": "path",
452 "required": true,
453 "type": "string",
454 "description": "The name of the private end point connection."
455 },
456 {
457 "$ref": "./network.json#/parameters/ApiVersionParameter"
458 },
459 {
460 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
461 }
462 ],
463 "responses": {
464 "202": {
465 "description": "Accepted and the operation will complete asynchronously."
466 },
467 "204": {
468 "description": "Delete successful."
469 },
470 "200": {
471 "description": "Delete successful."
472 },
473 "default": {
474 "description": "Error.",
475 "schema": {
476 "$ref": "./network.json#/definitions/Error"
477 }
478 }
479 },
480 "x-ms-examples": {
481 "delete private end point connection for a private link service": {
482 "$ref": "./examples/PrivateLinkServiceDeletePrivateEndpointConnection.json"
483 }
484 },
485 "x-ms-long-running-operation": true,
486 "x-ms-long-running-operation-options": {
487 "final-state-via": "location"
488 }
489 }
490 },
491 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections": {
492 "get": {
493 "tags": [
494 "PrivateLinkServices"
495 ],
496 "operationId": "PrivateLinkServices_ListPrivateEndpointConnections",
497 "description": "Gets all private end point connections for a specific private link service.",
498 "parameters": [
499 {
500 "name": "resourceGroupName",
501 "in": "path",
502 "required": true,
503 "type": "string",
504 "description": "The name of the resource group."
505 },
506 {
507 "name": "serviceName",
508 "in": "path",
509 "required": true,
510 "type": "string",
511 "description": "The name of the private link service."
512 },
513 {
514 "$ref": "./network.json#/parameters/ApiVersionParameter"
515 },
516 {
517 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
518 }
519 ],
520 "responses": {
521 "200": {
522 "description": "Request successful. The operation returns a list of private end point connection resources.",
523 "schema": {
524 "$ref": "#/definitions/PrivateEndpointConnectionListResult"
525 }
526 },
527 "default": {
528 "description": "Error.",
529 "schema": {
530 "$ref": "./network.json#/definitions/Error"
531 }
532 }
533 },
534 "x-ms-examples": {
535 "List private link service in resource group": {
536 "$ref": "./examples/PrivateLinkServiceListPrivateEndpointConnection.json"
537 }
538 },
539 "x-ms-pageable": {
540 "nextLinkName": "nextLink"
541 }
542 }
543 },
544 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": {
545 "post": {
546 "tags": [
547 "PrivateLinkServices"
548 ],
549 "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibility",
550 "description": "Checks whether the subscription is visible to private link service.",
551 "parameters": [
552 {
553 "name": "location",
554 "in": "path",
555 "required": true,
556 "type": "string",
557 "description": "The location of the domain name."
558 },
559 {
560 "name": "parameters",
561 "in": "body",
562 "required": true,
563 "schema": {
564 "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest"
565 },
566 "description": "The request body of CheckPrivateLinkService API call."
567 },
568 {
569 "$ref": "./network.json#/parameters/ApiVersionParameter"
570 },
571 {
572 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
573 }
574 ],
575 "responses": {
576 "200": {
577 "description": "Request successful. Returns whether the subscription is visible to private link service.",
578 "schema": {
579 "$ref": "#/definitions/PrivateLinkServiceVisibility"
580 }
581 },
582 "202": {
583 "description": "Accepted and the operation will complete asynchronously."
584 },
585 "default": {
586 "description": "Error response describing why the operation failed.",
587 "schema": {
588 "$ref": "./network.json#/definitions/CloudError"
589 }
590 }
591 },
592 "x-ms-long-running-operation": true,
593 "x-ms-long-running-operation-options": {
594 "final-state-via": "location"
595 },
596 "x-ms-examples": {
597 "Check private link service visibility": {
598 "$ref": "./examples/CheckPrivateLinkServiceVisibility.json"
599 }
600 }
601 }
602 },
603 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": {
604 "post": {
605 "tags": [
606 "PrivateLinkServices"
607 ],
608 "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibilityByResourceGroup",
609 "description": "Checks whether the subscription is visible to private link service in the specified resource group.",
610 "parameters": [
611 {
612 "name": "location",
613 "in": "path",
614 "required": true,
615 "type": "string",
616 "description": "The location of the domain name."
617 },
618 {
619 "name": "resourceGroupName",
620 "in": "path",
621 "required": true,
622 "type": "string",
623 "description": "The name of the resource group."
624 },
625 {
626 "name": "parameters",
627 "in": "body",
628 "required": true,
629 "schema": {
630 "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest"
631 },
632 "description": "The request body of CheckPrivateLinkService API call."
633 },
634 {
635 "$ref": "./network.json#/parameters/ApiVersionParameter"
636 },
637 {
638 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
639 }
640 ],
641 "responses": {
642 "200": {
643 "description": "Request successful. Returns whether the subscription is visible to private link service.",
644 "schema": {
645 "$ref": "#/definitions/PrivateLinkServiceVisibility"
646 }
647 },
648 "202": {
649 "description": "Accepted and the operation will complete asynchronously."
650 },
651 "default": {
652 "description": "Error response describing why the operation failed.",
653 "schema": {
654 "$ref": "./network.json#/definitions/CloudError"
655 }
656 }
657 },
658 "x-ms-long-running-operation": true,
659 "x-ms-long-running-operation-options": {
660 "final-state-via": "location"
661 },
662 "x-ms-examples": {
663 "Check private link service visibility": {
664 "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json"
665 }
666 }
667 }
668 },
669 "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": {
670 "get": {
671 "tags": [
672 "PrivateLinkServices"
673 ],
674 "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServices",
675 "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.",
676 "parameters": [
677 {
678 "name": "location",
679 "in": "path",
680 "required": true,
681 "type": "string",
682 "description": "The location of the domain name."
683 },
684 {
685 "$ref": "./network.json#/parameters/ApiVersionParameter"
686 },
687 {
688 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
689 }
690 ],
691 "responses": {
692 "200": {
693 "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.",
694 "schema": {
695 "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult"
696 }
697 },
698 "default": {
699 "description": "Error response describing why the operation failed.",
700 "schema": {
701 "$ref": "./network.json#/definitions/CloudError"
702 }
703 }
704 },
705 "x-ms-examples": {
706 "Get list of private link service id that can be linked to a private end point with auto approved": {
707 "$ref": "./examples/AutoApprovedPrivateLinkServicesGet.json"
708 }
709 },
710 "x-ms-pageable": {
711 "nextLinkName": "nextLink"
712 }
713 }
714 },
715 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": {
716 "get": {
717 "tags": [
718 "PrivateLinkServices"
719 ],
720 "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServicesByResourceGroup",
721 "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.",
722 "parameters": [
723 {
724 "name": "location",
725 "in": "path",
726 "required": true,
727 "type": "string",
728 "description": "The location of the domain name."
729 },
730 {
731 "name": "resourceGroupName",
732 "in": "path",
733 "required": true,
734 "type": "string",
735 "description": "The name of the resource group."
736 },
737 {
738 "$ref": "./network.json#/parameters/ApiVersionParameter"
739 },
740 {
741 "$ref": "./network.json#/parameters/SubscriptionIdParameter"
742 }
743 ],
744 "responses": {
745 "200": {
746 "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.",
747 "schema": {
748 "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult"
749 }
750 },
751 "default": {
752 "description": "Error response describing why the operation failed.",
753 "schema": {
754 "$ref": "./network.json#/definitions/CloudError"
755 }
756 }
757 },
758 "x-ms-examples": {
759 "Get list of private link service id that can be linked to a private end point with auto approved": {
760 "$ref": "./examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json"
761 }
762 },
763 "x-ms-pageable": {
764 "nextLinkName": "nextLink"
765 }
766 }
767 }
768 },
769 "definitions": {
770 "PrivateLinkService": {
771 "properties": {
772 "properties": {
773 "x-ms-client-flatten": true,
774 "$ref": "#/definitions/PrivateLinkServiceProperties",
775 "description": "Properties of the private link service."
776 },
777 "etag": {
778 "readOnly": true,
779 "type": "string",
780 "description": "A unique read-only string that changes whenever the resource is updated."
781 }
782 },
783 "allOf": [
784 {
785 "$ref": "./network.json#/definitions/Resource"
786 }
787 ],
788 "description": "Private link service resource."
789 },
790 "PrivateLinkServiceProperties": {
791 "properties": {
792 "loadBalancerFrontendIpConfigurations": {
793 "type": "array",
794 "items": {
795 "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration"
796 },
797 "description": "An array of references to the load balancer IP configurations."
798 },
799 "ipConfigurations": {
800 "type": "array",
801 "items": {
802 "$ref": "#/definitions/PrivateLinkServiceIpConfiguration"
803 },
804 "description": "An array of private link service IP configurations."
805 },
806 "networkInterfaces": {
807 "type": "array",
808 "readOnly": true,
809 "items": {
810 "$ref": "./networkInterface.json#/definitions/NetworkInterface"
811 },
812 "description": "An array of references to the network interfaces created for this private link service."
813 },
814 "provisioningState": {
815 "readOnly": true,
816 "$ref": "./network.json#/definitions/ProvisioningState",
817 "description": "The provisioning state of the private link service resource."
818 },
819 "privateEndpointConnections": {
820 "readOnly": true,
821 "type": "array",
822 "items": {
823 "$ref": "#/definitions/PrivateEndpointConnection"
824 },
825 "description": "An array of list about connections to the private endpoint."
826 },
827 "visibility": {
828 "allOf": [
829 {
830 "$ref": "#/definitions/ResourceSet"
831 }
832 ],
833 "description": "The visibility list of the private link service."
834 },
835 "autoApproval": {
836 "allOf": [
837 {
838 "$ref": "#/definitions/ResourceSet"
839 }
840 ],
841 "description": "The auto-approval list of the private link service."
842 },
843 "fqdns": {
844 "type": "array",
845 "items": {
846 "type": "string"
847 },
848 "description": "The list of Fqdn."
849 },
850 "alias": {
851 "readOnly": true,
852 "type": "string",
853 "description": "The alias of the private link service."
854 },
855 "enableProxyProtocol": {
856 "type": "boolean",
857 "description": "Whether the private link service is enabled for proxy protocol or not."
858 }
859 },
860 "description": "Properties of the private link service."
861 },
862 "ResourceSet": {
863 "properties": {
864 "subscriptions": {
865 "type": "array",
866 "items": {
867 "type": "string"
868 },
869 "description": "The list of subscriptions."
870 }
871 },
872 "description": "The base resource set for visibility and auto-approval."
873 },
874 "PrivateLinkServiceIpConfiguration": {
875 "properties": {
876 "properties": {
877 "x-ms-client-flatten": true,
878 "$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties",
879 "description": "Properties of the private link service ip configuration."
880 },
881 "name": {
882 "type": "string",
883 "description": "The name of private link service ip configuration."
884 },
885 "etag": {
886 "readOnly": true,
887 "type": "string",
888 "description": "A unique read-only string that changes whenever the resource is updated."
889 },
890 "type": {
891 "readOnly": true,
892 "type": "string",
893 "description": "The resource type."
894 }
895 },
896 "allOf": [
897 {
898 "$ref": "./network.json#/definitions/SubResource"
899 }
900 ],
901 "description": "The private link service ip configuration."
902 },
903 "PrivateLinkServiceIpConfigurationProperties": {
904 "properties": {
905 "privateIPAddress": {
906 "type": "string",
907 "description": "The private IP address of the IP configuration."
908 },
909 "privateIPAllocationMethod": {
910 "$ref": "./network.json#/definitions/IPAllocationMethod",
911 "description": "The private IP address allocation method."
912 },
913 "subnet": {
914 "$ref": "./virtualNetwork.json#/definitions/Subnet",
915 "description": "The reference to the subnet resource."
916 },
917 "primary": {
918 "type": "boolean",
919 "description": "Whether the ip configuration is primary or not."
920 },
921 "provisioningState": {
922 "readOnly": true,
923 "$ref": "./network.json#/definitions/ProvisioningState",
924 "description": "The provisioning state of the private link service IP configuration resource."
925 },
926 "privateIPAddressVersion": {
927 "$ref": "./network.json#/definitions/IPVersion",
928 "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4."
929 }
930 },
931 "description": "Properties of private link service IP configuration."
932 },
933 "PrivateEndpointConnection": {
934 "properties": {
935 "properties": {
936 "x-ms-client-flatten": true,
937 "$ref": "#/definitions/PrivateEndpointConnectionProperties",
938 "description": "Properties of the private end point connection."
939 },
940 "name": {
941 "type": "string",
942 "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
943 },
944 "type": {
945 "readOnly": true,
946 "type": "string",
947 "description": "The resource type."
948 },
949 "etag": {
950 "readOnly": true,
951 "type": "string",
952 "description": "A unique read-only string that changes whenever the resource is updated."
953 }
954 },
955 "allOf": [
956 {
957 "$ref": "./network.json#/definitions/SubResource"
958 }
959 ],
960 "description": "PrivateEndpointConnection resource."
961 },
962 "PrivateEndpointConnectionProperties": {
963 "properties": {
964 "privateEndpoint": {
965 "readOnly": true,
966 "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint",
967 "description": "The resource of private end point."
968 },
969 "privateLinkServiceConnectionState": {
970 "$ref": "#/definitions/PrivateLinkServiceConnectionState",
971 "description": "A collection of information about the state of the connection between service consumer and provider."
972 },
973 "provisioningState": {
974 "readOnly": true,
975 "$ref": "./network.json#/definitions/ProvisioningState",
976 "description": "The provisioning state of the private endpoint connection resource."
977 },
978 "linkIdentifier": {
979 "readOnly": true,
980 "type": "string",
981 "description": "The consumer link id."
982 }
983 },
984 "description": "Properties of the PrivateEndpointConnectProperties."
985 },
986 "PrivateLinkServiceConnectionState": {
987 "properties": {
988 "status": {
989 "type": "string",
990 "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
991 },
992 "description": {
993 "type": "string",
994 "description": "The reason for approval/rejection of the connection."
995 },
996 "actionsRequired": {
997 "type": "string",
998 "description": "A message indicating if changes on the service provider require any updates on the consumer."
999 }
1000 },
1001 "description": "A collection of information about the state of the connection between service consumer and provider."
1002 },
1003 "PrivateLinkServiceListResult": {
1004 "properties": {
1005 "value": {
1006 "type": "array",
1007 "items": {
1008 "$ref": "#/definitions/PrivateLinkService"
1009 },
1010 "description": "A list of PrivateLinkService resources in a resource group."
1011 },
1012 "nextLink": {
1013 "type": "string",
1014 "description": "The URL to get the next set of results.",
1015 "readOnly": true
1016 }
1017 },
1018 "description": "Response for the ListPrivateLinkService API service call."
1019 },
1020 "PrivateEndpointConnectionListResult": {
1021 "properties": {
1022 "value": {
1023 "type": "array",
1024 "items": {
1025 "$ref": "#/definitions/PrivateEndpointConnection"
1026 },
1027 "description": "A list of PrivateEndpointConnection resources for a specific private link service."
1028 },
1029 "nextLink": {
1030 "type": "string",
1031 "description": "The URL to get the next set of results.",
1032 "readOnly": true
1033 }
1034 },
1035 "description": "Response for the ListPrivateEndpointConnection API service call."
1036 },
1037 "CheckPrivateLinkServiceVisibilityRequest": {
1038 "properties": {
1039 "privateLinkServiceAlias": {
1040 "type": "string",
1041 "description": "The alias of the private link service."
1042 }
1043 },
1044 "description": "Request body of the CheckPrivateLinkServiceVisibility API service call."
1045 },
1046 "PrivateLinkServiceVisibility": {
1047 "properties": {
1048 "visible": {
1049 "type": "boolean",
1050 "description": "Private Link Service Visibility (True/False)."
1051 }
1052 },
1053 "description": "Response for the CheckPrivateLinkServiceVisibility API service call."
1054 },
1055 "AutoApprovedPrivateLinkServicesResult": {
1056 "properties": {
1057 "value": {
1058 "type": "array",
1059 "items": {
1060 "$ref": "#/definitions/AutoApprovedPrivateLinkService"
1061 },
1062 "description": "An array of auto approved private link service."
1063 },
1064 "nextLink": {
1065 "readOnly": true,
1066 "type": "string",
1067 "description": "The URL to get the next set of results."
1068 }
1069 },
1070 "description": "An array of private link service id that can be linked to a private end point with auto approved."
1071 },
1072 "AutoApprovedPrivateLinkService": {
1073 "properties": {
1074 "privateLinkService": {
1075 "type": "string",
1076 "description": "The id of the private link service resource."
1077 }
1078 },
1079 "description": "The information of an AutoApprovedPrivateLinkService."
1080 }
1081 }
1082}
View as plain text