Yunhe/cdn 2021 06 01 (#8)

* add forwardingProtocol to OriginGroupOverride * added new cache behavior attributes and case transform enum values * update cache behavior * update route and route configuration override rule swagger definition * update * made changes to route and rule to remove EnableCache filed. To disable cache, leave CacheConfiguration to null. * add cache duration to route * update routeConfigOverride action * update route and action * update action swagger * update swagger spec * update examples * update comments * updated examples
Azure · weidongxu-microsoft · Dec 18, 2021 · Apr 27, 2021 · Apr 27, 2021 · Apr 27, 2021
commit 742488957188d9f9c1b11ab4f60b52d82489cf44
@@ -2243,6 +2243,9 @@
           "200": {
             "description": "Delete successful."
           },
+          "202": {
+            "description": "Accepted"
+          },
           "204": {
             "description": "No Content. The request has been accepted but the rule set was not found."
           },
@@ -4034,13 +4037,13 @@
       "description": "Customer Certificate used for https",
       "allOf": [
         {
-          "$ref": "#/definitions/Certificate",
+          "$ref": "#/definitions/Certificate"
         }
       ],
       "properties": {
         "secretSource": {
           "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}",
-          "$ref": "./cdn.json#/definitions/ResourceReference",
+          "$ref": "./cdn.json#/definitions/ResourceReference"
         },
         "secretVersion": {
           "description": "Certificate version.",
@@ -5057,14 +5060,10 @@
             "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path."
           }
         },
-        "enableCache": {
-          "description": "A boolean field for enable or disable cache. If enableCache is true, cacheConfiguration cannot be null.",
-          "type": "boolean"
-        },
         "cacheConfiguration": {
-          "description": "The caching configuration for this route.",
+          "description": "The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.",
           "type": "object",
-          "$ref": "./cdn.json#/definitions/CacheConfiguration"
+          "$ref": "#/definitions/CacheConfiguration"
         },
         "forwardingProtocol": {
           "description": "Protocol this rule will use when forwarding traffic to backends.",
@@ -5117,6 +5116,37 @@
         }
       }
     },
+    "CacheConfiguration": {
+      "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.",
+      "type": "object",
+      "properties": {
+        "queryStringCachingBehavior": {
+          "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.",
+          "enum": [
+            "IgnoreQueryString",
+            "UseQueryString",
+            "IgnoreSpecifiedQueryStrings",
+            "IncludeSpecifiedQueryStrings"
+          ],
+          "type": "string",
+          "x-ms-enum": {
+            "name": "afdQueryStringCachingBehavior",
+            "modelAsString": true
+          }
+        },
+        "queryParameters": {
+          "description": "query parameters to include or exclude (comma separated).",
+          "type": "string"
+        },
+        "compressionSettings": {
+          "description": "compression settings.",
+          "type": "object",
+          "items": {
+            "$ref": "#/definitions/CompressionSettings"
+          }
+        }
+      }
+    },
     "RuleListResult": {
       "description": "Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.",
       "properties": {

@@ -3779,13 +3779,13 @@
           "enum": [
             "CacheExpiration",
             "CacheKeyQueryString",
-            "ModifyCacheConfiguration",
             "ModifyRequestHeader",
             "ModifyResponseHeader",
             "UrlRedirect",
             "UrlRewrite",
             "UrlSigning",
-            "OriginGroupOverride"
+            "OriginGroupOverride",
+            "RouteConfigurationOverride"
           ],
           "x-ms-enum": {
             "name": "DeliveryRuleAction",
@@ -3981,19 +3981,6 @@
           "description": "defines the OriginGroup that would override the DefaultOriginGroup.",
           "type": "object",
           "$ref": "#/definitions/ResourceReference"
-        },
-        "forwardingProtocol": {
-          "description": "Protocol this rule will use when forwarding traffic to backends.",
-          "type": "object",
-          "enum": [
-            "HttpOnly",
-            "HttpsOnly",
-            "MatchRequest"
-          ],
-          "x-ms-enum": {
-            "name": "ForwardingProtocol",
-            "modelAsString": true
-          }
         }
       }
     },
@@ -4231,9 +4218,9 @@
         }
       }
     },
