[Microsoft.DeviceUpdate] Private Link - Added Network RP required properties (Azure#17042)

darkoa-msft · Leiwang3SQL · commit da3e8f877fa5 · 2022-03-30T17:04:27.000-07:00
* Added group IDs array to PrivateEndpointConnection in v4 common type

* Added private endpoint connections to the top level resource

* Updated examples

* Added types.json to commopn-types/v4

* Moved new version of privatelinks.json into our directory

* Wrong level

* Added period to the end of description for consistency

* Updated version in privatelinks.json

* Removed duplicate resource from privatelinks.json

* Made PrivateEndpointConnection.properties required, added PEC payload to examples

* Added Operations List example

* Referenced Operations example file from the swagger

* Reduce number of operations in the Operations_List example

* Fixed Operations List example

* Removed PrivateEnpointConnection from Account update example
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json
@@ -675,7 +675,7 @@
           "200": {
             "description": "The request was successful; the request was well-formed and received properly.",
             "schema": {
-              "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+              "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
             }
           },
           "default": {
@@ -716,14 +716,14 @@
             "$ref": "#/parameters/AccountNameParameter"
           },
           {
-            "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+            "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
           }
         ],
         "responses": {
           "200": {
             "description": "The request was successful; the request was well-formed and received properly.",
             "schema": {
-              "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection"
+              "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
             }
           },
           "default": {
@@ -759,23 +759,23 @@
             "$ref": "#/parameters/AccountNameParameter"
           },
           {
-            "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+            "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
           },
           {
             "name": "privateEndpointConnection",
             "in": "body",
             "description": "The parameters for creating a private endpoint connection.",
             "required": true,
             "schema": {
-              "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection"
+              "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
             }
           }
         ],
         "responses": {
           "201": {
             "description": "The request was successful; the operation will complete asynchronously.",
             "schema": {
-              "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection"
+              "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
             }
           },
           "default": {
@@ -815,7 +815,7 @@
             "$ref": "#/parameters/AccountNameParameter"
           },
           {
-            "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+            "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
           }
         ],
         "responses": {
@@ -1207,6 +1207,11 @@
         "deprecated": false,
         "x-ms-pageable": {
           "nextLinkName": "nextLink"
+        },
+        "x-ms-examples": {
+          "Gets list of Operations": {
+            "$ref": "./examples/Operations_List.json"
+          }
         }
       }
     }
@@ -1249,7 +1254,7 @@
               "readOnly": true
             },
             "publicNetworkAccess": {
-              "description": "Whether or not public network access is allowed for the container registry.",
+              "description": "Whether or not public network access is allowed for the account.",
               "default": "Enabled",
               "enum": [
                 "Enabled",
@@ -1260,6 +1265,13 @@
                 "name": "PublicNetworkAccess",
                 "modelAsString": true
               }
+            },
+            "privateEndpointConnections": {
+              "description": "List of private endpoint connections associated with the account.",
+              "type": "array",
+              "items": {
+                "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+              }
             }
           }
         },
