DataBoxEdge Swagger API Review- 2021-02-01 (#14921)

* Initial Commit with previously reviewed Changes * Updated Swagger * Added Example files * Updated Description for the APIs which are in private preview * Updated ReadmeFiles * Fixed folder structure * fixed json example references * Fixed supportPackage and Proactivelogcollection jsons * Fixed Prettier check * Fixed Prettier check * Fixed Azure-auth * Fixing UpdateDiagnosticRemoteSupportSettings.json Go Validations * Fixed Model Validation * Fix Model Validation + Prettier Check * Fixed Model Validation * Swagger LinterValidation Fix * Removed Type from UpdateDiagnosticProactiveLogCollectionSettings.json, failing Model Validation * Updated all the example files * fixed comments * Updated corresponding examples * Fixed Validation * Updated the tag to the latest * Fixed the tag Co-authored-by: Arzoo Jain <arja@microsoft.com>
Azure · Jul 12, 2021 · cb835f4 · cb835f4
1 parent 9705c35
commit cb835f4
Show file tree

Hide file tree

Showing 81 changed files with 12,836 additions and 1 deletion.
diff --git a/...ion/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json b/...ion/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json
diff --git a/...taboxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGet.json b/...taboxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGet.json
@@ -0,0 +1,37 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+          "alertType": "UpdateScanFailedEvent",
+          "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+          "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+          "severity": "Critical",
+          "errorDetails": {
+            "errorCode": "",
+            "errorMessage": "",
+            "occurrences": 1
+          },
+          "detailedInformation": {}
+        },
+        "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+        "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+        "type": "dataBoxEdgeDevices/alerts"
+      }
+    }
+  }
+}
diff --git a/...esource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGetAllInDevice.json b/...esource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGetAllInDevice.json
@@ -0,0 +1,58 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "properties": {
+              "title": "Device password has changed",
+              "alertType": "PasswordChangedEvent",
+              "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z",
+              "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.",
+              "severity": "Informational",
+              "errorDetails": {
+                "errorCode": "",
+                "errorMessage": "",
+                "occurrences": 2
+              },
+              "detailedInformation": {}
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790",
+            "name": "83eccd0b-134b-40b0-ad62-b5f124d03790",
+            "type": "dataBoxEdgeDevices/alerts"
+          },
+          {
+            "properties": {
+              "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+              "alertType": "UpdateScanFailedEvent",
+              "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+              "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+              "severity": "Critical",
+              "errorDetails": {
+                "errorCode": "",
+                "errorMessage": "",
+                "occurrences": 1
+              },
+              "detailedInformation": {}
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+            "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+            "type": "dataBoxEdgeDevices/alerts"
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/.../resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AvailableSkusList.json b/.../resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AvailableSkusList.json
@@ -0,0 +1,38 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "location": "westus",
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "resourceType": "dataBoxEdgeDevices",
+            "name": "Gateway",
+            "availability": "Available",
+            "tier": "Standard",
+            "kind": "AzureDataBoxGateway",
+            "version": "Stable",
+            "signupOption": "Available",
+            "locations": [
+              "West US"
+            ],
+            "locationInfo": [
+              {
+                "location": "West US"
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...rce-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleDelete.json b/...rce-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleDelete.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "name": "bandwidth-1",
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {},
+    "202": {},
+    "204": {}
+  }
+}
diff --git a/...source-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGet.json b/...source-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGet.json
@@ -0,0 +1,30 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "name": "bandwidth-1",
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "start": "00:00:00",
+          "stop": "13:59:00",
+          "rateInMbps": 100,
+          "days": [
+            "Sunday",
+            "Monday"
+          ]
+        },
+        "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+        "name": "bandwidth-1",
+        "type": "dataBoxEdgeDevices/bandwidthSchedules"
+      }
+    }
+  }
+}
diff --git a/...ger/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGetAllInDevice.json b/...ger/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGetAllInDevice.json
@@ -0,0 +1,33 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "properties": {
+              "start": "00:00:00",
+              "stop": "13:59:00",
+              "rateInMbps": 100,
+              "days": [
+                "Sunday",
+                "Monday"
+              ]
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+            "name": "bandwidth-1",
+            "type": "dataBoxEdgeDevices/bandwidthSchedules"
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...source-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthSchedulePut.json b/...source-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthSchedulePut.json
@@ -0,0 +1,51 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "name": "bandwidth-1",
+    "Content-Type": [
+      "application/json; charset=utf-8"
+    ],
+    "Content-Length": [
+      "200"
+    ],
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ],
+    "parameters": {
+      "properties": {
+        "start": "0:0:0",
+        "stop": "13:59:0",
+        "rateInMbps": 100,
+        "days": [
+          "Sunday",
+          "Monday"
+        ]
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "start": "00:00:00",
+          "stop": "13:59:00",
+          "rateInMbps": 100,
+          "days": [
+            "Sunday",
+            "Monday"
+          ]
+        },
+        "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+        "name": "bandwidth-1",
+        "type": "dataBoxEdgeDevices/bandwidthSchedules"
+      }
+    },
+    "202": {}
+  }
+}
diff --git a/...ge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerDelete.json b/...ge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerDelete.json
@@ -0,0 +1,20 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "storageAccountName": "storageaccount1",
+    "containerName": "blobcontainer1",
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "202": {},
+    "204": {}
+  }
+}
diff --git a/...xedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerGet.json b/...xedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerGet.json
@@ -0,0 +1,28 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "storageAccountName": "storageaccount1",
+    "containerName": "blobcontainer1",
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "containerStatus": "OK",
+          "dataFormat": "BlockBlob",
+          "refreshDetails": {},
+          "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+        },
+        "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1",
+        "name": "blobcontainer1",
+        "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+      }
+    }
+  }
+}
diff --git a/...ce-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerListAllInDevice.json b/...ce-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerListAllInDevice.json
@@ -0,0 +1,56 @@
+{
+  "parameters": {
+    "api-version": "2021-02-01",
+    "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+    "resourceGroupName": "GroupForEdgeAutomation",
+    "deviceName": "testedgedevice",
+    "storageAccountName": "storageaccount1",
+    "x-ms-client-request-id": [
+      "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+    ],
+    "accept-language": [
+      "en-US"
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "properties": {
+              "containerStatus": "OK",
+              "dataFormat": "BlockBlob",
+              "refreshDetails": {},
+              "createdDateTime": "2019-10-20T23:14:32.3016929Z"
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1",
+            "name": "blobcontainer1",
+            "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+          },
+          {
+            "properties": {
+              "containerStatus": "OK",
+              "dataFormat": "BlockBlob",
+              "refreshDetails": {},
+              "createdDateTime": "2019-10-20T23:15:38.0077675Z"
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2",
+            "name": "blobcontainer2",
+            "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+          },
+          {
+            "properties": {
+              "containerStatus": "OK",
+              "dataFormat": "BlockBlob",
+              "refreshDetails": {},
+              "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+            },
+            "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3",
+            "name": "blobcontainer3",
+            "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+          }
+        ]
+      }
+    }
+  }
+}