-    "DeliveryRuleCacheConfigurationAction": {
-      "description": "Defines the cache configuration action for the delivery rule. Only applicable to AFDX - need to update this later",
-      "x-ms-discriminator-value": "ModifyCacheConfiguration",
+    "DeliveryRuleRouteConfigurationOverrideAction": {
+      "description": "Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.",
+      "x-ms-discriminator-value": "RouteConfigurationOverride",
       "allOf": [
         {
           "$ref": "#/definitions/DeliveryRuleAction"
@@ -4245,12 +4232,12 @@
       "properties": {
         "parameters": {
           "description": "Defines the parameters for the action.",
-          "$ref": "#/definitions/CacheConfigurationActionParameters"
+          "$ref": "#/definitions/RouteConfigurationOverrideActionParameters"
         }
       }
     },
-    "CacheConfigurationActionParameters": {
-      "description": "Defines the parameters for the cache configuration action. To disable caching, do not provide a cacheConfiguration object.",
+    "RouteConfigurationOverrideActionParameters": {
+      "description": "Defines the parameters for the route configuration override action.",
       "required": [
         "typeName"
       ],
@@ -4261,38 +4248,75 @@
             "DeliveryRuleCacheConfigurationActionParameters"
           ]
         },
-        "enableCache": {
-          "description": "A boolean field for enable or disable cache. If enableCache is true, cacheConfiguration cannot be null.",
-          "type": "boolean"
+        "originGroupOverride": {
+          "description": "A reference to the origin group override configuration. Leave empty to use the default origin group on route.",
+          "type": "object",
+          "$ref": "#/definitions/OriginGroupOverride"
         },
         "cacheConfiguration": {
-          "description": "The caching configuration associated with this rule.",
+          "description": "The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.",
+          "type": "object",
           "$ref": "#/definitions/CacheConfiguration"
         }
       }
     },
+    "OriginGroupOverride": {
+      "description": "Defines the parameters for the origin group override configuration.",
+      "properties": {
+        "originGroup": {
+          "description": "defines the OriginGroup that would override the DefaultOriginGroup on route.",
+          "type": "object",
+          "$ref": "#/definitions/ResourceReference"
+        },
+        "forwardingProtocol": {
+          "description": "Protocol this rule will use when forwarding traffic to backends.",
+          "type": "object",
+          "enum": [
+            "HttpOnly",
+            "HttpsOnly",
+            "MatchRequest"
+          ],
+          "x-ms-enum": {
+            "name": "ForwardingProtocol",
+            "modelAsString": true
+          }
+        }
+      }
+    },
     "CacheConfiguration": {
       "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.",
       "type": "object",
       "properties": {
         "queryStringCachingBehavior": {
-          "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.",
+          "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.",
           "enum": [
-            "IgnoreQueryStrings",
-            "CacheEveryUniqueUrl",
+            "IgnoreQueryString",
+            "UseQueryString",
             "IgnoreSpecifiedQueryStrings",
             "IncludeSpecifiedQueryStrings"
           ],
           "type": "string",
           "x-ms-enum": {
-            "name": "afdQueryStringCachingBehavior",
+            "name": "ruleQueryStringCachingBehavior",
             "modelAsString": true
           }
         },
         "queryParameters": {
           "description": "query parameters to include or exclude (comma separated).",
           "type": "string"
         },
+        "IsCompressionEnabled": {
+          "description": "Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.",
+          "type": "string",
+          "enum": [
+            "Enabled",
+            "Disabled"
+          ],
+          "x-ms-enum": {
+            "name": "ruleIsCompressionEnabled",
+            "modelAsString": true
+          }
+        },
         "cacheBehavior": {
           "description": "Caching behavior for the requests",
           "type": "string",
@@ -4302,31 +4326,14 @@
             "OverrideIfOriginMissing"
           ],
           "x-ms-enum": {
-            "name": "cacheBehavior",
+            "name": "ruleCacheBehavior",
             "modelAsString": true
           }
         },
         "cacheDuration": {
           "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss",
           "type": "string",
           "format": "duration"
-        },
-        "compressionSettings": {
-          "description": "settings for compression.",
-          "type": "object",
-          "properties": {
-            "contentTypesToCompress": {
-              "description": "List of content types on which compression applies. The value should be a valid MIME type.",
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "isCompressionEnabled": {
-              "description": "Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.",
-              "type": "boolean"
-            }
-          }
         }
       }
     },

@@ -29,14 +29,17 @@
         "patternsToMatch": [
           "/*"
         ],
-        "compressionSettings": {
-          "contentTypesToCompress": [
-            "text/html",
-            "application/octet-stream"
-          ],
-          "isCompressionEnabled": true
+        "cacheConfiguration":{
+          "compressionSettings": {
+            "contentTypesToCompress": [
+              "text/html",
+              "application/octet-stream"
+            ],
+            "isCompressionEnabled": true
+          },
+          "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings",
+          "queryParameters": "querystring=test"
         },
-        "queryStringCachingBehavior": "IgnoreQueryString",
         "forwardingProtocol": "MatchRequest",
         "linkToDefaultDomain": "Enabled",
         "httpsRedirect": "Enabled",
@@ -72,14 +75,17 @@
           "patternsToMatch": [
             "/*"
           ],
-          "compressionSettings": {
-            "contentTypesToCompress": [
-              "text/html",
-              "application/octet-stream"
-            ],
-            "isCompressionEnabled": true
+          "cacheConfiguration":{
+            "compressionSettings": {
+              "contentTypesToCompress": [
+                "text/html",
+                "application/octet-stream"
+              ],
+              "isCompressionEnabled": true
+            },
+            "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings",
+            "queryParameters": "querystring=test"
           },
-          "queryStringCachingBehavior": "IgnoreQueryString",
           "forwardingProtocol": "MatchRequest",
           "linkToDefaultDomain": "Enabled",
           "httpsRedirect": "Enabled",
@@ -116,19 +122,22 @@
           "patternsToMatch": [
             "/*"
           ],
-          "compressionSettings": {
-            "contentTypesToCompress": [
-              "text/html",
-              "application/octet-stream"
-            ],
-            "isCompressionEnabled": true
+          "cacheConfiguration":{
+            "compressionSettings": {
+              "contentTypesToCompress": [
+                "text/html",
+                "application/octet-stream"
+              ],
+              "isCompressionEnabled": true
+            },
+            "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings",
+            "queryParameters": "querystring=test"
           },
-          "queryStringCachingBehavior": "IgnoreQueryString",
           "forwardingProtocol": "MatchRequest",
           "linkToDefaultDomain": "Enabled",
           "httpsRedirect": "Enabled",
           "enabledState": "Enabled",
-          "provisioningState": "Creating",
+          "provisioningState": "Succeeded",
           "deploymentStatus": "NotStarted"
         }
       }
@@ -160,14 +169,17 @@
           "patternsToMatch": [
             "/*"
           ],
-          "compressionSettings": {
-            "contentTypesToCompress": [
-              "text/html",
-              "application/octet-stream"
-            ],
-            "isCompressionEnabled": true
+          "cacheConfiguration":{
+            "compressionSettings": {
+              "contentTypesToCompress": [
+                "text/html",
+                "application/octet-stream"
+              ],
+              "isCompressionEnabled": true
+            },
+            "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings",
+            "queryParameters": "querystring=test"
           },
-          "queryStringCachingBehavior": "IgnoreQueryString",
           "forwardingProtocol": "MatchRequest",
           "linkToDefaultDomain": "Enabled",
           "httpsRedirect": "Enabled",

@@ -35,14 +35,17 @@
           "patternsToMatch": [
             "/*"
           ],
-          "compressionSettings": {
-            "contentTypesToCompress": [
-              "text/html",
-              "application/octet-stream"
-            ],
-            "isCompressionEnabled": true
+          "cacheConfiguration":{
+            "compressionSettings": {
+              "contentTypesToCompress": [
+                "text/html",
+                "application/octet-stream"
+              ],
+              "isCompressionEnabled": true
+            },
+            "queryStringCachingBehavior": "IgnoreQueryString",
+            "queryParameters": null
           },
-          "queryStringCachingBehavior": "IgnoreQueryString",
           "forwardingProtocol": "MatchRequest",
           "linkToDefaultDomain": "Enabled",
           "httpsRedirect": "Enabled",