@@ -1489,7 +1501,7 @@
       "type": "object",
       "allOf": [
         {
-          "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResourceProperties"
+          "$ref": "./privatelinks.json#/definitions/PrivateLinkResourceProperties"
         }
       ],
       "properties": {
@@ -1636,7 +1648,7 @@
         },
         "remotePrivateLinkServiceConnectionState": {
           "description": "Remote private link service connection state",
-          "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkServiceConnectionState"
+          "$ref": "./privatelinks.json#/definitions/PrivateLinkServiceConnectionState"
         },
         "remotePrivateEndpointConnection": {
           "description": "Remote private endpoint connection details.",
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Create.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Create.json
@@ -18,7 +18,8 @@
         "type": "Microsoft.DeviceUpdate/accounts",
         "properties": {
           "provisioningState": "Accepted",
-          "hostName": "contoso.api.adu.microsoft.com"
+          "hostName": "contoso.api.adu.microsoft.com",
+          "privateEndpointConnections": []
         }
       }
     }
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Get.json
@@ -14,7 +14,28 @@
         "type": "Microsoft.DeviceUpdate/accounts",
         "properties": {
           "provisioningState": "Succeeded",
-          "hostName": "contoso.api.adu.microsoft.com"
+          "hostName": "contoso.api.adu.microsoft.com",
+          "privateEndpointConnections": [
+            {
+              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+              "name": "peexample01",
+              "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+              "properties": {
+                "provisioningState": "Succeeded",
+                "privateEndpoint": {
+                  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+                },
+                "privateLinkServiceConnectionState": {
+                  "status": "Approved",
+                  "description": "Auto-Approved",
+                  "actionsRequired": "None"
+                },
+                "groupIds": [
+                  "groupId"
+                ]
+              }
+            }
+          ]
         }
       }
     }
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_List.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_List.json
@@ -16,7 +16,28 @@
             "type": "Microsoft.DeviceUpdate/accounts",
             "properties": {
               "provisioningState": "Succeeded",
-              "hostName": "contoso.api.adu.microsoft.com"
+              "hostName": "contoso.api.adu.microsoft.com",
+              "privateEndpointConnections": [
+                {
+                  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+                  "name": "peexample01",
+                  "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+                  "properties": {
+                    "provisioningState": "Succeeded",
+                    "privateEndpoint": {
+                      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+                    },
+                    "privateLinkServiceConnectionState": {
+                      "status": "Approved",
+                      "description": "Auto-Approved",
+                      "actionsRequired": "None"
+                    },
+                    "groupIds": [
+                      "groupId"
+                    ]
+                  }
+                }
+              ]
             }
           }
         ]
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Update.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Accounts/Accounts_Update.json
@@ -19,7 +19,28 @@
         "type": "Microsoft.DeviceUpdate/accounts",
         "properties": {
           "provisioningState": "Succeeded",
-          "hostName": "contoso.api.adu.microsoft.com"
+          "hostName": "contoso.api.adu.microsoft.com",
+          "privateEndpointConnections": [
+            {
+              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+              "name": "peexample01",
+              "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+              "properties": {
+                "provisioningState": "Succeeded",
+                "privateEndpoint": {
+                  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+                },
+                "privateLinkServiceConnectionState": {
+                  "status": "Approved",
+                  "description": "Auto-Approved",
+                  "actionsRequired": "None"
+                },
+                "groupIds": [
+                  "groupId"
+                ]
+              }
+            }
+          ]
         },
         "tags": {
           "tagKey": "tagValue"
@@ -39,7 +60,28 @@
         },
         "properties": {
           "provisioningState": "Created",
-          "hostName": "contoso.api.adu.microsoft.com"
+          "hostName": "contoso.api.adu.microsoft.com",
+          "privateEndpointConnections": [
+            {
+              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+              "name": "peexample01",
+              "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+              "properties": {
+                "provisioningState": "Succeeded",
+                "privateEndpoint": {
+                  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+                },
+                "privateLinkServiceConnectionState": {
+                  "status": "Approved",
+                  "description": "Auto-Approved",
+                  "actionsRequired": "None"
+                },
+                "groupIds": [
+                  "groupId"
+                ]
+              }
+            }
+          ]
         },
         "tags": {
           "tagKey": "tagValue"
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Operations_List.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Operations_List.json
@@ -0,0 +1,34 @@
+{
+  "parameters": {
+    "api-version": "2020-03-01-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "nextLink": "string",
+        "value": [
+          {
+            "name": "Microsoft.DeviceUpdate/accounts/read",
+            "isDataAction": false,
+            "display": {
+              "provider": "Microsoft.DeviceUpdate",
+              "resource": "Device Update Account",
+              "operation": "Get/List Accounts",
+              "description": "Returns the list of Device Update Accounts"
+            }
+          },
+          {
+            "name": "Microsoft.DeviceUpdate/accounts/write",
+            "isDataAction": false,
+            "display": {
+              "provider": "Microsoft.DeviceUpdate",
+              "resource": "Device Update Account",
+              "operation": "Create/Update Account",
+              "description": "Creates or updates a Device Update Account"
+            }
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json
@@ -29,7 +29,10 @@
             "status": "Approved",
             "description": "Auto-Approved",
             "actionsRequired": "None"
-          }
+          },
+          "groupIds": [
+            "groupId"
+          ]
         }
       }
     }
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json
@@ -21,7 +21,10 @@
             "status": "Approved",
             "description": "Auto-Approved",
             "actionsRequired": "None"
-          }
+          },
+          "groupIds": [
+            "groupId"
+          ]
         }
       }
     }
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json
@@ -22,7 +22,10 @@
                 "status": "Approved",
                 "description": "Auto-Approved",
                 "actionsRequired": "None"
-              }
+              },
+              "groupIds": [
+                "groupId"
+              ]
             }
           }
         ]
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/privatelinks.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/privatelinks.json

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,8 @@`
`18`	`18`	`"type": "Microsoft.DeviceUpdate/accounts",`
`19`	`19`	`"properties": {`
`20`	`20`	`"provisioningState": "Accepted",`
`21`		`- "hostName": "contoso.api.adu.microsoft.com"`
	`21`	`+ "hostName": "contoso.api.adu.microsoft.com",`
	`22`	`+ "privateEndpointConnections": []`
`22`	`23`	`}`
`23`	`24`	`}`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,10 @@`
`29`	`29`	`"status": "Approved",`
`30`	`30`	`"description": "Auto-Approved",`
`31`	`31`	`"actionsRequired": "None"`
`32`		`- }`
	`32`	`+ },`
	`33`	`+ "groupIds": [`
	`34`	`+ "groupId"`
	`35`	`+ ]`
`33`	`36`	`}`
`34`	`37`	`}`
`35`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,10 @@`
`21`	`21`	`"status": "Approved",`
`22`	`22`	`"description": "Auto-Approved",`
`23`	`23`	`"actionsRequired": "None"`
`24`		`- }`
	`24`	`+ },`
	`25`	`+ "groupIds": [`
	`26`	`+ "groupId"`
	`27`	`+ ]`
`25`	`28`	`}`
`26`	`29`	`}`
`27`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,10 @@`
`22`	`22`	`"status": "Approved",`
`23`	`23`	`"description": "Auto-Approved",`
`24`	`24`	`"actionsRequired": "None"`
`25`		`- }`
	`25`	`+ },`
	`26`	`+ "groupIds": [`
	`27`	`+ "groupId"`
	`28`	`+ ]`
`26`	`29`	`}`
`27`	`30`	`}`
`28`	`31`	`]`