Apiscenario auth (#20589)

* define authentication

* remove shareScope support

* support overriding operationId

* align with autorest auth options

Author: leniatgh

documentation/api-scenario/references/ApiScenarioDefinition.md

@@ -81,7 +81,6 @@ It defines one API scenario that could go through on its own.
 ```yaml
 scenario: quickStart
 description: Quick start with AppConfiguration ConfigurationStores
-shareScope: true
 steps:
   - step: Operations_CheckNameAvailability
     operationId: Operations_CheckNameAvailability
@@ -101,13 +100,6 @@ variables:
 - **description**
   - **Type:** Optional, String
   - Description for this API scenario.
-- **shareScope**
-  - **Type:** Optional, Boolean or String
-  - **Default:** true
-  - Describe how the scope (ResourceGroup if scope is ResourceGroup) could be shared with other scenarios.  If true or the same string value for different API scenario, they share the same scope, which means:
-    - These API scenarios will run under the same scope (e.g. ResourceGroup).
-    - **prepareSteps** and **cleanUpSteps** will run only once in the scope. The variables will be shared.
-  - By default all the API scenario in one definition file will be launched in the same scope.  If shareScope is false, the API scenarios will not share anything with others in the same file.
 - **variables**
   - **Type:** Optional, Map of Strings or Variables
   - See [Variables](./Variables.md)

documentation/api-scenario/references/v1.2/schema.json

@@ -12,6 +12,9 @@
       ],
       "default": "ResourceGroup"
     },
+    "authentication": {
+      "$ref": "#/definitions/Authentication"
+    },
     "variables": {
       "$ref": "#/definitions/Variables"
     },
@@ -47,6 +50,82 @@
       "type": "string",
       "pattern": "^[A-Za-z_$][A-Za-z0-9_-]*$"
     },
+    "Authentication": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "AADToken",
+            "AzureKey",
+            "None"
+          ],
+          "default": "AADToken"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "AADToken"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "type": {},
+              "scope": {
+                "type": "string",
+                "description": "The resource identifier (application ID URI) of the resource you want, affixed with the .default suffix",
+                "examples": [
+                  "https://management.azure.com/.default",
+                  "https://storage.azure.com/.default"
+                ]
+              }
+            },
+            "required": [
+              "scope"
+            ],
+            "additionalProperties": false
+          },
+          "else": {
+            "if": {
+              "properties": {
+                "type": {
+                  "const": "AzureKey"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "type": {},
+                "key": {
+                  "type": "string"
+                },
+                "headerName": {
+                  "type": "string",
+                  "default": "Authorization"
+                }
+              },
+              "required": [
+                "key"
+              ],
+              "additionalProperties": false
+            },
+            "else": {
+              "properties": {
+                "type": {}
+              },
+              "additionalProperties": false
+            }
+          }
+        }
+      ]
+    },
     "JsonPointer": {
       "type": "string",
       "description": "JSON Pointer described by RFC 6901, e.g. /foo/bar",
@@ -274,14 +353,13 @@
           "type": "string",
           "description": "A long description of the scenario"
         },
+        "authentication": {
+          "$ref": "#/definitions/Authentication",
+          "description": "Authentication method to use for the scenario"
+        },
         "variables": {
           "$ref": "#/definitions/Variables"
         },
-        "shareScope": {
-          "type": "boolean",
-          "description": "Whether to share the scope and prepareSteps with other scenarios",
-          "default": true
-        },
         "steps": {
           "type": "array",
           "items": {
@@ -334,6 +412,9 @@
         }
       ],
       "properties": {
+        "authentication": {
+          "$ref": "#/definitions/Authentication"
+        },
         "outputVariables": {
           "type": "object",
           "propertyNames": {
@@ -416,6 +497,7 @@
         },
         "step": {},
         "description": {},
+        "authentication": {},
         "variables": {},
         "outputVariables": {}
       },
@@ -436,6 +518,13 @@
           "type": "string",
           "format": "uri-reference"
         },
+        "operationId": {
+          "type": "string"
+        },
+        "readmeTag": {
+          "type": "string",
+          "format": "uri-reference"
+        },
         "requestUpdate": {
           "type": "array",
           "description": "Update request parameters",
@@ -454,6 +543,7 @@
         },
         "step": {},
         "description": {},
+        "authentication": {},
         "variables": {},
         "outputVariables": {}
       },