Merge pull request #276 from necusjz/add-example-for-ag

Update model for `az network application-gateway waf-policy custom-rule`
Azure · Aug 16, 2023 · c5eccc2 · c5eccc2
2 parents 15ea0f6 + 05c86bf
commit c5eccc2
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 29 deletions.
diff --git a/Commands/network/application-gateway/waf-policy/custom-rule/_create.md b/Commands/network/application-gateway/waf-policy/custom-rule/_create.md
@@ -36,3 +36,8 @@ Create an application gateway WAF policy custom rule.
     ```bash
         network application-gateway waf-policy custom-rule create --action Allow --name MyWafPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule
     ```
+
+- Create an application gateway WAF policy custom rule with user session identifier.
+    ```bash
+        network application-gateway waf-policy custom-rule create -g MyResourceGroup --policy-name MyPolicy -n MyRule --priority 3 --action Block --rule-type RateLimitRule --rate-limit-duration FiveMins --rate-limit-threshold 15 --group-by-user-session "[{group-by-variables:[{variable-name:GeoLocation}]}]"
+    ```
diff --git a/Commands/network/application-gateway/waf-policy/custom-rule/_update.md b/Commands/network/application-gateway/waf-policy/custom-rule/_update.md
@@ -36,3 +36,8 @@ Update an application gateway WAF policy custom rule.
     ```bash
         network application-gateway waf-policy custom-rule update --action Allow --name MyWAFPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule
     ```
+
+- Update an application gateway WAF policy custom rule with user session identifier.
+    ```bash
+        network application-gateway waf-policy custom-rule create -g MyResourceGroup --policy-name MyPolicy -n MyRule --rate-limit-duration OneMin --rate-limit-threshold 10 --group-by-user-session "[{group-by-variables:[{variable-name:ClientAddr}]}]"
+    ```
diff --git a/Commands/tree.json b/Commands/tree.json
@@ -32542,6 +32542,12 @@
                                   "network application-gateway waf-policy custom-rule create --action Allow --name MyWafPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule"
                                 ],
                                 "name": "Create an application gateway WAF policy custom rule."
+                              },
+                              {
+                                "commands": [
+                                  "network application-gateway waf-policy custom-rule create -g MyResourceGroup --policy-name MyPolicy -n MyRule --priority 3 --action Block --rule-type RateLimitRule --rate-limit-duration FiveMins --rate-limit-threshold 15 --group-by-user-session \"[{group-by-variables:[{variable-name:GeoLocation}]}]\""
+                                ],
+                                "name": "Create an application gateway WAF policy custom rule with user session identifier."
                               }
                             ],
                             "name": "2022-11-01",
@@ -32826,6 +32832,12 @@
                                   "network application-gateway waf-policy custom-rule update --action Allow --name MyWAFPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule"
                                 ],
                                 "name": "Update an application gateway WAF policy custom rule."
+                              },
+                              {
+                                "commands": [
+                                  "network application-gateway waf-policy custom-rule create -g MyResourceGroup --policy-name MyPolicy -n MyRule --rate-limit-duration OneMin --rate-limit-threshold 10 --group-by-user-session \"[{group-by-variables:[{variable-name:ClientAddr}]}]\""
+                                ],
+                                "name": "Update an application gateway WAF policy custom rule with user session identifier."
                               }
                             ],
                             "name": "2022-11-01",

diff --git a/...rL2FwcGxpY2F0aW9uZ2F0ZXdheXdlYmFwcGxpY2F0aW9uZmlyZXdhbGxwb2xpY2llcy97fQ==/2022-11-01.json b/...rL2FwcGxpY2F0aW9uZ2F0ZXdheXdlYmFwcGxpY2F0aW9uZmlyZXdhbGxwb2xpY2llcy97fQ==/2022-11-01.json
diff --git a/...JrL2FwcGxpY2F0aW9uZ2F0ZXdheXdlYmFwcGxpY2F0aW9uZmlyZXdhbGxwb2xpY2llcy97fQ==/2022-11-01.xml b/...JrL2FwcGxpY2F0aW9uZ2F0ZXdheXdlYmFwcGxpY2F0aW9uZmlyZXdhbGxwb2xpY2llcy97fQ==/2022-11-01.xml
@@ -11048,8 +11048,8 @@
             </enum>
           </arg>
         </argGroup>
