Review request v3 for Microsoft.Portal to onboard to TypeSpec

specification/portal/Dashboard.Management/Dashboard.tsp

@@ -0,0 +1,78 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@azure-tools/typespec-client-generator-core";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+
+using Azure.ClientGenerator.Core;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+using TypeSpec.Rest;
+
+namespace Microsoft.Portal;
+/**
+ * The shared dashboard resource definition.
+ */
+@doc("The shared dashboard resource definition.")
+model Dashboard
+  is Azure.ResourceManager.TrackedResource<DashboardPropertiesWithProvisioningState> {
+  ...ResourceNameParameter<
+    Resource = Dashboard,
+    KeyName = "dashboardName",
+    SegmentName = "dashboards"
+  >;
+}
+
+@armResourceOperations
+interface Dashboards {
+  /**
+   * Gets the Dashboard.
+   */
+  get is ArmResourceRead<Dashboard>;
+
+  /**
+   * Creates or updates a Dashboard.
+   */
+  createOrUpdate is ArmResourceCreateOrReplaceSync<Dashboard>;
+
+  /**
+   * Updates an existing Dashboard.
+   */
+  @parameterVisibility
+  update is ArmCustomPatchSync<Dashboard, PatchableDashboard>;
+
+  /**
+   * Deletes the Dashboard.
+   */
+  delete is ArmResourceDeleteSync<Dashboard>;
+
+  /**
+   * Gets all the Dashboards within a resource group.
+   */
+  listByResourceGroup is ArmResourceListByParent<Dashboard>;
+
+  /**
+   * Gets all the dashboards within a subscription.
+   */
+  listBySubscription is ArmListBySubscription<Dashboard>;
+}
+
+@@maxLength(Dashboard.name, 64);
+@@minLength(Dashboard.name, 3);
+@@doc(Dashboard.name, "The name of the dashboard.");
+@@doc(Dashboards.createOrUpdate::parameters.resource,
+  "The parameters required to create or update a dashboard."
+);
+@@doc(Dashboards.update::parameters.properties,
+  "The updatable fields of a Dashboard."
+);
+@@encodedName(Dashboards.createOrUpdate::parameters.resource,
+  "application/json",
+  "dashboard"
+);
+@@encodedName(Dashboards.update::parameters.properties,
+  "application/json",
+  "dashboard"
+);

specification/portal/Dashboard.Management/client.tsp

@@ -0,0 +1,8 @@
+import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+using Microsoft.Portal;
+
+#suppress "deprecated" "@flattenProperty decorator is not recommended to use."
+@@flattenProperty(PatchableDashboard.properties);

specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json → specification/portal/Dashboard.Management/examples/2020-09-01-preview/Dashboards_CreateOrUpdate.json

