[AzureSearch] Add more examples on IP-restriction and private endpoin…

…t + fixes (#9381) * update iprules and add more samples for create and update;fix incorrect sample for private endpoint * verbose change * typo fix * wording fix * fix model validation
Azure · May 7, 2020 · 2d4784c · 2d4784c
1 parent 03482b9
commit 2d4784c
Show file tree

Hide file tree

Showing 5 changed files with 201 additions and 8 deletions.
diff --git a/...ble/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json b/...ble/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json
@@ -0,0 +1,81 @@
+{
+  "parameters": {
+    "searchServiceName": "mysearchservice",
+    "resourceGroupName": "rg1",
+    "api-version": "2020-03-13",
+    "subscriptionId": "subid",
+    "service": {
+      "location": "westus",
+      "tags": {
+        "app-name": "My e-commerce app"
+      },
+      "sku": {
+        "name": "standard"
+      },
+      "properties": {
+        "replicaCount": 3,
+        "partitionCount": 1,
+        "publicNetworkAccess": "disabled",
+        "hostingMode": "default"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+        "name": "mysearchservice",
+        "location": "westus",
+        "type": "Microsoft.Search/searchServices",
+        "tags": {
+          "app-name": "My e-commerce app"
+        },
+        "sku": {
+          "name": "standard"
+        },
+        "properties": {
+          "replicaCount": 3,
+          "partitionCount": 1,
+          "status": "provisioning",
+          "statusDetails": "",
+          "hostingMode": "default",
+          "provisioningState": "provisioning",
+          "publicNetworkAccess": "disabled",
+          "networkRuleSet": {
+            "ipRules": []
+          },
+          "privateEndpointConnections": [],
+          "sharedPrivateLinkResources": []
+        }
+      }
+    },
+    "201": {
+      "body": {
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+        "name": "mysearchservice",
+        "location": "westus",
+        "type": "Microsoft.Search/searchServices",
+        "tags": {
+          "app-name": "My e-commerce app"
+        },
+        "sku": {
+          "name": "standard"
+        },
+        "properties": {
+          "replicaCount": 3,
+          "partitionCount": 1,
+          "status": "provisioning",
+          "statusDetails": "",
+          "hostingMode": "default",
+          "provisioningState": "provisioning",
+          "publicNetworkAccess": "disabled",
+          "networkRuleSet": {
+            "ipRules": []
+          },
+          "privateEndpointConnections": [],
+          "sharedPrivateLinkResources": []
+        }
+      }
+    }
+  }
+}
diff --git a/...able/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json b/...able/2020-03-13/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json
@@ -0,0 +1,104 @@
+{
+  "parameters": {
+    "searchServiceName": "mysearchservice",
+    "resourceGroupName": "rg1",
+    "api-version": "2020-03-13",
+    "subscriptionId": "subid",
+    "service": {
+      "location": "westus",
+      "tags": {
+        "app-name": "My e-commerce app"
+      },
+      "sku": {
+        "name": "standard"
+      },
+      "properties": {
+        "replicaCount": 1,
+        "partitionCount": 1,
+        "networkRuleSet": {
+          "ipRules": [
+            {
+              "value": "123.4.5.6"
+            },
+            {
+              "value": "123.4.6.0/18"
+            }
+          ]
+        },
+        "hostingMode": "default"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+        "name": "mysearchservice",
+        "location": "westus",
+        "type": "Microsoft.Search/searchServices",
+        "tags": {
+          "app-name": "My e-commerce app"
+        },
+        "sku": {
+          "name": "standard"
+        },
+        "properties": {
+          "replicaCount": 1,
+          "partitionCount": 1,
+          "status": "provisioning",
+          "statusDetails": "",
+          "hostingMode": "default",
+          "provisioningState": "provisioning",
+          "publicNetworkAccess": "enabled",
+          "networkRuleSet": {
+            "ipRules": [
+              {
+                "value": "123.4.5.6"
+              },
+              {
+                "value": "123.4.6.0/18"
+              }
+            ]
+          },
+          "privateEndpointConnections": [],
+          "sharedPrivateLinkResources": []
+        }
+      }
+    },
+    "201": {
+      "body": {
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
+        "name": "mysearchservice",
+        "location": "westus",
+        "type": "Microsoft.Search/searchServices",
+        "tags": {
+          "app-name": "My e-commerce app"
+        },
+        "sku": {
+          "name": "standard"
+        },
+        "properties": {
+          "replicaCount": 1,
+          "partitionCount": 1,
+          "status": "provisioning",
+          "statusDetails": "",
+          "hostingMode": "default",
+          "provisioningState": "provisioning",
+          "publicNetworkAccess": "enabled",
+          "networkRuleSet": {
+            "ipRules": [
+              {
+                "value": "123.4.5.6"
+              },
+              {
+                "value": "123.4.6.0/18"
+              }
+            ]
+          },
+          "privateEndpointConnections": [],
+          "sharedPrivateLinkResources": []
+        }
+      }
+    }
+  }
+}
diff --git a/...arch/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json b/...arch/stable/2020-03-13/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
@@ -8,9 +8,7 @@
       "properties": {
         "replicaCount": 1,
         "partitionCount": 1,
-        "networkRuleSet": {
-          "ipRules": []
-        }
+        "publicNetworkAccess": "disabled"
       }
     }
   },
@@ -35,7 +33,7 @@
           "statusDetails": "",
           "hostingMode": "default",
           "provisioningState": "succeeded",
-          "publicNetworkAccess": "enabled",
+          "publicNetworkAccess": "disabled",
           "networkRuleSet": {
             "ipRules": []
           },

diff --git a/...ateServiceToAllowAccessFromCustomIPs.json → ...viceToAllowAccessFromPublicCustomIPs.json b/...ateServiceToAllowAccessFromCustomIPs.json → ...viceToAllowAccessFromPublicCustomIPs.json
@@ -8,10 +8,14 @@
       "properties": {
         "replicaCount": 3,
         "partitionCount": 1,
+        "publicNetworkAccess": "enabled",
         "networkRuleSet": {
           "ipRules": [
             {
-              "value": "10.2.3.4"
+              "value": "123.4.5.6"
+            },
+            {
+              "value": "123.4.6.0/18"
             }
           ]
         }

diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json
@@ -344,6 +344,12 @@
           "SearchCreateOrUpdateService": {
             "$ref": "./examples/SearchCreateOrUpdateService.json"
           },
+          "SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs": {
+            "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json"
+          },
+          "SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints": {
+            "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json"
+          },
           "SearchCreateOrUpdateServiceWithIdentity": {
             "$ref": "./examples/SearchCreateOrUpdateServiceWithIdentity.json"
           }
@@ -416,8 +422,8 @@
           "SearchUpdateServiceToRemoveIdentity": {
             "$ref": "./examples/SearchUpdateServiceToRemoveIdentity.json"
           },
-          "searchUpdateServiceToAllowAccessFromCustomIPs": {
-            "$ref": "./examples/SearchUpdateServiceToAllowAccessFromCustomIPs.json"
+          "searchUpdateServiceToAllowAccessFromPublicCustomIPs": {
+            "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json"
           },
           "searchUpdateServiceToAllowAccessFromPrivateEndpoints": {
             "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json"
@@ -1350,7 +1356,7 @@
       "properties": {
         "ipRules": {
           "type": "array",
-          "description": "A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.",
+          "description": "A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.",
           "items": {
             "$ref": "#/definitions/IpRule"
           }