Replace IpRangeFilter by IpRules

00Kai0 · May 4, 2020 · ddb2135 · ddb2135
1 parent fcc7010
commit ddb2135
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 21 deletions.
diff --git a/...fication/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-05-04/cosmos-db.json b/...fication/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-05-04/cosmos-db.json
@@ -5094,9 +5094,9 @@
           "readOnly": true,
           "$ref": "#/definitions/DatabaseAccountOfferType"
         },
-        "ipRangeFilter": {
-          "description": "Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.",
-          "$ref": "#/definitions/IPRangeFilter"
+        "ipRules": {
+          "description": "List of IpRules.",
+          "$ref": "#/definitions/IPRules"
         },
         "isVirtualNetworkFilterEnabled": {
           "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.",
@@ -5212,9 +5212,9 @@
           "description": "The offer type for the database",
           "$ref": "#/definitions/DatabaseAccountOfferType"
         },
-        "ipRangeFilter": {
-          "description": "Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.",
-          "$ref": "#/definitions/IPRangeFilter"
+        "ipRules": {
+          "description": "List of IpRules.",
+          "$ref": "#/definitions/IPRules"
         },
         "isVirtualNetworkFilterEnabled": {
           "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.",
@@ -5318,9 +5318,9 @@
             "$ref": "#/definitions/Location"
           }
         },
-        "ipRangeFilter": {
-          "description": "Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.",
-          "$ref": "#/definitions/IPRangeFilter"
+        "ipRules": {
+          "description": "List of IpRules.",
+          "$ref": "#/definitions/IPRules"
         },
         "isVirtualNetworkFilterEnabled": {
           "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.",
@@ -6715,9 +6715,16 @@
       "readOnly": true,
       "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed."
     },
-    "IPRangeFilter": {
+    "IPRules": {
+      "type": "array",
+      "description": "Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account.",
+      "items": {
+        "$ref": "#/definitions/IpAddressOrRange"
+      }
+    },
+    "IpAddressOrRange": {
       "type": "string",
-      "description": "Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces."
+      "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”."
     },
     "VirtualNetworkRule": {
       "type": "object",

diff --git a/...ger/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountCreateMax.json b/...ger/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountCreateMax.json
@@ -10,7 +10,14 @@
       "kind": "GlobalDocumentDB",
       "properties": {
         "databaseAccountOfferType": "Standard",
-        "ipRangeFilter": "10.10.10.10",
+        "ipRules": [
+          {
+            "ipAddressOrRange": "23.43.230.120"
+          },
+          {
+            "ipAddressOrRange": "110.12.240.0/12"
+          }
+        ],
         "isVirtualNetworkFilterEnabled": true,
         "virtualNetworkRules": [
           {
@@ -51,7 +58,6 @@
         "tags": {},
         "properties": {
           "provisioningState": "Initializing",
-          "ipRangeFilter": "10.10.10.10",
           "isVirtualNetworkFilterEnabled": true,
           "databaseAccountOfferType": "Standard",
           "disableKeyBasedMetadataWriteAccess": false,
@@ -119,7 +125,15 @@
             }
           ],
           "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
-          "enableFreeTier": false
+          "enableFreeTier": false,
+          "ipRules": [
+            {
+              "ipAddressOrRange": "23.43.230.120"
+            },
+            {
+              "ipAddressOrRange": "110.12.240.0/12"
+            }
+          ]
         }
       }
     }

diff --git a/...ger/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountCreateMin.json b/...ger/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountCreateMin.json
@@ -29,7 +29,7 @@
         "tags": {},
         "properties": {
           "provisioningState": "Initializing",
-          "ipRangeFilter": "",
+          "ipRules": [],
           "databaseAccountOfferType": "Standard",
           "disableKeyBasedMetadataWriteAccess": false,
           "consistencyPolicy": {

diff --git a/...e-manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountGet.json b/...e-manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountGet.json
@@ -17,7 +17,7 @@
         "properties": {
           "provisioningState": "Succeeded",
           "documentEndpoint": "https://ddb1.documents.azure.com:443/",
-          "ipRangeFilter": "",
+          "ipRules": [],
           "isVirtualNetworkFilterEnabled": false,
           "virtualNetworkRules": [],
           "databaseAccountOfferType": "Standard",

diff --git a/...-manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountList.json b/...-manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountList.json
@@ -17,7 +17,7 @@
             "properties": {
               "provisioningState": "Succeeded",
               "documentEndpoint": "https://ddb1.documents.azure.com:443/",
-              "ipRangeFilter": "",
+              "ipRules": [],
               "databaseAccountOfferType": "Standard",
               "disableKeyBasedMetadataWriteAccess": false,
               "consistencyPolicy": {

diff --git a/...oft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountListByResourceGroup.json b/...oft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountListByResourceGroup.json
@@ -18,7 +18,7 @@
             "properties": {
               "provisioningState": "Succeeded",
               "documentEndpoint": "https://ddb1.documents.azure.com:443/",
-              "ipRangeFilter": "",
+              "ipRangeFilter": [],
               "databaseAccountOfferType": "Standard",
               "disableKeyBasedMetadataWriteAccess": false,
               "consistencyPolicy": {

diff --git a/...manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountPatch.json b/...manager/Microsoft.DocumentDB/stable/2020-05-04/examples/CosmosDBDatabaseAccountPatch.json
@@ -10,7 +10,11 @@
         "dept": "finance"
       },
       "properties": {
-        "ipRangeFilter": "10.10.10.10",
+        "ipRules": [
+          {
+            "ipAddressOrRange": "10.10.10.10"
+          }
+        ],
         "isVirtualNetworkFilterEnabled": true,
         "virtualNetworkRules": [
           {
@@ -42,7 +46,11 @@
           "provisioningState": "Succeeded",
           "documentEndpoint": "https://ddb1.documents.azure.com:443/",
           "databaseAccountOfferType": "Standard",
-          "ipRangeFilter": "10.10.10.10",
+          "ipRules": [
+            {
+              "ipAddressOrRange": "10.10.10.10"
+            }
+          ],
           "isVirtualNetworkFilterEnabled": true,
           "disableKeyBasedMetadataWriteAccess": false,
           "consistencyPolicy": {

diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md
@@ -27,7 +27,19 @@ These are the global settings for the Cosmos-DB API.
 ``` yaml
 title: CosmosDBManagementClient
 openapi-type: arm
-tag: package-2020-03
+tag: package-2020-05
+```
+
+### Tag: package-2020-05
+
+These settings apply only when `--tag=package-2020-05` is specified on the command line.
+
+``` yaml $(tag) == 'package-2020-05'
+input-file:
+- Microsoft.DocumentDB/stable/2020-05-04/cosmos-db.json
+- Microsoft.DocumentDB/stable/2020-05-04/notebook.json
+- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
+- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
 ```
 
 ### Tag: package-2020-03