{ "uuid": "5f182e97-a595-4230-a22a-c55195f0d1c2", "lastMigration": 29, "name": "DataBoxEdgeManagementClient", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "3c1f9d94-0223-4a8e-8e8a-fa8c472b2258", "documentation": "List all the supported operations.", "method": "get", "endpoint": "providers/Microsoft.DataBoxEdge/operations", "responses": [ { "uuid": "65097776-9c0c-42c3-b934-ba34060b5c3e", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"display\": {\n \"description\": \"\",\n \"operation\": \"\",\n \"provider\": \"\",\n \"resource\": \"\"\n },\n \"name\": \"\",\n \"origin\": \"\",\n \"properties\": {\n \"serviceSpecification\": {\n \"metricSpecifications\": [\n {\n \"aggregationType\": \"{{oneOf (array 'NotSpecified' 'None' 'Average' 'Minimum' 'Maximum' 'Total' 'Count')}}\",\n \"category\": \"{{oneOf (array 'Capacity' 'Transaction')}}\",\n \"dimensions\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"toBeExportedForShoebox\": {{faker 'datatype.boolean'}}\n }\n ],\n \"displayDescription\": \"\",\n \"displayName\": \"\",\n \"fillGapWithZero\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"resourceIdDimensionNameOverride\": \"\",\n \"supportedAggregationTypes\": [\n \"{{oneOf (array 'NotSpecified' 'None' 'Average' 'Minimum' 'Maximum' 'Total' 'Count')}}\"\n ],\n \"supportedTimeGrainTypes\": [\n \"{{oneOf (array 'PT1M' 'PT5M' 'PT15M' 'PT30M' 'PT1H' 'PT6H' 'PT12H' 'PT1D')}}\"\n ],\n \"unit\": \"{{oneOf (array 'NotSpecified' 'Percent' 'Count' 'Seconds' 'Milliseconds' 'Bytes' 'BytesPerSecond' 'CountPerSecond')}}\"\n }\n ]\n }\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of supported operations.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "168f1c1f-2605-4263-864f-c57b81c9b9e2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dcb3671d-08e7-432a-b060-0a182aaac0aa", "documentation": "Gets all the data box edge/gateway devices in a subscription.", "method": "get", "endpoint": "subscriptions/:subscriptionId/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "responses": [ { "uuid": "8fa75035-1dce-4727-928c-0c845c11baad", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of data box edge/gateway devices.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "980ef102-bae2-4dcc-9765-6ecbb2f4b33f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "45e13d1b-3789-4552-9371-9e6002080a50", "documentation": "Gets all the data box edge/gateway devices in a resource group.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "responses": [ { "uuid": "5bcc8d1c-82a2-4c95-8cbd-2befd39a591a", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of data box edge/gateway devices.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "91381843-03cf-416d-953c-cb0622929ece", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0391fe6-0a83-455a-afc5-50ca2ac74628", "documentation": "Deletes the data box edge/gateway device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "responses": [ { "uuid": "84a9b462-8948-4801-a512-69a76adb29ec", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the resource.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "02896636-1971-4cf6-8a07-137cb81760fe", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the resource.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c5a6acfd-3309-47d8-b31e-f16d751ade07", "body": "", "latency": 0, "statusCode": 204, "label": "The resource is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "593badc5-481e-4506-afbb-52d06c5ecc9a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4642757e-dd8e-4bcd-b268-b32d56942c9d", "documentation": "Gets the properties of the data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "responses": [ { "uuid": "9637aefa-3636-46f6-881b-935e091c574e", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The data box edge/gateway device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24e8edf8-f966-4ef3-a59c-3b324fe959ca", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0a07b6f9-99a5-470e-be96-07579506130d", "documentation": "Modifies a Data Box Edge/Gateway resource.", "method": "patch", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "responses": [ { "uuid": "e06c3d64-3338-4486-9029-6bb96c090124", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully updated the resource.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "db14b9fb-a910-4330-86cb-1b7f6c2949ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e418bc59-f37e-431c-a468-02d7b093f4fd", "documentation": "Creates or updates a Data Box Edge/Gateway resource.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "responses": [ { "uuid": "29bcbdab-9698-492a-b510-f25fb1778700", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the resource.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35e49f4f-6b87-4c9c-bb9d-282ac60033e5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2199f8c9-3b6b-4042-b72d-fd26c5a4e951", "documentation": "Gets all the alerts for a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/alerts", "responses": [ { "uuid": "ef302d77-9604-4f03-88ab-d1bc01175738", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of alerts.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c25f27ed-177b-4a7e-88a0-d7f025c09238", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f55e5667-699f-4f02-9571-897c8f630210", "documentation": "Gets an alert by name.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/alerts/:name", "responses": [ { "uuid": "45a73779-a2d5-4cc3-a7ab-fc52d7e5cf17", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The alert details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ee484c7a-f866-49e7-a423-c4e26adb8bfc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9afeb88e-a235-495b-835f-2d2cb7c602fe", "documentation": "Gets all the bandwidth schedules for a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules", "responses": [ { "uuid": "e9b4a4eb-a02b-4255-ad56-12481ec13890", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of bandwidth schedules.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c56ed41b-7e5c-401a-a450-b08534d01dac", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d12182a9-bdc0-49e2-bd46-519d8543d5ae", "documentation": "Deletes the specified bandwidth schedule.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name", "responses": [ { "uuid": "e57d1a24-348f-4766-8bfb-7cea502c089c", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7392401f-5948-4a6b-b943-5f1bad0c119b", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cec5fff3-26d0-4952-8067-6c0d57e1baae", "body": "", "latency": 0, "statusCode": 204, "label": "Successfully deleted the bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "47efa248-88e0-40a9-ae5f-4e32ce20e079", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "42857fd3-7cd9-410d-83c5-a733aac54baf", "documentation": "Gets the properties of the specified bandwidth schedule.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name", "responses": [ { "uuid": "bb6bf486-ee55-41d3-a980-b0568fc7ebf5", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "60cd2fa4-a096-40cb-9ad5-7510017404c5", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0706af5e-88f2-4899-9ad2-d08e129a168b", "documentation": "Creates or updates a bandwidth schedule.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name", "responses": [ { "uuid": "01f47313-0b00-4563-b483-48116e7e0955", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c512463d-f19e-496e-80ef-2cc8106574e8", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the bandwidth schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1789c958-40f2-4a2c-9b5a-7a19cb3cf86a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa41a457-dcd2-46bb-b8f2-3792cedf9e13", "documentation": "Downloads the updates on a data box edge/gateway device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/downloadUpdates", "responses": [ { "uuid": "13be2ad9-34c4-4202-a46b-5a5c08e204be", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully downloaded the updates on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c619df7-6307-41ca-ad98-51fe94032a84", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to download the updates on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "743aac6e-f2ff-40e1-a4e6-378632c67e42", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "af82e5b7-2b2f-4ab4-a24f-ae8e17b6e747", "documentation": "Gets additional information for the specified data box edge/gateway device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/getExtendedInformation", "responses": [ { "uuid": "a8aacc60-6c3d-4252-b630-c153078edba2", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The additional information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "13e307ed-9288-4901-a84f-070534e354c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c2f5179-2652-4848-b644-ea341dcf2fbd", "documentation": "Installs the updates on the data box edge/gateway device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/installUpdates", "responses": [ { "uuid": "891d7204-0358-4b79-9942-c5ae462b891b", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully installed updates on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3edf71eb-b349-4fed-9ff2-07845561904e", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to install updates on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1d848465-4e80-4027-961a-995857878adc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0cf4b0b3-f5ff-456f-91c8-fc484cccbd3d", "documentation": "Gets the details of a specified job on a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/jobs/:name", "responses": [ { "uuid": "26bb7215-c955-4b1f-a5fb-12da790ea24a", "body": "{\n \"endTime\": \"{{faker 'date.recent' 365}}\",\n \"error\": {\n \"code\": \"\",\n \"errorDetails\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"recommendations\": [\n \"\"\n ]\n }\n ],\n \"message\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"percentComplete\": {{faker 'number.int' max=99999}},\n \"properties\": {\n \"currentStage\": \"{{oneOf (array 'Unknown' 'Initial' 'ScanStarted' 'ScanComplete' 'ScanFailed' 'DownloadStarted' 'DownloadComplete' 'DownloadFailed' 'InstallStarted' 'InstallComplete' 'InstallFailed' 'RebootInitiated' 'Success' 'Failure' 'RescanStarted' 'RescanComplete' 'RescanFailed')}}\",\n \"downloadProgress\": {\n \"downloadPhase\": \"{{oneOf (array 'Unknown' 'Initializing' 'Downloading' 'Verifying')}}\",\n \"numberOfUpdatesDownloaded\": {{faker 'number.int' max=99999}},\n \"numberOfUpdatesToDownload\": {{faker 'number.int' max=99999}},\n \"percentComplete\": {{faker 'number.int' max=99999}},\n \"totalBytesDownloaded\": {{faker 'number.float'}},\n \"totalBytesToDownload\": {{faker 'number.float'}}\n },\n \"errorManifestFile\": \"\",\n \"folder\": \"\",\n \"installProgress\": {\n \"numberOfUpdatesInstalled\": {{faker 'number.int' max=99999}},\n \"numberOfUpdatesToInstall\": {{faker 'number.int' max=99999}},\n \"percentComplete\": {{faker 'number.int' max=99999}}\n },\n \"jobType\": \"{{oneOf (array 'Invalid' 'ScanForUpdates' 'DownloadUpdates' 'InstallUpdates' 'RefreshShare')}}\",\n \"shareId\": \"\",\n \"totalRefreshErrors\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"{{oneOf (array 'Invalid' 'Running' 'Succeeded' 'Failed' 'Canceled' 'Paused' 'Scheduled')}}\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The job details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d7524a74-de2b-46d5-8aed-d066db4531f2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "daf2c040-87bd-4ea4-8263-d80a7042e24d", "documentation": "Gets the network settings of the specified data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/networkSettings/default", "responses": [ { "uuid": "5a21775e-a793-4270-9f76-e2d621bdb1e5", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The device network settings.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0fcf7ca4-3fd7-4711-a645-0c980fe361d2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "97eb917c-4e6d-40fd-82c9-c129497fb05f", "documentation": "Gets the details of a specified job on a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/operationsStatus/:name", "responses": [ { "uuid": "f82cd431-b097-43d3-a7b9-018307e5e5bb", "body": "{\n \"endTime\": \"{{faker 'date.recent' 365}}\",\n \"error\": {\n \"code\": \"\",\n \"errorDetails\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"recommendations\": [\n \"\"\n ]\n }\n ],\n \"message\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"percentComplete\": {{faker 'number.int' max=99999}},\n \"properties\": {\n \"currentStage\": \"{{oneOf (array 'Unknown' 'Initial' 'ScanStarted' 'ScanComplete' 'ScanFailed' 'DownloadStarted' 'DownloadComplete' 'DownloadFailed' 'InstallStarted' 'InstallComplete' 'InstallFailed' 'RebootInitiated' 'Success' 'Failure' 'RescanStarted' 'RescanComplete' 'RescanFailed')}}\",\n \"downloadProgress\": {\n \"downloadPhase\": \"{{oneOf (array 'Unknown' 'Initializing' 'Downloading' 'Verifying')}}\",\n \"numberOfUpdatesDownloaded\": {{faker 'number.int' max=99999}},\n \"numberOfUpdatesToDownload\": {{faker 'number.int' max=99999}},\n \"percentComplete\": {{faker 'number.int' max=99999}},\n \"totalBytesDownloaded\": {{faker 'number.float'}},\n \"totalBytesToDownload\": {{faker 'number.float'}}\n },\n \"errorManifestFile\": \"\",\n \"folder\": \"\",\n \"installProgress\": {\n \"numberOfUpdatesInstalled\": {{faker 'number.int' max=99999}},\n \"numberOfUpdatesToInstall\": {{faker 'number.int' max=99999}},\n \"percentComplete\": {{faker 'number.int' max=99999}}\n },\n \"jobType\": \"{{oneOf (array 'Invalid' 'ScanForUpdates' 'DownloadUpdates' 'InstallUpdates' 'RefreshShare')}}\",\n \"shareId\": \"\",\n \"totalRefreshErrors\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"{{oneOf (array 'Invalid' 'Running' 'Succeeded' 'Failed' 'Canceled' 'Paused' 'Scheduled')}}\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The job details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "60c3d9f7-6fe8-4f13-8567-0eca5a2d999f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f61f602-8cec-499c-91c4-cfa29e3bd1bc", "documentation": "Lists all the orders related to a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders", "responses": [ { "uuid": "5366ab56-64ae-4253-9e4f-393cb3e70268", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Lists all the orders for the Data Box Edge Device", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b8004919-a17c-4c1c-a103-dd724ee4b7ea", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e176a6a0-7647-4720-8309-c7cc75d52c0b", "documentation": "Deletes the order related to the device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default", "responses": [ { "uuid": "04298a19-2e45-4077-a292-347f773d35de", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the order.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "03d44243-50f6-4dc9-8b1b-f80670c1e2bc", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the order.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c00e18e5-c66b-48ff-8d9c-cc9bca73a90e", "body": "", "latency": 0, "statusCode": 204, "label": "The order is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1364406d-b4e4-45c4-9db2-5a6d30500dde", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d91eac96-f64e-481d-80ed-84d4d3ccd525", "documentation": "Gets a specific order by name.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default", "responses": [ { "uuid": "456443c9-e930-4631-8528-1558b9de925c", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The order details of a device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "63578a67-3c3b-4486-b529-eaac6483f4c6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "05da1223-baa5-4f3e-9633-f2c88d92fbdb", "documentation": "Creates or updates an order.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default", "responses": [ { "uuid": "d47439f2-b3ce-44cc-8401-2af0e6e14696", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the order.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9a6ae6f0-fdad-42ae-8c4a-e6bbf7c1e2c1", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the order.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f91ed84e-a955-4304-8401-b800edac2d57", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "15729a8a-e76e-465d-a72c-6313bdbf7f95", "documentation": "Lists all the roles configured in a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles", "responses": [ { "uuid": "99d143f8-bf60-42e7-97a9-a0dd9cadfecd", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List of all the roles configured in the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "77d529f3-0b36-46c1-aace-d4bd37cd96bf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6f5f5e2c-1d33-443d-856c-eabc8b1bacf4", "documentation": "Deletes the role on the data box edge device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name", "responses": [ { "uuid": "995332ef-950d-4f68-8184-872abdc619ce", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the role.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "65c308aa-6771-4084-a353-a7f20015231d", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the role.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "17cf3021-354d-4d2d-a36f-96abd9d6f31d", "body": "", "latency": 0, "statusCode": 204, "label": "The role is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f2e31c96-a838-4707-82e4-7d64e94e955f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c329ef5-5bc2-47f0-a835-187228523330", "documentation": "Gets a specific role by name.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name", "responses": [ { "uuid": "b6e34dd4-46db-4f9d-9017-4d206ce1d5fc", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The role with the specified name in the given device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d6c7811e-a23f-4060-a7f4-6417464bd41c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c7d00299-4abf-4e56-b79b-a63b78de3fc3", "documentation": "Create or update a role.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name", "responses": [ { "uuid": "70ab23db-99fd-42c2-bcfb-de80ae7f1d8f", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the role.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "effb035c-aab6-4751-a6d8-fcbf3a41f5ee", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the role.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "90d11587-03c6-4dcb-b6c5-9c6bdd6f78a2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbfc5185-446f-4147-b45b-6c7b8bd494f4", "documentation": "Scans for updates on a data box edge/gateway device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/scanForUpdates", "responses": [ { "uuid": "c63c19cc-c9cf-4ac3-b9c1-340ed98aaa6f", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully scanned the device for updates.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7a08e375-12a7-4f4e-a496-9f4784469edd", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to scan for updates on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5453a668-89ba-4950-970a-9bb330c5f158", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5a42e68-1bd3-4cde-9899-2f323afd824a", "documentation": "Updates the security settings on a data box edge/gateway device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/securitySettings/default/update", "responses": [ { "uuid": "cd6cbc5f-a8b1-4424-af60-40acd1808b11", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to update the security settings.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "64ea364f-99e8-4fd3-bc97-b568ce645462", "body": "", "latency": 0, "statusCode": 204, "label": "Updated the security settings.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ac1ef9c0-34fa-401b-ab0a-c883061fd95d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5839c2b3-b108-4bd6-95b1-bfdbcb4a924f", "documentation": "Lists all the shares in a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares", "responses": [ { "uuid": "9fa82b7f-290c-4705-9120-1b35bdee3da4", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of all the shares on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1a3f9af2-6af9-451c-b976-1433ad65ef45", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10c33951-7ed9-424b-ba3e-ecbf8ddad030", "documentation": "Deletes the share on the data box edge/gateway device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name", "responses": [ { "uuid": "832a4990-45eb-4510-b582-16e4e5dcee6e", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the share.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d01a9926-964c-49eb-8418-a47689bfdec6", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the share.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2fb9f50e-47f9-4be6-9066-09b97c06302d", "body": "", "latency": 0, "statusCode": 204, "label": "The share is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e69da18e-c156-4f95-8c90-8b8239c50b55", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de4e7e4d-22ad-44ab-8a78-8fd66c5b3f75", "documentation": "Gets a share by name.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name", "responses": [ { "uuid": "95ba7844-4929-4d68-8c0c-a4dabe1c3974", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The share details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d71bf7e-830d-44a0-88e5-ebc09348536b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd2e1317-a35a-455d-b107-f36508de78a8", "documentation": "Creates a new share or updates an existing share on the device.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name", "responses": [ { "uuid": "805dd9f0-ed87-4b98-a5bd-79dde31a1617", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the share.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a992cd0f-326c-4e9c-af09-46dc3f3ce184", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the share.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "af0f3f8d-ff40-4223-b083-d42015f90530", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ace6264-486d-4300-a4f0-5226586b99d6", "documentation": "Refreshes the share metadata with the data from the cloud.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name/refresh", "responses": [ { "uuid": "ace35062-c5bf-4b7f-a1b3-d419f99e0330", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully refreshed the share on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "09997cee-1ef9-4ed7-94c6-6dd232ee81d9", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to refresh the share on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ce3b1114-05ac-4fb2-80fe-69a89a3a7df0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a704db84-984b-4b59-9c56-b40bf345d7a8", "documentation": "Gets all the storage account credentials in a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials", "responses": [ { "uuid": "47039c6c-3141-4a98-89ca-fc4a86d1fb46", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of storage account credentials.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a86c4700-5ac5-4064-a63d-7189e8f53d88", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "745bd69f-8033-45ff-8063-79cbd8af1320", "documentation": "Deletes the storage account credential.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name", "responses": [ { "uuid": "7ac9f456-de6a-4d89-8311-2db7ab69e959", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the storage account credential.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f23ea637-f7b3-4bd0-a390-b0a5274ed44d", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the storage account credential.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "229723d2-76dd-4bf1-8185-8eea83f234aa", "body": "", "latency": 0, "statusCode": 204, "label": "The storage account credential is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "370e32f7-34da-4c59-8e45-ba4c669d337e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c289941e-b1f1-43cc-acdf-b9dce8188963", "documentation": "Gets the properties of the specified storage account credential.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name", "responses": [ { "uuid": "eb34f5cd-74e9-4438-ae7e-e14e2d507bcf", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The storage account credential properties.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6dd653a4-f210-45a1-b742-9826e5492fdb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "31d296a7-092a-408d-844e-a90f6c7c0af0", "documentation": "Creates or updates the storage account credential.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name", "responses": [ { "uuid": "4f760e77-7094-4c03-bbc3-d2e9cccd0cbc", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the storage account credential.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7de7d721-4b49-4e5b-ba2f-44e09f16211d", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the storage account credential.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12cc5146-295c-4661-8b58-6f5acd421023", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "002c337b-7a0a-4c00-b8b8-9176b01c2010", "documentation": "Lists all the triggers configured in the device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers", "responses": [ { "uuid": "da55eb82-e3d9-485b-89f6-87752e2795d8", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "List all the triggers configured in the device", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "83faa24c-344b-4c76-93f2-35e16a20858b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bccbcab7-355a-4259-ac00-50329fa9a0eb", "documentation": "Deletes the trigger on the gateway device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name", "responses": [ { "uuid": "fd2711a6-b7d9-460e-ac4b-114c89db7570", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the trigger.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "88ad3266-bd4d-4566-86c6-0cfb20ee9e45", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the trigger.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "271f1a37-4039-4ef3-98fd-cdd74ea2ef2c", "body": "", "latency": 0, "statusCode": 204, "label": "The trigger is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9161a7f-8827-49cd-8444-1a1b01745a23", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cc2836a6-77e9-440c-88b8-cc33b0f6441d", "documentation": "Get a specific trigger by name.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name", "responses": [ { "uuid": "efee3d39-356d-44e2-ab22-acead42684f7", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The trigger.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d5e1efc3-16c3-4137-aa28-30d1fbafff56", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7896c196-10eb-4985-a44d-23b9d6978a61", "documentation": "Creates or updates a trigger.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name", "responses": [ { "uuid": "6047996f-cc1b-4a23-8122-7a78b26ca93f", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the trigger.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "be3d62f7-d89c-47a0-b686-4f0de4dd1df9", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the trigger.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7add50a4-cfa3-4a12-a4c8-2407824cc262", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7989deb6-41e9-44e0-92b3-668b9daabc11", "documentation": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/updateSummary/default", "responses": [ { "uuid": "7bd70522-a915-44cd-acb3-6d4cff092d7d", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The update summary.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e881aaf1-55e2-40ab-a261-edc6b9ea2ff4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "29e3a822-6be5-48fd-81ed-d52bf6c47cbc", "documentation": "Uploads registration certificate for the device.", "method": "post", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/uploadCertificate", "responses": [ { "uuid": "4d6afa09-59db-4472-b48d-3f2ff83dd244", "body": "{\n \"aadAuthority\": \"\",\n \"aadTenantId\": \"\",\n \"authType\": \"{{oneOf (array 'Invalid' 'AzureActiveDirectory')}}\",\n \"azureManagementEndpointAudience\": \"\",\n \"resourceId\": \"\",\n \"servicePrincipalClientId\": \"\",\n \"servicePrincipalObjectId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully uploaded the registration certificate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5e1a34c1-1ae8-4087-8944-e27f132728d7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd6c53d7-819b-4c92-af40-fdb9c90461c9", "documentation": "Gets all the users registered on a data box edge/gateway device.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users", "responses": [ { "uuid": "49a87109-9b11-4ec8-9a07-bc2a45111299", "body": "{\n \"nextLink\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The collection of all users on the device.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d22e39a-e950-4279-a11c-5021646c00e9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9deabe6d-3c86-4a24-a86b-141467eda6ac", "documentation": "Deletes the user on a databox edge/gateway device.", "method": "delete", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name", "responses": [ { "uuid": "014862b7-3286-48f0-8844-c7131a47583a", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully deleted the user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bb3da614-00c8-4aeb-94fd-63eaa4988b7c", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to delete the user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "89895565-9942-44d6-985a-f6cfe710e746", "body": "", "latency": 0, "statusCode": 204, "label": "The user is already deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3f220104-e4da-41d2-9339-c6de7d2e7232", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9fa1d446-5ee7-4cf2-a479-1b6274ad11a2", "documentation": "Gets the properties of the specified user.", "method": "get", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name", "responses": [ { "uuid": "04756a1c-b62d-4115-a65a-fd654625b4c5", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The user details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "30b40ac3-a9f9-4c67-a66d-b1080981cf03", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f98277aa-d42e-447a-86e3-49560ccb5179", "documentation": "Creates a new user or updates an existing user's information on a data box edge/gateway device.", "method": "put", "endpoint": "subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name", "responses": [ { "uuid": "bbd506d1-324e-4c05-b43e-25c22ae4afe7", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successfully created or updated the user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5499d788-0943-4961-9703-bc272167f16e", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted the request to create or update the user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d5aaa3c7-e0cf-48a7-a688-89bd581228ab", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Error response describing why the operation failed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "3c1f9d94-0223-4a8e-8e8a-fa8c472b2258" }, { "type": "route", "uuid": "dcb3671d-08e7-432a-b060-0a182aaac0aa" }, { "type": "route", "uuid": "45e13d1b-3789-4552-9371-9e6002080a50" }, { "type": "route", "uuid": "c0391fe6-0a83-455a-afc5-50ca2ac74628" }, { "type": "route", "uuid": "4642757e-dd8e-4bcd-b268-b32d56942c9d" }, { "type": "route", "uuid": "0a07b6f9-99a5-470e-be96-07579506130d" }, { "type": "route", "uuid": "e418bc59-f37e-431c-a468-02d7b093f4fd" }, { "type": "route", "uuid": "2199f8c9-3b6b-4042-b72d-fd26c5a4e951" }, { "type": "route", "uuid": "f55e5667-699f-4f02-9571-897c8f630210" }, { "type": "route", "uuid": "9afeb88e-a235-495b-835f-2d2cb7c602fe" }, { "type": "route", "uuid": "d12182a9-bdc0-49e2-bd46-519d8543d5ae" }, { "type": "route", "uuid": "42857fd3-7cd9-410d-83c5-a733aac54baf" }, { "type": "route", "uuid": "0706af5e-88f2-4899-9ad2-d08e129a168b" }, { "type": "route", "uuid": "fa41a457-dcd2-46bb-b8f2-3792cedf9e13" }, { "type": "route", "uuid": "af82e5b7-2b2f-4ab4-a24f-ae8e17b6e747" }, { "type": "route", "uuid": "2c2f5179-2652-4848-b644-ea341dcf2fbd" }, { "type": "route", "uuid": "0cf4b0b3-f5ff-456f-91c8-fc484cccbd3d" }, { "type": "route", "uuid": "daf2c040-87bd-4ea4-8263-d80a7042e24d" }, { "type": "route", "uuid": "97eb917c-4e6d-40fd-82c9-c129497fb05f" }, { "type": "route", "uuid": "3f61f602-8cec-499c-91c4-cfa29e3bd1bc" }, { "type": "route", "uuid": "e176a6a0-7647-4720-8309-c7cc75d52c0b" }, { "type": "route", "uuid": "d91eac96-f64e-481d-80ed-84d4d3ccd525" }, { "type": "route", "uuid": "05da1223-baa5-4f3e-9633-f2c88d92fbdb" }, { "type": "route", "uuid": "15729a8a-e76e-465d-a72c-6313bdbf7f95" }, { "type": "route", "uuid": "6f5f5e2c-1d33-443d-856c-eabc8b1bacf4" }, { "type": "route", "uuid": "4c329ef5-5bc2-47f0-a835-187228523330" }, { "type": "route", "uuid": "c7d00299-4abf-4e56-b79b-a63b78de3fc3" }, { "type": "route", "uuid": "bbfc5185-446f-4147-b45b-6c7b8bd494f4" }, { "type": "route", "uuid": "c5a42e68-1bd3-4cde-9899-2f323afd824a" }, { "type": "route", "uuid": "5839c2b3-b108-4bd6-95b1-bfdbcb4a924f" }, { "type": "route", "uuid": "10c33951-7ed9-424b-ba3e-ecbf8ddad030" }, { "type": "route", "uuid": "de4e7e4d-22ad-44ab-8a78-8fd66c5b3f75" }, { "type": "route", "uuid": "fd2e1317-a35a-455d-b107-f36508de78a8" }, { "type": "route", "uuid": "2ace6264-486d-4300-a4f0-5226586b99d6" }, { "type": "route", "uuid": "a704db84-984b-4b59-9c56-b40bf345d7a8" }, { "type": "route", "uuid": "745bd69f-8033-45ff-8063-79cbd8af1320" }, { "type": "route", "uuid": "c289941e-b1f1-43cc-acdf-b9dce8188963" }, { "type": "route", "uuid": "31d296a7-092a-408d-844e-a90f6c7c0af0" }, { "type": "route", "uuid": "002c337b-7a0a-4c00-b8b8-9176b01c2010" }, { "type": "route", "uuid": "bccbcab7-355a-4259-ac00-50329fa9a0eb" }, { "type": "route", "uuid": "cc2836a6-77e9-440c-88b8-cc33b0f6441d" }, { "type": "route", "uuid": "7896c196-10eb-4985-a44d-23b9d6978a61" }, { "type": "route", "uuid": "7989deb6-41e9-44e0-92b3-668b9daabc11" }, { "type": "route", "uuid": "29e3a822-6be5-48fd-81ed-d52bf6c47cbc" }, { "type": "route", "uuid": "fd6c53d7-819b-4c92-af40-fdb9c90461c9" }, { "type": "route", "uuid": "9deabe6d-3c86-4a24-a86b-141467eda6ac" }, { "type": "route", "uuid": "9fa1d446-5ee7-4cf2-a479-1b6274ad11a2" }, { "type": "route", "uuid": "f98277aa-d42e-447a-86e3-49560ccb5179" } ] }