@@ -1,29 +1,27 @@
 {
   "parameters": {
-    "dashboardName": "testDashboard",
-    "resourceGroupName": "testRG",
     "api-version": "2020-09-01-preview",
-    "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "dashboard": {
+      "location": "eastus",
       "properties": {
         "lenses": [
           {
             "order": 1,
             "parts": [
               {
                 "position": {
-                  "x": 1,
-                  "y": 2,
+                  "colSpan": 3,
                   "rowSpan": 4,
-                  "colSpan": 3
+                  "x": 1,
+                  "y": 2
                 }
               },
               {
                 "position": {
-                  "x": 5,
-                  "y": 5,
+                  "colSpan": 6,
                   "rowSpan": 6,
-                  "colSpan": 6
+                  "x": 5,
+                  "y": 5
                 }
               }
             ]
@@ -35,42 +33,48 @@
         ],
         "metadata": {
           "metadata": {
-            "X": 4,
-            "Y": 3,
+            "ColSpan": 2,
             "RowSpan": 1,
-            "ColSpan": 2
+            "X": 4,
+            "Y": 3
           }
         }
       },
-      "location": "eastus",
       "tags": {
         "aKey": "aValue",
         "anotherKey": "anotherValue"
       }
-    }
+    },
+    "dashboardName": "testDashboard",
+    "resourceGroupName": "testRG",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000"
   },
   "responses": {
-    "201": {
+    "200": {
       "body": {
+        "name": "testDashboard",
+        "type": "Microsoft.Portal/dashboards",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
+        "location": "eastus",
         "properties": {
           "lenses": [
             {
               "order": 1,
               "parts": [
                 {
                   "position": {
-                    "x": 1,
-                    "y": 2,
+                    "colSpan": 3,
                     "rowSpan": 4,
-                    "colSpan": 3
+                    "x": 1,
+                    "y": 2
                   }
                 },
                 {
                   "position": {
-                    "x": 5,
-                    "y": 5,
+                    "colSpan": 6,
                     "rowSpan": 6,
-                    "colSpan": 6
+                    "x": 5,
+                    "y": 5
                   }
                 }
               ]
@@ -82,44 +86,44 @@
           ],
           "metadata": {
             "metadata": {
-              "X": 4,
-              "Y": 3,
+              "ColSpan": 2,
               "RowSpan": 1,
-              "ColSpan": 2
+              "X": 4,
+              "Y": 3
             }
           }
         },
-        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
-        "name": "testDashboard",
-        "type": "Microsoft.Portal/dashboards",
-        "location": "eastus",
         "tags": {
           "aKey": "aValue",
           "anotherKey": "anotherValue"
         }
       }
     },
-    "200": {
+    "201": {
       "body": {
+        "name": "testDashboard",
+        "type": "Microsoft.Portal/dashboards",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
+        "location": "eastus",
         "properties": {
           "lenses": [
             {
               "order": 1,
               "parts": [
                 {
                   "position": {
-                    "x": 1,
-                    "y": 2,
+                    "colSpan": 3,
                     "rowSpan": 4,
-                    "colSpan": 3
+                    "x": 1,
+                    "y": 2
                   }
                 },
                 {
                   "position": {
-                    "x": 5,
-                    "y": 5,
+                    "colSpan": 6,
                     "rowSpan": 6,
-                    "colSpan": 6
+                    "x": 5,
+                    "y": 5
                   }
                 }
               ]
@@ -131,22 +135,20 @@
           ],
           "metadata": {
             "metadata": {
-              "X": 4,
-              "Y": 3,
+              "ColSpan": 2,
               "RowSpan": 1,
-              "ColSpan": 2
+              "X": 4,
+              "Y": 3
             }
           }
         },
-        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
-        "name": "testDashboard",
-        "type": "Microsoft.Portal/dashboards",
-        "location": "eastus",
         "tags": {
           "aKey": "aValue",
           "anotherKey": "anotherValue"
         }
       }
     }
-  }
+  },
+  "operationId": "Dashboards_CreateOrUpdate",
+  "title": "Create or update a Dashboard"
 }

specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json → specification/portal/Dashboard.Management/examples/2020-09-01-preview/Dashboards_Delete.json

@@ -1,12 +1,14 @@
 {
   "parameters": {
+    "api-version": "2020-09-01-preview",
     "dashboardName": "testDashboard",
     "resourceGroupName": "testRG",
-    "api-version": "2020-09-01-preview",
     "subscriptionId": "00000000-0000-0000-0000-000000000000"
   },
   "responses": {
     "200": {},
     "204": {}
-  }
+  },
+  "operationId": "Dashboards_Delete",
+  "title": "Delete a Dashboard"
 }

specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json → specification/portal/Dashboard.Management/examples/2020-09-01-preview/Dashboards_Get.json

@@ -1,32 +1,36 @@
 {
   "parameters": {
+    "api-version": "2020-09-01-preview",
     "dashboardName": "testDashboard",
     "resourceGroupName": "testRG",
-    "api-version": "2020-09-01-preview",
     "subscriptionId": "00000000-0000-0000-0000-000000000000"
   },
   "responses": {
     "200": {
       "body": {
+        "name": "testDashboard",
+        "type": "Microsoft.Portal/dashboards",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
+        "location": "eastus",
         "properties": {
           "lenses": [
             {
               "order": 1,
               "parts": [
                 {
                   "position": {
-                    "x": 1,
-                    "y": 2,
+                    "colSpan": 3,
                     "rowSpan": 4,
-                    "colSpan": 3
+                    "x": 1,
+                    "y": 2
                   }
                 },
                 {
                   "position": {
-                    "x": 5,
-                    "y": 5,
+                    "colSpan": 6,
                     "rowSpan": 6,
-                    "colSpan": 6
+                    "x": 5,
+                    "y": 5
                   }
                 }
               ]
@@ -38,23 +42,20 @@
           ],
           "metadata": {
             "metadata": {
-              "X": 4,
-              "Y": 3,
+              "ColSpan": 2,
               "RowSpan": 1,
-              "ColSpan": 2
+              "X": 4,
+              "Y": 3
             }
           }
         },
-        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard",
-        "name": "testDashboard",
-        "type": "Microsoft.Portal/dashboards",
-        "location": "eastus",
         "tags": {
           "aKey": "aValue",
           "anotherKey": "anotherValue"
         }
       }
-    },
-    "404": {}
-  }
+    }
+  },
+  "operationId": "Dashboards_Get",
+  "title": "Get a Dashboard"
 }