-        <argGroup name="Parameters.properties.customRules[]">
-          <arg type="array<object>" var="$parameters.properties.customRules[].groupByUserSession" options="group-by-user-session" group="Parameters.properties.customRules[]">
+        <argGroup name="Properties">
+          <arg type="array<object>" var="$parameters.properties.customRules[].groupByUserSession" options="group-by-user-session" group="Properties">
             <help short="List of user session identifier group by clauses."/>
             <item type="object">
               <arg type="array<object>" var="$parameters.properties.customRules[].groupByUserSession[].groupByVariables" options="group-by-variables" required="True">
@@ -11067,18 +11067,6 @@
               </arg>
             </item>
           </arg>
-          <arg type="string" var="$parameters.properties.customRules[].rateLimitDuration" options="rate-limit-duration" group="Parameters.properties.customRules[]">
-            <help short="Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule."/>
-            <enum>
-              <item name="FiveMins" value="&quot;FiveMins&quot;"/>
-              <item name="OneMin" value="&quot;OneMin&quot;"/>
-            </enum>
-          </arg>
-          <arg type="integer32" var="$parameters.properties.customRules[].rateLimitThreshold" options="rate-limit-threshold" group="Parameters.properties.customRules[]">
-            <help short="Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1"/>
-          </arg>
-        </argGroup>
-        <argGroup name="Properties">
           <arg type="array<object>" var="$parameters.properties.customRules[].matchConditions" options="match-conditions" required="True" group="Properties">
             <help short="List of match conditions."/>
             <default value="[]"/>
@@ -11144,6 +11132,16 @@
               </arg>
             </item>
           </arg>
+          <arg type="string" var="$parameters.properties.customRules[].rateLimitDuration" options="rate-limit-duration" group="Properties">
+            <help short="Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule."/>
+            <enum>
+              <item name="FiveMins" value="&quot;FiveMins&quot;"/>
+              <item name="OneMin" value="&quot;OneMin&quot;"/>
+            </enum>
+          </arg>
+          <arg type="integer32" var="$parameters.properties.customRules[].rateLimitThreshold" options="rate-limit-threshold" group="Properties">
+            <help short="Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1"/>
+          </arg>
         </argGroup>
         <subresourceSelector var="$Subresource" ref="$Instance">
           <json type="object" name="parameters">
@@ -13757,8 +13755,8 @@
             </enum>
           </arg>
         </argGroup>
-        <argGroup name="Parameters.properties.customRules[]">
-          <arg nullable="True" type="array<object>" var="$parameters.properties.customRules[].groupByUserSession" options="group-by-user-session" group="Parameters.properties.customRules[]">
+        <argGroup name="Properties">
+          <arg nullable="True" type="array<object>" var="$parameters.properties.customRules[].groupByUserSession" options="group-by-user-session" group="Properties">
             <help short="List of user session identifier group by clauses."/>
             <item nullable="True" type="object">
               <arg type="array<object>" var="$parameters.properties.customRules[].groupByUserSession[].groupByVariables" options="group-by-variables">
@@ -13776,18 +13774,6 @@
               </arg>
             </item>
           </arg>
-          <arg nullable="True" type="string" var="$parameters.properties.customRules[].rateLimitDuration" options="rate-limit-duration" group="Parameters.properties.customRules[]">
-            <help short="Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule."/>
-            <enum>
-              <item name="FiveMins" value="&quot;FiveMins&quot;"/>
-              <item name="OneMin" value="&quot;OneMin&quot;"/>
-            </enum>
-          </arg>
-          <arg nullable="True" type="integer32" var="$parameters.properties.customRules[].rateLimitThreshold" options="rate-limit-threshold" group="Parameters.properties.customRules[]">
-            <help short="Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1"/>
-          </arg>
-        </argGroup>
-        <argGroup name="Properties">
           <arg type="array<object>" var="$parameters.properties.customRules[].matchConditions" options="match-conditions" group="Properties">
             <help short="List of match conditions."/>
             <item nullable="True" type="object">
@@ -13852,6 +13838,16 @@
               </arg>
             </item>
           </arg>
+          <arg nullable="True" type="string" var="$parameters.properties.customRules[].rateLimitDuration" options="rate-limit-duration" group="Properties">
+            <help short="Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule."/>
+            <enum>
+              <item name="FiveMins" value="&quot;FiveMins&quot;"/>
+              <item name="OneMin" value="&quot;OneMin&quot;"/>
+            </enum>
+          </arg>
+          <arg nullable="True" type="integer32" var="$parameters.properties.customRules[].rateLimitThreshold" options="rate-limit-threshold" group="Properties">
+            <help short="Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1"/>
+          </arg>
         </argGroup>
         <subresourceSelector var="$Subresource" ref="$Instance">
           <json type="object" name="parameters">