{ "swagger": "2.0", "schemes": [ "https" ], "host": "management.azure.com", "info": { "title": "DataBoxEdgeManagementClient", "version": "2019-03-01", "x-apisguru-categories": [ "cloud" ], "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/databoxedge.json", "version": "2.0" } ], "x-preferred": false, "x-providerName": "azure.com", "x-serviceName": "databoxedge", "x-tags": [ "Azure", "Microsoft" ] }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "scopes": { "user_impersonation": "impersonate your user account." }, "type": "oauth2" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "parameters": { "apiVersionParameter": { "description": "The API version.", "in": "query", "name": "api-version", "required": true, "type": "string" }, "locationParameter": { "description": "The location of the resource.", "in": "path", "name": "location", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "resourceGroupNameParameter": { "description": "The resource group name.", "in": "path", "name": "resourceGroupName", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "subscriptionIdParameter": { "description": "The subscription ID.", "in": "path", "name": "subscriptionId", "required": true, "type": "string" } }, "paths": { "/providers/Microsoft.DataBoxEdge/operations": { "get": { "operationId": "Operations_List", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "List of supported operations.", "schema": { "$ref": "#/definitions/OperationsList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "List all the supported operations.", "tags": [ "Operations" ], "x-ms-examples": { "OperationsGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "display": { "description": "Lists or gets the share users", "operation": "List share users", "provider": "Microsoft.DataBoxEdge", "resource": "share users" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", "origin": "user" }, { "display": { "description": "Lists or gets the share users", "operation": "List share users", "provider": "Microsoft.DataBoxEdge", "resource": "share users" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", "origin": "user" }, { "display": { "description": "Creates or updates the share users", "operation": "Creates or updates share users", "provider": "Microsoft.DataBoxEdge", "resource": "share users" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", "origin": "user" }, { "display": { "description": "Deletes the share users", "operation": "Delete share users", "provider": "Microsoft.DataBoxEdge", "resource": "share users" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", "origin": "user" }, { "display": { "description": "Lists or gets the bandwidth schedules", "operation": "List bandwidth schedules", "provider": "Microsoft.DataBoxEdge", "resource": "bandwidth schedules" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", "origin": "user" }, { "display": { "description": "Lists or gets the bandwidth schedules", "operation": "List bandwidth schedules", "provider": "Microsoft.DataBoxEdge", "resource": "bandwidth schedules" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", "origin": "user" }, { "display": { "description": "Creates or updates the bandwidth schedules", "operation": "Creates or updates bandwidth schedules", "provider": "Microsoft.DataBoxEdge", "resource": "bandwidth schedules" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", "origin": "user" }, { "display": { "description": "Deletes the bandwidth schedules", "operation": "Delete bandwidth schedules", "provider": "Microsoft.DataBoxEdge", "resource": "bandwidth schedules" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", "origin": "user" }, { "display": { "description": "Lists or gets the ArmApiRes_roles", "operation": "List ArmApiRes_roles", "provider": "Microsoft.DataBoxEdge", "resource": "ArmApiRes_roles" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", "origin": "user" }, { "display": { "description": "Lists or gets the ArmApiRes_roles", "operation": "List ArmApiRes_roles", "provider": "Microsoft.DataBoxEdge", "resource": "ArmApiRes_roles" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", "origin": "user" }, { "display": { "description": "Creates or updates the ArmApiRes_roles", "operation": "Creates or updates ArmApiRes_roles", "provider": "Microsoft.DataBoxEdge", "resource": "ArmApiRes_roles" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", "origin": "user" }, { "display": { "description": "Deletes the ArmApiRes_roles", "operation": "Delete ArmApiRes_roles", "provider": "Microsoft.DataBoxEdge", "resource": "ArmApiRes_roles" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", "origin": "user" }, { "display": { "description": "Lists or gets the shares", "operation": "List shares", "provider": "Microsoft.DataBoxEdge", "resource": "shares" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", "origin": "user" }, { "display": { "description": "Lists or gets the shares", "operation": "List shares", "provider": "Microsoft.DataBoxEdge", "resource": "shares" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", "origin": "user" }, { "display": { "description": "Creates or updates the shares", "operation": "Creates or updates shares", "provider": "Microsoft.DataBoxEdge", "resource": "shares" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", "origin": "user" }, { "display": { "description": "ArmApiDesc_action_refresh_shares", "operation": "ArmApiOp_action_refresh_shares", "provider": "Microsoft.DataBoxEdge", "resource": "shares" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", "origin": "user" }, { "display": { "description": "Deletes the shares", "operation": "Delete shares", "provider": "Microsoft.DataBoxEdge", "resource": "shares" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", "origin": "user" }, { "display": { "description": "Upload certificate for device registration", "operation": "Upload certificates", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", "origin": "user" }, { "display": { "description": "Creates or updates the Data Box Edge devices", "operation": "Creates or updates Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", "origin": "user" }, { "display": { "description": "Lists or gets the Data Box Edge devices", "operation": "List Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", "origin": "user" }, { "display": { "description": "Deletes the Data Box Edge devices", "operation": "Delete Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", "origin": "user" }, { "display": { "description": "Lists or gets the Data Box Edge devices", "operation": "List Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", "origin": "user" }, { "display": { "description": "Lists or gets the Data Box Edge devices", "operation": "List Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", "origin": "user" }, { "display": { "description": "Creates or updates the Data Box Edge devices", "operation": "Creates or updates Data Box Edge devices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", "origin": "user" }, { "display": { "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices", "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", "origin": "user" }, { "display": { "description": "Retrieves resource extended information", "operation": "Gets resource extended information", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", "origin": "user" }, { "display": { "description": "Lists or gets the Device network settings", "operation": "List Device network settings", "provider": "Microsoft.DataBoxEdge", "resource": "Device network settings" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", "origin": "user" }, { "display": { "description": "Update security settings", "operation": "Update security settings", "provider": "Microsoft.DataBoxEdge", "resource": "Device security settings" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", "origin": "user" }, { "display": { "description": "Lists or gets the update summary", "operation": "List update summary", "provider": "Microsoft.DataBoxEdge", "resource": "update summary" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", "origin": "user" }, { "display": { "description": "Scan for updates", "operation": "Scan for updates", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", "origin": "user" }, { "display": { "description": "Download Updates in device", "operation": "Download Updates", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", "origin": "user" }, { "display": { "description": "Install Updates on device", "operation": "Install Updates", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge devices" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", "origin": "user" }, { "display": { "description": "Lists or gets the jobs", "operation": "List jobs", "provider": "Microsoft.DataBoxEdge", "resource": "jobs" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", "origin": "user" }, { "display": { "description": "Creates or updates the storage account credentials", "operation": "Creates or updates storage account credentials", "provider": "Microsoft.DataBoxEdge", "resource": "storage account credentials" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", "origin": "user" }, { "display": { "description": "Lists or gets the storage account credentials", "operation": "List storage account credentials", "provider": "Microsoft.DataBoxEdge", "resource": "storage account credentials" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", "origin": "user" }, { "display": { "description": "Lists or gets the storage account credentials", "operation": "List storage account credentials", "provider": "Microsoft.DataBoxEdge", "resource": "storage account credentials" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", "origin": "user" }, { "display": { "description": "Deletes the storage account credentials", "operation": "Delete storage account credentials", "provider": "Microsoft.DataBoxEdge", "resource": "storage account credentials" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", "origin": "user" }, { "display": { "description": "Lists or gets the alerts", "operation": "List alerts", "provider": "Microsoft.DataBoxEdge", "resource": "alerts" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", "origin": "user" }, { "display": { "description": "Lists or gets the alerts", "operation": "List alerts", "provider": "Microsoft.DataBoxEdge", "resource": "alerts" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", "origin": "user" }, { "display": { "description": "Gets the available Data Box Edge device level metrics", "operation": "Read Data Box Edge device metric definition", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge device" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", "origin": "system", "properties": { "serviceSpecification": { "metricSpecifications": [ { "aggregationType": "Average", "category": "Transaction", "dimensions": [ { "displayName": "Name", "name": "InstanceName", "toBeExportedForShoebox": true } ], "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", "displayName": "Read Throughput (Network)", "fillGapWithZero": false, "name": "NICReadThroughput", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT1M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [ { "displayName": "Name", "name": "InstanceName", "toBeExportedForShoebox": true } ], "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", "displayName": "Write Throughput (Network)", "fillGapWithZero": false, "name": "NICWriteThroughput", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT1M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [ { "displayName": "Share", "name": "Share", "toBeExportedForShoebox": true } ], "displayDescription": "The download throughput to Azure from a share during the reporting period.", "displayName": "Cloud Download Throughput (Share)", "fillGapWithZero": false, "name": "CloudReadThroughputPerShare", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT1M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [ { "displayName": "Share", "name": "Share", "toBeExportedForShoebox": true } ], "displayDescription": "The upload throughput to Azure from a share during the reporting period.", "displayName": "Cloud Upload Throughput (Share)", "fillGapWithZero": false, "name": "CloudUploadThroughputPerShare", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT1M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [ { "displayName": "Share", "name": "Share", "toBeExportedForShoebox": true } ], "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", "displayName": "Cloud Bytes Uploaded (Share)", "fillGapWithZero": false, "name": "BytesUploadedToCloudPerShare", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT1M", "PT15M", "PT1H" ], "unit": "Bytes" }, { "aggregationType": "Average", "category": "Capacity", "dimensions": [], "displayDescription": "Total Capacity", "displayName": "Total Capacity", "fillGapWithZero": false, "name": "TotalCapacity", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT5M", "PT15M", "PT1H" ], "unit": "Bytes" }, { "aggregationType": "Average", "category": "Capacity", "dimensions": [], "displayDescription": "The available capacity in bytes during the reporting period.", "displayName": "Available Capacity", "fillGapWithZero": false, "name": "AvailableCapacity", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT5M", "PT15M", "PT1H" ], "unit": "Bytes" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [], "displayDescription": "The cloud upload throughput during the reporting period.", "displayName": "Cloud Upload Throughput", "fillGapWithZero": false, "name": "CloudUploadThroughput", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT5M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [], "displayDescription": "The cloud download throughput during the reporting period.", "displayName": "Cloud Read Throughput", "fillGapWithZero": false, "name": "CloudReadThroughput", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT5M", "PT15M", "PT1H" ], "unit": "BytesPerSecond" }, { "aggregationType": "Average", "category": "Transaction", "dimensions": [], "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", "displayName": "Cloud Bytes Uploaded (Device)", "fillGapWithZero": false, "name": "BytesUploadedToCloud", "supportedAggregationTypes": [ "Average", "Minimum", "Maximum" ], "supportedTimeGrainTypes": [ "PT5M", "PT15M", "PT1H" ], "unit": "Bytes" } ] } } }, { "display": { "description": "Creates or updates the diagnostics setting for the resource", "operation": "Write diagnostics setting", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge device" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", "origin": "system" }, { "display": { "description": "Gets the diagnostic setting for the resource", "operation": "Read diagnostics setting", "provider": "Microsoft.DataBoxEdge", "resource": "Data Box Edge device" }, "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", "origin": "system" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { "get": { "description": "Gets all the data box edge/gateway devices in a subscription.", "operationId": "Devices_ListBySubscription", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", "in": "query", "name": "$expand", "required": false, "type": "string" } ], "responses": { "200": { "description": "The collection of data box edge/gateway devices.", "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDeviceGetBySubscription": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", "location": "WUS", "name": "testedgedevice", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" }, { "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", "location": "WUS", "name": "testedgedevice2", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" }, { "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", "location": "WUS", "name": "testedgedevice3", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { "get": { "description": "Gets all the data box edge/gateway devices in a resource group.", "operationId": "Devices_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", "in": "query", "name": "$expand", "required": false, "type": "string" } ], "responses": { "200": { "description": "The collection of data box edge/gateway devices.", "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDeviceGetByResourceGroup": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", "location": "WUS", "name": "testedgedevice", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" }, { "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", "location": "WUS", "name": "testedgedevice2", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" }, { "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", "location": "WUS", "name": "testedgedevice3", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { "delete": { "description": "Deletes the data box edge/gateway device.", "operationId": "Devices_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the resource." }, "202": { "description": "Accepted the request to delete the resource." }, "204": { "description": "The resource is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDeviceDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the properties of the data box edge/gateway device.", "operationId": "Devices_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The data box edge/gateway device.", "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDeviceGetByName": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "etag": "\"W/\"datetime'2018-12-16T08%3A03%3A27.61Z'\"_W/\"datetime'2018-12-16T08%3A03%3A27.653Z'\"\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", "location": "WUS", "name": "testedgedevice", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" } } } } } }, "patch": { "description": "Modifies a Data Box Edge/Gateway resource.", "operationId": "Devices_Update", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The resource parameters.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/DataBoxEdgeDevicePatch" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the resource.", "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDevicePatch": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "parameters": { "tags": { "Key1": "value1", "Key2": "value2" } }, "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "etag": "W/\"datetime'2018-12-19T06%3A33%3A24.983Z'\"_W/\"datetime'2018-12-19T06%3A33%3A25.013Z'\"", "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", "location": "WUS", "name": "testedgedevice", "properties": { "dataBoxEdgeDeviceStatus": "ReadyToSetup", "deviceLocalCapacity": 0, "deviceType": "DataBoxEdgeDevice" }, "sku": { "name": "Edge", "tier": "Standard" }, "tags": { "Key1": "value1", "Key2": "value2" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" } } } } } }, "put": { "description": "Creates or updates a Data Box Edge/Gateway resource.", "operationId": "Devices_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The resource object.", "in": "body", "name": "DataBoxEdgeDevice", "required": true, "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the resource.", "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "DataBoxEdgeDevicePut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "DataBoxEdgeDevice": { "location": "WUS", "sku": { "name": "Edge", "tier": "Standard" }, "tags": {} }, "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "location": "WUS", "name": "testedgedevice", "sku": { "name": "Edge", "tier": "Standard" }, "tags": {} } } } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { "get": { "description": "Gets all the alerts for a data box edge/gateway device.", "operationId": "Alerts_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The collection of alerts.", "schema": { "$ref": "#/definitions/AlertList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Alerts" ], "x-ms-examples": { "AlertGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "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", "properties": { "alertType": "PasswordChangedEvent", "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", "detailedInformation": {}, "errorDetails": { "errorCode": "", "errorMessage": "", "occurrences": 2 }, "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", "title": "Device password has changed" }, "type": "dataBoxEdgeDevices/alerts" }, { "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", "properties": { "alertType": "UpdateScanFailedEvent", "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", "detailedInformation": {}, "errorDetails": { "errorCode": "", "errorMessage": "", "occurrences": 1 }, "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", "severity": "Critical", "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'." }, "type": "dataBoxEdgeDevices/alerts" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { "get": { "operationId": "Alerts_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The alert name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The alert details.", "schema": { "$ref": "#/definitions/Alert" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets an alert by name.", "tags": [ "Alerts" ], "x-ms-examples": { "AlertGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "159a00c7-8543-4343-9435-263ac87df3bb", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "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", "properties": { "alertType": "UpdateScanFailedEvent", "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", "detailedInformation": {}, "errorDetails": { "errorCode": "", "errorMessage": "", "occurrences": 1 }, "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", "severity": "Critical", "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'." }, "type": "dataBoxEdgeDevices/alerts" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { "get": { "description": "Gets all the bandwidth schedules for a data box edge/gateway device.", "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The collection of bandwidth schedules.", "schema": { "$ref": "#/definitions/BandwidthSchedulesList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "BandwidthSchedules" ], "x-ms-examples": { "BandwidthScheduleGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", "name": "bandwidth-1", "properties": { "days": [ "Sunday", "Monday" ], "rateInMbps": 100, "start": "00:00:00", "stop": "13:59:00" }, "type": "dataBoxEdgeDevices/bandwidthSchedules" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { "delete": { "description": "Deletes the specified bandwidth schedule.", "operationId": "BandwidthSchedules_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The bandwidth schedule name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the bandwidth schedule." }, "202": { "description": "Accepted the request to delete the bandwidth schedule." }, "204": { "description": "Successfully deleted the bandwidth schedule." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "BandwidthSchedules" ], "x-ms-examples": { "BandwidthScheduleDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "bandwidth-1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the properties of the specified bandwidth schedule.", "operationId": "BandwidthSchedules_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The bandwidth schedule name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The bandwidth schedule.", "schema": { "$ref": "#/definitions/BandwidthSchedule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "BandwidthSchedules" ], "x-ms-examples": { "BandwidthScheduleGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "bandwidth-1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", "name": "bandwidth-1", "properties": { "days": [ "Sunday", "Monday" ], "rateInMbps": 100, "start": "00:00:00", "stop": "13:59:00" }, "type": "dataBoxEdgeDevices/bandwidthSchedules" } } } } } }, "put": { "description": "Creates or updates a bandwidth schedule.", "operationId": "BandwidthSchedules_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The bandwidth schedule name which needs to be added/updated.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The bandwidth schedule to be added or updated.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/BandwidthSchedule" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the bandwidth schedule.", "schema": { "$ref": "#/definitions/BandwidthSchedule" } }, "202": { "description": "Accepted the request to create or update the bandwidth schedule." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "BandwidthSchedules" ], "x-ms-examples": { "BandwidthSchedulePut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "bandwidth-1", "parameters": { "properties": { "days": [ "Sunday", "Monday" ], "rateInMbps": 100, "start": "0:0:0", "stop": "13:59:0" } }, "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", "name": "bandwidth-1", "properties": { "days": [ "Sunday", "Monday" ], "rateInMbps": 100, "start": "00:00:00", "stop": "13:59:00" }, "type": "dataBoxEdgeDevices/bandwidthSchedules" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { "post": { "operationId": "Devices_DownloadUpdates", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully downloaded the updates on the device." }, "202": { "description": "Accepted the request to download the updates on the device." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Downloads the updates on a data box edge/gateway device.", "tags": [ "Devices" ], "x-ms-examples": { "DownloadUpdatesPost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { "post": { "description": "Gets additional information for the specified data box edge/gateway device.", "operationId": "Devices_GetExtendedInformation", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The additional information.", "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "ExtendedInfoPost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", "name": "testedgedevice", "properties": { "encryptionKey": "", "encryptionKeyThumbprint": "", "resourceKey": "3482840729935603111" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { "post": { "operationId": "Devices_InstallUpdates", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully installed updates on the device." }, "202": { "description": "Accepted the request to install updates on the device." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Installs the updates on the data box edge/gateway device.", "tags": [ "Devices" ], "x-ms-examples": { "InstallUpdatesPost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": { "get": { "operationId": "Jobs_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The job name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The job details.", "schema": { "$ref": "#/definitions/Job" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets the details of a specified job on a data box edge/gateway device.", "tags": [ "Jobs" ], "x-ms-examples": { "JobsGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "159a00c7-8543-4343-9435-263ac87df3bb", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "endTime": "2018-12-18T03:18:51.4270267Z", "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb", "name": "159a00c7-8543-4343-9435-263ac87df3bb", "percentComplete": 100, "properties": { "currentStage": "Success", "jobType": "DownloadUpdates" }, "startTime": "2018-12-18T02:18:51.4270267Z", "status": "Succeeded" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { "get": { "description": "Gets the network settings of the specified data box edge/gateway device.", "operationId": "Devices_GetNetworkSettings", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The device network settings.", "schema": { "$ref": "#/definitions/NetworkSettings" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "NetworkSettingsGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", "name": "default", "properties": { "networkAdapters": [ { "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", "adapterPosition": { "networkGroup": "NonRDMA", "port": 0 }, "dhcpStatus": "Disabled", "dnsServers": [ "10.50.50.50", "10.50.10.50" ], "index": 1, "ipv4Configuration": { "gateway": "10.150.76.1", "ipAddress": "10.150.78.56", "subnet": "255.255.252.0" }, "ipv6Configuration": { "gateway": "fe80::12f3:11ff:fe36:994b%5", "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", "prefixLength": 64 }, "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", "label": "DATA1", "linkSpeed": 10000000000, "macAddress": "00155D4E265B", "networkAdapterName": "DATA1", "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", "rdmaStatus": "Incapable", "status": "Inactive" } ] }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { "get": { "operationId": "OperationsStatus_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The job name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The job details.", "schema": { "$ref": "#/definitions/Job" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets the details of a specified job on a data box edge/gateway device.", "tags": [ "OperationsStatus" ], "x-ms-examples": { "OperationsStatusGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "159a00c7-8543-4343-9435-263ac87df3bb", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "endTime": "2018-12-18T03:18:51.4270267Z", "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", "name": "159a00c7-8543-4343-9435-263ac87df3bb", "percentComplete": 100, "properties": { "currentStage": "Success", "jobType": "DownloadUpdates" }, "startTime": "2018-12-18T02:18:51.4270267Z", "status": "Succeeded" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { "get": { "operationId": "Orders_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Lists all the orders for the Data Box Edge Device", "schema": { "$ref": "#/definitions/OrderList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Lists all the orders related to a data box edge/gateway device.", "tags": [ "Orders" ], "x-ms-examples": { "OrderGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", "name": "default", "properties": { "contactInformation": { "companyName": "Microsoft", "contactPerson": "John Mcclane", "emailList": [ "john@microsoft.com" ], "phone": "(800) 426-9400" }, "currentStatus": { "comments": "", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" }, "deliveryTrackingInfo": [], "orderHistory": [ { "comments": "lorem ipsum", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" } ], "returnTrackingInfo": [], "serialNumber": "UDS123NSDA123", "shippingAddress": { "addressLine1": "Microsoft Corporation", "addressLine2": "One Microsoft Way", "addressLine3": "Redmond", "city": "WA", "country": "USA", "postalCode": "98052", "state": "WA" } }, "type": "dataBoxEdgeDevices/orders" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { "delete": { "operationId": "Orders_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the order." }, "202": { "description": "Accepted the request to delete the order." }, "204": { "description": "The order is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Deletes the order related to the device.", "tags": [ "Orders" ], "x-ms-examples": { "OrderDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "operationId": "Orders_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The order details of a device.", "schema": { "$ref": "#/definitions/Order" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets a specific order by name.", "tags": [ "Orders" ], "x-ms-examples": { "OrderGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", "name": "default", "properties": { "contactInformation": { "companyName": "Microsoft", "contactPerson": "John Mcclane", "emailList": [ "john@microsoft.com" ], "phone": "(800) 426-9400" }, "currentStatus": { "comments": "", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" }, "deliveryTrackingInfo": [], "orderHistory": [ { "comments": "lorem ipsum", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" } ], "returnTrackingInfo": [], "serialNumber": "UDS123NSDA123", "shippingAddress": { "addressLine1": "Microsoft Corporation", "addressLine2": "One Microsoft Way", "addressLine3": "Redmond", "city": "WA", "country": "USA", "postalCode": "98052", "state": "WA" } }, "type": "dataBoxEdgeDevices/orders" } } } } } }, "put": { "operationId": "Orders_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The order to be created or updated.", "in": "body", "name": "order", "required": true, "schema": { "$ref": "#/definitions/Order" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the order.", "schema": { "$ref": "#/definitions/Order" } }, "202": { "description": "Accepted the request to create or update the order." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Creates or updates an order.", "tags": [ "Orders" ], "x-ms-examples": { "OrderPut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "order": { "properties": { "contactInformation": { "companyName": "Microsoft", "contactPerson": "John Mcclane", "emailList": [ "john@microsoft.com" ], "phone": "(800) 426-9400" }, "shippingAddress": { "addressLine1": "Microsoft Corporation", "addressLine2": "One Microsoft Way", "addressLine3": "Redmond", "city": "WA", "country": "USA", "postalCode": "98052", "state": "WA" } } }, "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", "name": "default", "properties": { "contactInformation": { "companyName": "Microsoft", "contactPerson": "John Mcclane", "emailList": [ "john@microsoft.com" ], "phone": "(800) 426-9400" }, "currentStatus": { "comments": "", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" }, "deliveryTrackingInfo": [], "orderHistory": [ { "comments": "lorem ipsum", "status": "Untracked", "updateDateTime": "2018-12-10T07:59:05.847Z" } ], "returnTrackingInfo": [], "serialNumber": "UDS123NSDA123", "shippingAddress": { "addressLine1": "Microsoft Corporation", "addressLine2": "One Microsoft Way", "addressLine3": "Redmond", "city": "WA", "country": "USA", "postalCode": "98052", "state": "WA" } }, "type": "dataBoxEdgeDevices/orders" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { "get": { "description": "Lists all the roles configured in a data box edge/gateway device.", "operationId": "Roles_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "List of all the roles configured in the device.", "schema": { "$ref": "#/definitions/RoleList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Roles" ], "x-ms-examples": { "RoleGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", "kind": "IOT", "name": "IoTRole1", "properties": { "hostPlatform": "Linux", "ioTDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotdevice", "ioTHostHub": "iothub.azure-devices.net" }, "ioTEdgeDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotEdge", "ioTHostHub": "iothub.azure-devices.net" }, "roleStatus": "Enabled", "shareMappings": [] }, "type": "dataBoxEdgeDevices/roles" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { "delete": { "description": "Deletes the role on the data box edge device.", "operationId": "Roles_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The role name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the role." }, "202": { "description": "Accepted the request to delete the role." }, "204": { "description": "The role is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Roles" ], "x-ms-examples": { "RoleDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "IoTRole1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets a specific role by name.", "operationId": "Roles_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The role name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The role with the specified name in the given device.", "schema": { "$ref": "#/definitions/Role" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Roles" ], "x-ms-examples": { "RoleGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "IoTRole1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce" }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", "kind": "IOT", "name": "IoTRole1", "properties": { "hostPlatform": "Linux", "ioTDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotdevice", "ioTHostHub": "iothub.azure-devices.net" }, "ioTEdgeDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotEdge", "ioTHostHub": "iothub.azure-devices.net" }, "roleStatus": "Enabled", "shareMappings": [] }, "type": "dataBoxEdgeDevices/roles" } } } } } }, "put": { "description": "Create or update a role.", "operationId": "Roles_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The role name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The role properties.", "in": "body", "name": "role", "required": true, "schema": { "$ref": "#/definitions/Role" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the role.", "schema": { "$ref": "#/definitions/Role" } }, "202": { "description": "Accepted the request to create or update the role." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Roles" ], "x-ms-examples": { "RolePut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "IoTRole1", "resourceGroupName": "GroupForEdgeAutomation", "role": { "kind": "IOT", "properties": { "hostPlatform": "Linux", "ioTDeviceDetails": { "authentication": { "symmetricKey": { "connectionString": { "encryptionAlgorithm": "AES256", "encryptionCertThumbprint": "348586569999244", "value": "Encrypted<>" } } }, "deviceId": "iotdevice", "ioTHostHub": "iothub.azure-devices.net" }, "ioTEdgeDeviceDetails": { "authentication": { "symmetricKey": { "connectionString": { "encryptionAlgorithm": "AES256", "encryptionCertThumbprint": "1245475856069999244", "value": "Encrypted<>" } } }, "deviceId": "iotEdge", "ioTHostHub": "iothub.azure-devices.net" }, "roleStatus": "Enabled", "shareMappings": [] } }, "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", "kind": "IOT", "name": "IoTRole1", "properties": { "hostPlatform": "Linux", "ioTDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotdevice", "ioTHostHub": "iothub.azure-devices.net" }, "ioTEdgeDeviceDetails": { "authentication": { "symmetricKey": {} }, "deviceId": "iotEdge", "ioTHostHub": "iothub.azure-devices.net" }, "roleStatus": "Enabled", "shareMappings": [] }, "type": "dataBoxEdgeDevices/roles" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { "post": { "operationId": "Devices_ScanForUpdates", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully scanned the device for updates." }, "202": { "description": "Accepted the request to scan for updates on the device." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Scans for updates on a data box edge/gateway device.", "tags": [ "Devices" ], "x-ms-examples": { "ScanForUpdatesPost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { "post": { "description": "Updates the security settings on a data box edge/gateway device.", "operationId": "Devices_CreateOrUpdateSecuritySettings", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The security settings.", "in": "body", "name": "securitySettings", "required": true, "schema": { "$ref": "#/definitions/SecuritySettings" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Accepted the request to update the security settings." }, "204": { "description": "Updated the security settings." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "SecuritySettingsUpdatePost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "AzureVM", "securitySettings": { "properties": { "deviceAdminPassword": { "encryptionAlgorithm": "AES256", "encryptionCertThumbprint": "7DCBDFC44ED968D232C9A998FC105B5C70E84BE0", "value": "jJ5MvXa/AEWvwxviS92uCjatCXeyLYTy8jx/k105MjQRXT7i6Do8qpEcQ8d+OBbwmQTnwKW0CYyzzVRCc0uZcPCf6PsWtP4l6wvcKGAP66PwK68eEkTUOmp+wUHc4hk02kWmTWeAjBZkuDBP3xK1RnZo95g2RE4i1UgKNP5BEKCLd71O104DW3AWW41mh9XLWNOaxw+VjQY7wmvlE6XkvpkMhcGuha2u7lx8zi9ZkcMvJVYDYK36Fb/K3KhBAmDjjDmVq04jtBlcSTXQObt0nlj4BwGGtdrpeIpr67zqr5i3cPm6e6AleIaIhp6sI/uyGSMiT3oev2eg49u2ii7kVA==" } } }, "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "202": {}, "204": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { "get": { "operationId": "Shares_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The collection of all the shares on the device.", "schema": { "$ref": "#/definitions/ShareList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Lists all the shares in a data box edge/gateway device.", "tags": [ "Shares" ], "x-ms-examples": { "ShareGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", "name": "smbshare", "properties": { "accessProtocol": "SMB", "azureContainerInfo": { "containerName": "testContainerSMB", "dataFormat": "BlockBlob", "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1" }, "clientAccessRights": [], "dataPolicy": "Cloud", "description": "", "monitoringStatus": "Disabled", "refreshDetails": {}, "shareMappings": [], "shareStatus": "Online", "userAccessRights": [ { "accessType": "Change", "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2" } ] }, "type": "dataBoxEdgeDevices/shares" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { "delete": { "description": "Deletes the share on the data box edge/gateway device.", "operationId": "Shares_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The share name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the share." }, "202": { "description": "Accepted the request to delete the share." }, "204": { "description": "The share is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Shares" ], "x-ms-examples": { "ShareDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "smbshare", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "operationId": "Shares_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The share name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The share details.", "schema": { "$ref": "#/definitions/Share" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets a share by name.", "tags": [ "Shares" ], "x-ms-examples": { "ShareGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "smbshare", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", "name": "smbshare", "properties": { "accessProtocol": "SMB", "azureContainerInfo": { "containerName": "testContainerSMB", "dataFormat": "BlockBlob", "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1" }, "clientAccessRights": [], "dataPolicy": "Cloud", "description": "", "monitoringStatus": "Disabled", "refreshDetails": {}, "shareMappings": [], "shareStatus": "Online", "userAccessRights": [ { "accessType": "Change", "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2" } ] }, "type": "dataBoxEdgeDevices/shares" } } } } } }, "put": { "operationId": "Shares_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The share name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The share properties.", "in": "body", "name": "share", "required": true, "schema": { "$ref": "#/definitions/Share" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the share.", "schema": { "$ref": "#/definitions/Share" } }, "202": { "description": "Accepted the request to create or update the share." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Creates a new share or updates an existing share on the device.", "tags": [ "Shares" ], "x-ms-examples": { "SharePut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "smbshare", "resourceGroupName": "GroupForEdgeAutomation", "share": { "properties": { "accessProtocol": "SMB", "azureContainerInfo": { "containerName": "testContainerSMB", "dataFormat": "BlockBlob", "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1" }, "dataPolicy": "Cloud", "description": "", "monitoringStatus": "Enabled", "shareStatus": "Online", "userAccessRights": [ { "accessType": "Change", "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2" } ] } }, "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", "name": "smbshare", "properties": { "accessProtocol": "SMB", "azureContainerInfo": { "containerName": "testContainerSMB", "dataFormat": "BlockBlob", "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1" }, "clientAccessRights": [], "dataPolicy": "Cloud", "description": "", "monitoringStatus": "Disabled", "refreshDetails": {}, "shareMappings": [], "shareStatus": "Online", "userAccessRights": [ { "accessType": "Change", "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2" } ] }, "type": "dataBoxEdgeDevices/shares" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { "post": { "operationId": "Shares_Refresh", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The share name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully refreshed the share on the device." }, "202": { "description": "Accepted the request to refresh the share on the device." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Refreshes the share metadata with the data from the cloud.", "tags": [ "Shares" ], "x-ms-examples": { "ShareRefreshPost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "smbshare", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { "get": { "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The collection of storage account credentials.", "schema": { "$ref": "#/definitions/StorageAccountCredentialList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets all the storage account credentials in a data box edge/gateway device.", "tags": [ "StorageAccountCredentials" ], "x-ms-examples": { "SACGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", "name": "sac1128180128323", "properties": { "accountType": "GeneralPurposeStorage", "alias": "sac1128180128323", "sslStatus": "Disabled", "userName": "cisbvt" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" }, { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", "name": "sac1128180128312", "properties": { "accountType": "BlobStorage", "alias": "sac1128180128312", "sslStatus": "Disabled", "userName": "cisbvt" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { "delete": { "description": "Deletes the storage account credential.", "operationId": "StorageAccountCredentials_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The storage account credential name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the storage account credential." }, "202": { "description": "Accepted the request to delete the storage account credential." }, "204": { "description": "The storage account credential is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "StorageAccountCredentials" ], "x-ms-examples": { "SACDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "sac1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the properties of the specified storage account credential.", "operationId": "StorageAccountCredentials_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The storage account credential name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The storage account credential properties.", "schema": { "$ref": "#/definitions/StorageAccountCredential" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "StorageAccountCredentials" ], "x-ms-examples": { "SACGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "sac1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", "name": "sac1", "properties": { "accountType": "BlobStorage", "alias": "sac1", "sslStatus": "Disabled", "userName": "cisbvt" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" } } } } } }, "put": { "description": "Creates or updates the storage account credential.", "operationId": "StorageAccountCredentials_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The storage account credential name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The storage account credential.", "in": "body", "name": "storageAccountCredential", "required": true, "schema": { "$ref": "#/definitions/StorageAccountCredential" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the storage account credential.", "schema": { "$ref": "#/definitions/StorageAccountCredential" } }, "202": { "description": "Accepted the request to create or update the storage account credential." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "StorageAccountCredentials" ], "x-ms-examples": { "SACPut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "sac1", "resourceGroupName": "GroupForEdgeAutomation", "storageAccountCredential": { "properties": { "accountKey": { "encryptionAlgorithm": "AES256", "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==" }, "accountType": "BlobStorage", "alias": "sac1", "sslStatus": "Disabled", "userName": "cisbvt" } }, "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", "name": "sac1", "properties": { "accountType": "BlobStorage", "alias": "sac1", "sslStatus": "Disabled", "userName": "cisbvt" }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { "get": { "description": "Lists all the triggers configured in the device.", "operationId": "Triggers_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property", "in": "query", "name": "$expand", "required": false, "type": "string" } ], "responses": { "200": { "description": "List all the triggers configured in the device", "schema": { "$ref": "#/definitions/TriggerList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Triggers" ], "x-ms-examples": { "TriggerGetAllInDevice": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", "kind": "FileEvent", "name": "trigger1", "properties": { "customContextTag": "CustomContextTags-1235346475", "sinkInfo": { "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" }, "sourceInfo": { "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" } }, "type": "dataBoxEdgeDevices/triggers" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { "delete": { "description": "Deletes the trigger on the gateway device.", "operationId": "Triggers_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The trigger name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the trigger." }, "202": { "description": "Accepted the request to delete the trigger." }, "204": { "description": "The trigger is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Triggers" ], "x-ms-examples": { "TriggerDelete": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "trigger1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Get a specific trigger by name.", "operationId": "Triggers_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The trigger name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The trigger.", "schema": { "$ref": "#/definitions/Trigger" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Triggers" ], "x-ms-examples": { "TriggerGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "trigger1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", "kind": "FileEvent", "name": "trigger1", "properties": { "customContextTag": "CustomContextTags-1235346475", "sinkInfo": { "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" }, "sourceInfo": { "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" } }, "type": "dataBoxEdgeDevices/triggers" } } } } } }, "put": { "description": "Creates or updates a trigger.", "operationId": "Triggers_CreateOrUpdate", "parameters": [ { "description": "Creates or updates a trigger", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The trigger name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The trigger.", "in": "body", "name": "trigger", "required": true, "schema": { "$ref": "#/definitions/Trigger" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the trigger.", "schema": { "$ref": "#/definitions/Trigger" } }, "202": { "description": "Accepted the request to create or update the trigger." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Triggers" ], "x-ms-examples": { "TriggerPut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "trigger1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "trigger": { "kind": "FileEvent", "properties": { "customContextTag": "CustomContextTags-1235346475", "sinkInfo": { "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" }, "sourceInfo": { "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" } } }, "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", "kind": "FileEvent", "name": "trigger1", "properties": { "customContextTag": "CustomContextTags-1235346475", "sinkInfo": { "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" }, "sourceInfo": { "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" } }, "type": "dataBoxEdgeDevices/triggers" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { "get": { "operationId": "Devices_GetUpdateSummary", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The update summary.", "schema": { "$ref": "#/definitions/UpdateSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "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.", "tags": [ "Devices" ], "x-ms-examples": { "UpdateSummaryGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "parameters": { "properties": { "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" } }, "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", "name": "default", "properties": { "deviceVersionNumber": "1.2.18183.2", "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", "ongoingUpdateOperation": "None", "rebootBehavior": "NeverReboots", "totalNumberOfUpdatesAvailable": 0, "totalNumberOfUpdatesPendingDownload": 0, "totalNumberOfUpdatesPendingInstall": 0, "totalUpdateSizeInBytes": 0 }, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { "post": { "description": "Uploads registration certificate for the device.", "operationId": "Devices_UploadCertificate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The upload certificate request.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/UploadCertificateRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully uploaded the registration certificate.", "schema": { "$ref": "#/definitions/UploadCertificateResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Devices" ], "x-ms-examples": { "UploadCertificatePost": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "parameters": { "properties": { "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" } }, "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "aadAuthority": "https://login.windows.net", "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", "authType": "AzureActiveDirectory", "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/", "resourceId": "392799901267771", "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { "get": { "description": "Gets all the users registered on a data box edge/gateway device.", "operationId": "Users_ListByDataBoxEdgeDevice", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The collection of all users on the device.", "schema": { "$ref": "#/definitions/UserList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Users" ], "x-ms-examples": { "OperationsGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", "name": "user2", "properties": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" }, { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", "name": "user1", "properties": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { "delete": { "description": "Deletes the user on a databox edge/gateway device.", "operationId": "Users_Delete", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The user name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the user." }, "202": { "description": "Accepted the request to delete the user." }, "204": { "description": "The user is already deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Users" ], "x-ms-examples": { "UserDelete": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "user1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": {}, "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the properties of the specified user.", "operationId": "Users_Get", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The user name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The user details.", "schema": { "$ref": "#/definitions/User" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Users" ], "x-ms-examples": { "UserGet": { "parameters": { "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "user1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "202": { "body": "" }, "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", "name": "user1", "properties": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" } } } } } }, "put": { "description": "Creates a new user or updates an existing user's information on a data box edge/gateway device.", "operationId": "Users_CreateOrUpdate", "parameters": [ { "description": "The device name.", "in": "path", "name": "deviceName", "required": true, "type": "string" }, { "description": "The user name.", "in": "path", "name": "name", "required": true, "type": "string" }, { "description": "The user details.", "in": "body", "name": "user", "required": true, "schema": { "$ref": "#/definitions/User" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully created or updated the user.", "schema": { "$ref": "#/definitions/User" } }, "202": { "description": "Accepted the request to create or update the user." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Users" ], "x-ms-examples": { "UserPut": { "parameters": { "Content-Length": [ "200" ], "Content-Type": [ "application/json; charset=utf-8" ], "accept-language": [ "en-US" ], "api-version": "2019-03-01", "deviceName": "testedgedevice", "name": "user1", "resourceGroupName": "GroupForEdgeAutomation", "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", "user": { "properties": { "encryptedPassword": { "encryptionAlgorithm": "None", "encryptionCertThumbprint": "blah", "value": "Password@1" }, "shareAccessRights": [] } }, "x-ms-client-request-id": [ "a93b39a3-1ff4-42b8-a56f-43368d47e37a" ] }, "responses": { "200": { "body": { "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", "name": "user1", "properties": {}, "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" } }, "202": {} } } }, "x-ms-long-running-operation": true } } }, "definitions": { "ARMBaseModel": { "description": "Represents the base class for all object models.", "properties": { "id": { "description": "The path ID that uniquely identifies the object.", "readOnly": true, "type": "string" }, "name": { "description": "The object name.", "readOnly": true, "type": "string" }, "type": { "description": "The hierarchical type of the object.", "readOnly": true, "type": "string" } }, "type": "object", "x-ms-azure-resource": true }, "Address": { "description": "The shipping address of the customer.", "properties": { "addressLine1": { "description": "The address line1.", "type": "string" }, "addressLine2": { "description": "The address line2.", "type": "string" }, "addressLine3": { "description": "The address line3.", "type": "string" }, "city": { "description": "The city name.", "type": "string" }, "country": { "description": "The country name.", "type": "string" }, "postalCode": { "description": "The postal code.", "type": "string" }, "state": { "description": "The state name.", "type": "string" } }, "required": [ "addressLine1", "postalCode", "city", "state", "country" ], "type": "object" }, "Alert": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Alert on the data box edge/gateway device.", "properties": { "properties": { "$ref": "#/definitions/AlertProperties", "description": "Properties of alert.", "readOnly": true, "x-ms-client-flatten": true } }, "type": "object" }, "AlertErrorDetails": { "description": "Error details for the alert.", "properties": { "errorCode": { "description": "Error code.", "readOnly": true, "type": "string" }, "errorMessage": { "description": "Error Message.", "readOnly": true, "type": "string" }, "occurrences": { "description": "Number of occurrences.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "AlertList": { "description": "Collection of alerts.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The value.", "items": { "$ref": "#/definitions/Alert" }, "readOnly": true, "type": "array" } }, "type": "object" }, "AlertProperties": { "description": "Properties of alert.", "properties": { "alertType": { "description": "Alert type.", "readOnly": true, "type": "string" }, "appearedAtDateTime": { "description": "UTC time when the alert appeared.", "format": "date-time", "readOnly": true, "type": "string" }, "detailedInformation": { "additionalProperties": { "type": "string" }, "description": "Alert details.", "readOnly": true, "type": "object" }, "errorDetails": { "$ref": "#/definitions/AlertErrorDetails", "description": "Error details of the alert.", "readOnly": true }, "recommendation": { "description": "Alert recommendation.", "readOnly": true, "type": "string" }, "severity": { "description": "Severity of the alert.", "enum": [ "Informational", "Warning", "Critical" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AlertSeverity" } }, "title": { "description": "Alert title.", "readOnly": true, "type": "string" } }, "type": "object" }, "AsymmetricEncryptedSecret": { "description": "Represent the secrets intended for encryption with asymmetric key pair.", "properties": { "encryptionAlgorithm": { "description": "The algorithm used to encrypt \"Value\".", "enum": [ "None", "AES256", "RSAES_PKCS1_v_1_5" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "EncryptionAlgorithm" } }, "encryptionCertThumbprint": { "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.", "type": "string" }, "value": { "description": "The value of the secret.", "type": "string" } }, "required": [ "value", "encryptionAlgorithm" ], "type": "object" }, "Authentication": { "description": "Authentication mechanism for IoT devices.", "properties": { "symmetricKey": { "$ref": "#/definitions/SymmetricKey", "description": "Symmetric key for authentication." } }, "type": "object" }, "AzureContainerInfo": { "description": "Azure container mapping of the endpoint.", "properties": { "containerName": { "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).", "type": "string" }, "dataFormat": { "description": "Storage format used for the file represented by the share.", "enum": [ "BlockBlob", "PageBlob", "AzureFile" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AzureContainerDataFormat" } }, "storageAccountCredentialId": { "description": "ID of the storage account credential used to access storage.", "type": "string" } }, "required": [ "storageAccountCredentialId", "containerName", "dataFormat" ], "type": "object" }, "BandwidthSchedule": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The bandwidth schedule details.", "properties": { "properties": { "$ref": "#/definitions/BandwidthScheduleProperties", "description": "The properties of the bandwidth schedule.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "BandwidthScheduleProperties": { "description": "The properties of the bandwidth schedule.", "properties": { "days": { "description": "The days of the week when this schedule is applicable.", "items": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DayOfWeek" } }, "type": "array" }, "rateInMbps": { "description": "The bandwidth rate in Mbps.", "format": "int32", "type": "integer" }, "start": { "description": "The start time of the schedule in UTC.", "type": "string" }, "stop": { "description": "The stop time of the schedule in UTC.", "type": "string" } }, "required": [ "start", "stop", "rateInMbps", "days" ], "type": "object" }, "BandwidthSchedulesList": { "description": "The collection of bandwidth schedules.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of bandwidth schedules.", "items": { "$ref": "#/definitions/BandwidthSchedule" }, "readOnly": true, "type": "array" } }, "type": "object" }, "ClientAccessRight": { "description": "The mapping between a particular client IP and the type of access client has on the NFS share.", "properties": { "accessPermission": { "description": "Type of access to be allowed for the client.", "enum": [ "NoAccess", "ReadOnly", "ReadWrite" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ClientPermissionType" } }, "client": { "description": "IP of the client.", "type": "string" } }, "required": [ "client", "accessPermission" ], "type": "object" }, "CloudError": { "description": "An error response from the service.", "properties": { "error": { "$ref": "#/definitions/CloudErrorBody", "description": "The error details." } }, "x-ms-external": true }, "CloudErrorBody": { "description": "An error response from the service.", "properties": { "code": { "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", "type": "string" }, "details": { "description": "A list of additional details about the error.", "items": { "$ref": "#/definitions/CloudErrorBody" }, "type": "array" }, "message": { "description": "A message describing the error, intended to be suitable for display in a user interface.", "type": "string" } }, "x-ms-external": true }, "ContactDetails": { "description": "Contains all the contact details of the customer.", "properties": { "companyName": { "description": "The name of the company.", "type": "string" }, "contactPerson": { "description": "The contact person name.", "type": "string" }, "emailList": { "description": "The email list.", "items": { "type": "string" }, "type": "array" }, "phone": { "description": "The phone number.", "type": "string" } }, "required": [ "contactPerson", "companyName", "phone", "emailList" ], "type": "object" }, "DataBoxEdgeDevice": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The Data Box Edge/Gateway device.", "properties": { "etag": { "description": "The etag for the devices.", "type": "string" }, "location": { "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.", "type": "string", "x-ms-mutability": [ "read", "create" ] }, "properties": { "$ref": "#/definitions/DataBoxEdgeDeviceProperties", "description": "The properties of the Data Box Edge/Gateway device.", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU type." }, "tags": { "additionalProperties": { "type": "string" }, "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).", "type": "object" } }, "required": [ "location" ], "type": "object" }, "DataBoxEdgeDeviceExtendedInfo": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The extended Info of the Data Box Edge/Gateway device.", "properties": { "properties": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", "description": "The extended info properties.", "x-ms-client-flatten": true } }, "type": "object" }, "DataBoxEdgeDeviceExtendedInfoProperties": { "description": "The properties of the Data Box Edge/Gateway device extended info.", "properties": { "encryptionKey": { "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.", "type": "string" }, "encryptionKeyThumbprint": { "description": "The digital signature of encrypted certificate.", "type": "string" }, "resourceKey": { "description": "The Resource ID of the Resource.", "readOnly": true, "type": "string" } }, "type": "object" }, "DataBoxEdgeDeviceList": { "description": "The collection of Data Box Edge/Gateway devices.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of Data Box Edge/Gateway devices.", "items": { "$ref": "#/definitions/DataBoxEdgeDevice" }, "readOnly": true, "type": "array" } }, "type": "object" }, "DataBoxEdgeDevicePatch": { "description": "The Data Box Edge/Gateway device patch.", "properties": { "tags": { "additionalProperties": { "type": "string" }, "description": "The tags attached to the Data Box Edge/Gateway resource.", "type": "object" } }, "type": "object" }, "DataBoxEdgeDeviceProperties": { "description": "The properties of the Data Box Edge/Gateway device.", "properties": { "configuredRoleTypes": { "description": "Type of compute roles configured.", "items": { "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "RoleTypes" } }, "readOnly": true, "type": "array" }, "culture": { "description": "The Data Box Edge/Gateway device culture.", "readOnly": true, "type": "string" }, "dataBoxEdgeDeviceStatus": { "description": "The status of the Data Box Edge/Gateway device.", "enum": [ "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DataBoxEdgeDeviceStatus" } }, "description": { "description": "The Description of the Data Box Edge/Gateway device.", "type": "string" }, "deviceHcsVersion": { "description": "The device software version number of the device (eg: 1.2.18105.6).", "readOnly": true, "type": "string" }, "deviceLocalCapacity": { "description": "The Data Box Edge/Gateway device local capacity in MB.", "format": "int64", "readOnly": true, "type": "integer" }, "deviceModel": { "description": "The Data Box Edge/Gateway device model.", "readOnly": true, "type": "string" }, "deviceSoftwareVersion": { "description": "The Data Box Edge/Gateway device software version.", "readOnly": true, "type": "string" }, "deviceType": { "description": "The type of the Data Box Edge/Gateway device.", "enum": [ "DataBoxEdgeDevice" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DeviceType" } }, "friendlyName": { "description": "The Data Box Edge/Gateway device name.", "type": "string" }, "modelDescription": { "description": "The description of the Data Box Edge/Gateway device model.", "type": "string" }, "serialNumber": { "description": "The Serial Number of Data Box Edge/Gateway device.", "readOnly": true, "type": "string" }, "timeZone": { "description": "The Data Box Edge/Gateway device timezone.", "readOnly": true, "type": "string" } }, "type": "object" }, "FileEventTrigger": { "allOf": [ { "$ref": "#/definitions/Trigger" } ], "description": "Trigger details.", "properties": { "id": { "description": "The path ID that uniquely identifies the object.", "readOnly": true, "type": "string" }, "name": { "description": "The object name.", "readOnly": true, "type": "string" }, "properties": { "$ref": "#/definitions/FileTriggerProperties", "description": "File trigger properties.", "x-ms-client-flatten": true }, "type": { "description": "The hierarchical type of the object.", "readOnly": true, "type": "string" } }, "required": [ "properties", "kind" ], "type": "object", "x-ms-discriminator-value": "FileEvent" }, "FileSourceInfo": { "description": "File source details.", "properties": { "shareId": { "description": "File share ID.", "type": "string" } }, "required": [ "shareId" ], "type": "object" }, "FileTriggerProperties": { "description": "File trigger properties.", "properties": { "customContextTag": { "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", "type": "string" }, "sinkInfo": { "$ref": "#/definitions/RoleSinkInfo", "description": "Role sink info." }, "sourceInfo": { "$ref": "#/definitions/FileSourceInfo", "description": "File event source details." } }, "required": [ "sourceInfo", "sinkInfo" ], "type": "object" }, "IoTDeviceInfo": { "description": "Metadata of IoT device/IoT Edge device to be configured.", "properties": { "authentication": { "$ref": "#/definitions/Authentication", "description": "IoT device authentication info." }, "deviceId": { "description": "ID of the IoT device/edge device.", "type": "string" }, "ioTHostHub": { "description": "Host name for the IoT hub associated to the device.", "type": "string" } }, "required": [ "deviceId", "ioTHostHub" ], "type": "object" }, "IoTRole": { "allOf": [ { "$ref": "#/definitions/Role" } ], "description": "Compute role.", "properties": { "id": { "description": "The path ID that uniquely identifies the object.", "readOnly": true, "type": "string" }, "name": { "description": "The object name.", "readOnly": true, "type": "string" }, "properties": { "$ref": "#/definitions/IoTRoleProperties", "description": "Properties specific to IoT role.", "x-ms-client-flatten": true }, "type": { "description": "The hierarchical type of the object.", "readOnly": true, "type": "string" } }, "required": [ "kind" ], "type": "object", "x-ms-discriminator-value": "IOT" }, "IoTRoleProperties": { "description": "IoT role properties.", "properties": { "hostPlatform": { "description": "Host OS supported by the IoT role.", "enum": [ "Windows", "Linux" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "PlatformType" } }, "ioTDeviceDetails": { "$ref": "#/definitions/IoTDeviceInfo", "description": "IoT device metadata to which data box edge device needs to be connected." }, "ioTEdgeDeviceDetails": { "$ref": "#/definitions/IoTDeviceInfo", "description": "IoT edge device to which the IoT role needs to be configured." }, "roleStatus": { "description": "Role status.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "RoleStatus" } }, "shareMappings": { "description": "Mount points of shares in role(s).", "items": { "$ref": "#/definitions/MountPointMap" }, "type": "array" } }, "required": [ "hostPlatform", "ioTDeviceDetails", "ioTEdgeDeviceDetails", "roleStatus" ], "type": "object" }, "Ipv4Config": { "description": "Details related to the IPv4 address configuration.", "properties": { "gateway": { "description": "The IPv4 gateway of the network adapter.", "readOnly": true, "type": "string" }, "ipAddress": { "description": "The IPv4 address of the network adapter.", "readOnly": true, "type": "string" }, "subnet": { "description": "The IPv4 subnet of the network adapter.", "readOnly": true, "type": "string" } }, "type": "object" }, "Ipv6Config": { "description": "Details related to the IPv6 address configuration.", "properties": { "gateway": { "description": "The IPv6 gateway of the network adapter.", "readOnly": true, "type": "string" }, "ipAddress": { "description": "The IPv6 address of the network adapter.", "readOnly": true, "type": "string" }, "prefixLength": { "description": "The IPv6 prefix of the network adapter.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "Job": { "description": "A device job.", "properties": { "endTime": { "description": "The UTC date and time at which the job completed.", "format": "date-time", "readOnly": true, "type": "string" }, "error": { "$ref": "#/definitions/JobErrorDetails", "description": "The error details.", "readOnly": true }, "id": { "description": "The path ID that uniquely identifies the object.", "readOnly": true, "type": "string" }, "name": { "description": "The name of the object.", "readOnly": true, "type": "string" }, "percentComplete": { "description": "The percentage of the job that is complete.", "format": "int32", "readOnly": true, "type": "integer" }, "properties": { "$ref": "#/definitions/JobProperties", "description": "The properties of the job.", "readOnly": true, "x-ms-client-flatten": true }, "startTime": { "description": "The UTC date and time at which the job started.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "The current status of the job.", "enum": [ "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", "Scheduled" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "JobStatus" } }, "type": { "description": "The hierarchical type of the object.", "readOnly": true, "type": "string" } }, "type": "object" }, "JobErrorDetails": { "description": "The job error information containing the list of job errors.", "properties": { "code": { "description": "The code intended for programmatic access.", "readOnly": true, "type": "string" }, "errorDetails": { "description": "The error details.", "items": { "$ref": "#/definitions/JobErrorItem" }, "readOnly": true, "type": "array" }, "message": { "description": "The message that describes the error in detail.", "readOnly": true, "type": "string" } }, "type": "object" }, "JobErrorItem": { "description": "The job error items.", "properties": { "code": { "description": "The code intended for programmatic access.", "readOnly": true, "type": "string" }, "message": { "description": "The message that describes the error in detail.", "readOnly": true, "type": "string" }, "recommendations": { "description": "The recommended actions.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "type": "object" }, "JobProperties": { "description": "The properties for the job.", "properties": { "currentStage": { "description": "Current stage of the update operation.", "enum": [ "Unknown", "Initial", "ScanStarted", "ScanComplete", "ScanFailed", "DownloadStarted", "DownloadComplete", "DownloadFailed", "InstallStarted", "InstallComplete", "InstallFailed", "RebootInitiated", "Success", "Failure", "RescanStarted", "RescanComplete", "RescanFailed" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "UpdateOperationStage" } }, "downloadProgress": { "$ref": "#/definitions/UpdateDownloadProgress", "description": "The download progress.", "readOnly": true }, "errorManifestFile": { "description": "Local share/remote container relative path to the error manifest file of the refresh.", "readOnly": true, "type": "string" }, "folder": { "description": "If only subfolders need to be refreshed, then the subfolder path inside the share. (The path is empty if there are no subfolders.)", "type": "string" }, "installProgress": { "$ref": "#/definitions/UpdateInstallProgress", "description": "The install progress.", "readOnly": true }, "jobType": { "description": "The type of the job.", "enum": [ "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "JobType" } }, "shareId": { "description": "ARM ID of the share that was refreshed.", "readOnly": true, "type": "string" }, "totalRefreshErrors": { "description": "Total number of errors encountered during the refresh process.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "MetricDimension_V1": { "description": "Metric Dimension v1.", "properties": { "displayName": { "description": "Display name of the metrics dimension.", "type": "string" }, "name": { "description": "Name of the metrics dimension.", "type": "string" }, "toBeExportedForShoebox": { "description": "To be exported to shoe box.", "type": "boolean" } }, "type": "object" }, "MetricSpecification_V1": { "description": "Metric specification version 1.", "properties": { "aggregationType": { "description": "Metric aggregation type.", "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MetricAggregationType" } }, "category": { "description": "Metric category.", "enum": [ "Capacity", "Transaction" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MetricCategory" } }, "dimensions": { "description": "Metric dimensions, other than default dimension which is resource.", "items": { "$ref": "#/definitions/MetricDimension_V1" }, "type": "array" }, "displayDescription": { "description": "Description of the metric to be displayed.", "type": "string" }, "displayName": { "description": "Display name of the metric.", "type": "string" }, "fillGapWithZero": { "description": "Set true to fill the gaps with zero.", "type": "boolean" }, "name": { "description": "Name of the metric.", "type": "string" }, "resourceIdDimensionNameOverride": { "description": "Resource name override.", "type": "string" }, "supportedAggregationTypes": { "description": "Support metric aggregation type.", "items": { "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MetricAggregationType" } }, "type": "array" }, "supportedTimeGrainTypes": { "description": "Support granularity of metrics.", "items": { "enum": [ "PT1M", "PT5M", "PT15M", "PT30M", "PT1H", "PT6H", "PT12H", "PT1D" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "TimeGrain" } }, "type": "array" }, "unit": { "description": "Metric units.", "enum": [ "NotSpecified", "Percent", "Count", "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", "CountPerSecond" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MetricUnit" } } }, "type": "object" }, "MountPointMap": { "description": "The share mount point.", "properties": { "mountPoint": { "description": "Mount point for the share.", "readOnly": true, "type": "string" }, "roleId": { "description": "ID of the role to which share is mounted.", "readOnly": true, "type": "string" }, "roleType": { "description": "Role type.", "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "RoleTypes" } }, "shareId": { "description": "ID of the share mounted to the role VM.", "type": "string" } }, "required": [ "shareId" ], "type": "object" }, "NetworkAdapter": { "description": "Represents the networkAdapter on a device.", "properties": { "adapterId": { "description": "Instance ID of network adapter.", "readOnly": true, "type": "string" }, "adapterPosition": { "$ref": "#/definitions/NetworkAdapterPosition", "description": "Hardware position of network adapter.", "readOnly": true }, "dhcpStatus": { "description": "Value indicating whether this adapter has DHCP enabled.", "enum": [ "Disabled", "Enabled" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "NetworkAdapterDHCPStatus" } }, "dnsServers": { "description": "The list of DNS Servers of the device.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "index": { "description": "Logical index of the adapter.", "format": "int32", "readOnly": true, "type": "integer" }, "ipv4Configuration": { "$ref": "#/definitions/Ipv4Config", "description": "The IPv4 configuration of the network adapter.", "readOnly": true }, "ipv6Configuration": { "$ref": "#/definitions/Ipv6Config", "description": "The IPv6 configuration of the network adapter.", "readOnly": true }, "ipv6LinkLocalAddress": { "description": "The IPv6 local address.", "readOnly": true, "type": "string" }, "label": { "description": "Hardware label for the adapter.", "readOnly": true, "type": "string" }, "linkSpeed": { "description": "Link speed.", "format": "int64", "readOnly": true, "type": "integer" }, "macAddress": { "description": "MAC address.", "readOnly": true, "type": "string" }, "networkAdapterName": { "description": "Network adapter name.", "readOnly": true, "type": "string" }, "nodeId": { "description": "Node ID of the network adapter.", "readOnly": true, "type": "string" }, "rdmaStatus": { "description": "Value indicating whether this adapter is RDMA capable.", "enum": [ "Incapable", "Capable" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "NetworkAdapterRDMAStatus" } }, "status": { "description": "Value indicating whether this adapter is valid.", "enum": [ "Inactive", "Active" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "NetworkAdapterStatus" } } }, "type": "object" }, "NetworkAdapterPosition": { "description": "The network adapter position.", "properties": { "networkGroup": { "description": "The network group.", "enum": [ "None", "NonRDMA", "RDMA" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "NetworkGroup" } }, "port": { "description": "The port.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "NetworkSettings": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The network settings of a device.", "properties": { "properties": { "$ref": "#/definitions/NetworkSettingsProperties", "description": "The properties of network settings of a device.", "readOnly": true, "x-ms-client-flatten": true } }, "type": "object" }, "NetworkSettingsProperties": { "description": "The properties of network settings.", "properties": { "networkAdapters": { "description": "The network adapter list on the device.", "items": { "$ref": "#/definitions/NetworkAdapter" }, "readOnly": true, "type": "array" } }, "type": "object" }, "Operation": { "description": "Operations.", "properties": { "display": { "$ref": "#/definitions/OperationDisplay", "description": "Properties displayed for the operation." }, "name": { "description": "Name of the operation.", "type": "string" }, "origin": { "description": "Origin of the operation.", "type": "string" }, "properties": { "$ref": "#/definitions/OperationProperties", "description": "Operation properties.", "x-ms-client-flatten": true } }, "type": "object" }, "OperationDisplay": { "description": "Operation display properties.", "properties": { "description": { "description": "Description of the operation to be performed.", "type": "string" }, "operation": { "description": "Operation to be performed on the resource.", "type": "string" }, "provider": { "description": "Provider name.", "type": "string" }, "resource": { "description": "The type of resource in which the operation is performed.", "type": "string" } }, "type": "object" }, "OperationProperties": { "description": "Operation properties.", "properties": { "serviceSpecification": { "$ref": "#/definitions/ServiceSpecification", "description": "Service specification." } }, "type": "object" }, "OperationsList": { "description": "The list of operations used for the discovery of available provider operations.", "properties": { "nextLink": { "description": "Link to the next set of results.", "type": "string" }, "value": { "description": "The value.", "items": { "$ref": "#/definitions/Operation" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "Order": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The order details.", "properties": { "properties": { "$ref": "#/definitions/OrderProperties", "description": "The order properties.", "x-ms-client-flatten": true } }, "type": "object" }, "OrderList": { "description": "List of order entities.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of orders.", "items": { "$ref": "#/definitions/Order" }, "readOnly": true, "type": "array" } }, "type": "object" }, "OrderProperties": { "description": "Order properties.", "properties": { "contactInformation": { "$ref": "#/definitions/ContactDetails", "description": "The contact details." }, "currentStatus": { "$ref": "#/definitions/OrderStatus", "description": "Current status of the order." }, "deliveryTrackingInfo": { "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.", "items": { "$ref": "#/definitions/TrackingInfo" }, "readOnly": true, "type": "array" }, "orderHistory": { "description": "List of status changes in the order.", "items": { "$ref": "#/definitions/OrderStatus" }, "readOnly": true, "type": "array" }, "returnTrackingInfo": { "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.", "items": { "$ref": "#/definitions/TrackingInfo" }, "readOnly": true, "type": "array" }, "serialNumber": { "description": "Serial number of the device.", "readOnly": true, "type": "string" }, "shippingAddress": { "$ref": "#/definitions/Address", "description": "The shipping address." } }, "required": [ "contactInformation", "shippingAddress" ], "type": "object" }, "OrderStatus": { "description": "Represents a single status change.", "properties": { "comments": { "description": "Comments related to this status change.", "type": "string" }, "status": { "description": "Status of the order as per the allowed status types.", "enum": [ "Untracked", "AwaitingFulfilment", "AwaitingPreparation", "AwaitingShipment", "Shipped", "Arriving", "Delivered", "ReplacementRequested", "LostDevice", "Declined", "ReturnInitiated", "AwaitingReturnShipment", "ShippedBack", "CollectedAtMicrosoft" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "OrderState" } }, "updateDateTime": { "description": "Time of status update.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "status" ], "type": "object" }, "PeriodicTimerEventTrigger": { "allOf": [ { "$ref": "#/definitions/Trigger" } ], "description": "Trigger details.", "properties": { "id": { "description": "The path ID that uniquely identifies the object.", "readOnly": true, "type": "string" }, "name": { "description": "The object name.", "readOnly": true, "type": "string" }, "properties": { "$ref": "#/definitions/PeriodicTimerProperties", "description": "Periodic timer trigger properties.", "x-ms-client-flatten": true }, "type": { "description": "The hierarchical type of the object.", "readOnly": true, "type": "string" } }, "required": [ "properties", "kind" ], "type": "object", "x-ms-discriminator-value": "PeriodicTimerEvent" }, "PeriodicTimerProperties": { "description": "Periodic timer trigger properties.", "properties": { "customContextTag": { "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", "type": "string" }, "sinkInfo": { "$ref": "#/definitions/RoleSinkInfo", "description": "Role Sink information." }, "sourceInfo": { "$ref": "#/definitions/PeriodicTimerSourceInfo", "description": "Periodic timer details." } }, "required": [ "sourceInfo", "sinkInfo" ], "type": "object" }, "PeriodicTimerSourceInfo": { "description": "Periodic timer event source.", "properties": { "schedule": { "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.", "type": "string" }, "startTime": { "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.", "format": "date-time", "type": "string" }, "topic": { "description": "Topic where periodic events are published to IoT device.", "type": "string" } }, "required": [ "startTime", "schedule" ], "type": "object" }, "RawCertificateData": { "description": "Raw Certificate Data.", "properties": { "authenticationType": { "description": "The authentication type.", "enum": [ "Invalid", "AzureActiveDirectory" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AuthenticationType" } }, "certificate": { "description": "The base64 encoded certificate raw data.", "type": "string" } }, "required": [ "certificate" ], "type": "object" }, "RefreshDetails": { "description": "Fields for tracking refresh job on the share.", "properties": { "errorManifestFile": { "description": "Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job.", "type": "string" }, "inProgressRefreshJobId": { "description": "If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.", "type": "string" }, "lastCompletedRefreshJobTimeInUTC": { "description": "Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job.", "format": "date-time", "type": "string" }, "lastJob": { "description": "Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job.", "type": "string" } }, "type": "object" }, "Role": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Compute role.", "discriminator": "kind", "properties": { "kind": { "description": "Role type.", "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "RoleTypes" } } }, "required": [ "kind" ], "type": "object" }, "RoleList": { "description": "Collection of all the roles on the Data Box Edge device.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The Value.", "items": { "$ref": "#/definitions/Role" }, "readOnly": true, "type": "array" } }, "type": "object" }, "RoleSinkInfo": { "description": "Compute role against which events will be raised.", "properties": { "roleId": { "description": "Compute role ID.", "type": "string" } }, "required": [ "roleId" ], "type": "object" }, "SecuritySettings": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The security settings of a device.", "properties": { "properties": { "$ref": "#/definitions/SecuritySettingsProperties", "description": "Properties of the security settings.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "SecuritySettingsProperties": { "description": "The properties of security settings.", "properties": { "deviceAdminPassword": { "$ref": "#/definitions/AsymmetricEncryptedSecret", "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." } }, "required": [ "deviceAdminPassword" ], "type": "object" }, "ServiceSpecification": { "description": "Service specification.", "properties": { "metricSpecifications": { "description": "Metric specification as defined by shoebox.", "items": { "$ref": "#/definitions/MetricSpecification_V1" }, "type": "array" } }, "type": "object" }, "Share": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Represents a share on the Data Box Edge/Gateway device.", "properties": { "properties": { "$ref": "#/definitions/ShareProperties", "description": "The share properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "ShareAccessRight": { "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", "properties": { "accessType": { "description": "Type of access to be allowed on the share for this user.", "enum": [ "Change", "Read", "Custom" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ShareAccessType" } }, "shareId": { "description": "The share ID.", "type": "string" } }, "required": [ "shareId", "accessType" ], "type": "object" }, "ShareList": { "description": "Collection of all the shares on the Data Box Edge/Gateway device.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of shares.", "items": { "$ref": "#/definitions/Share" }, "readOnly": true, "type": "array" } }, "type": "object" }, "ShareProperties": { "description": "The share properties.", "properties": { "accessProtocol": { "description": "Access protocol to be used by the share.", "enum": [ "SMB", "NFS" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ShareAccessProtocol" } }, "azureContainerInfo": { "$ref": "#/definitions/AzureContainerInfo", "description": "Azure container mapping for the share." }, "clientAccessRights": { "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).", "items": { "$ref": "#/definitions/ClientAccessRight" }, "type": "array" }, "dataPolicy": { "description": "Data policy of the share.", "enum": [ "Cloud", "Local" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DataPolicy" } }, "description": { "description": "Description for the share.", "type": "string" }, "monitoringStatus": { "description": "Current monitoring status of the share.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MonitoringStatus" } }, "refreshDetails": { "$ref": "#/definitions/RefreshDetails", "description": "Details of the refresh job on this share." }, "shareMappings": { "description": "Share mount point to the role.", "items": { "$ref": "#/definitions/MountPointMap" }, "readOnly": true, "type": "array" }, "shareStatus": { "description": "Current status of the share.", "enum": [ "Online", "Offline" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ShareStatus" } }, "userAccessRights": { "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).", "items": { "$ref": "#/definitions/UserAccessRight" }, "type": "array" } }, "required": [ "shareStatus", "monitoringStatus", "accessProtocol" ], "type": "object" }, "Sku": { "description": "The SKU type.", "properties": { "name": { "description": "SKU name.", "enum": [ "Gateway", "Edge" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "SkuName" } }, "tier": { "description": "The SKU tier. This is based on the SKU name.", "enum": [ "Standard" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "SkuTier" } } }, "type": "object" }, "StorageAccountCredential": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "The storage account credential.", "properties": { "properties": { "$ref": "#/definitions/StorageAccountCredentialProperties", "description": "The storage account credential properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "StorageAccountCredentialList": { "description": "The collection of storage account credentials.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The value.", "items": { "$ref": "#/definitions/StorageAccountCredential" }, "readOnly": true, "type": "array" } }, "type": "object" }, "StorageAccountCredentialProperties": { "description": "The storage account credential properties.", "properties": { "accountKey": { "$ref": "#/definitions/AsymmetricEncryptedSecret", "description": "Encrypted storage key." }, "accountType": { "description": "Type of storage accessed on the storage account.", "enum": [ "GeneralPurposeStorage", "BlobStorage" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AccountType" } }, "alias": { "description": "Alias for the storage account.", "type": "string" }, "blobDomainName": { "description": "Blob end point for private clouds.", "type": "string" }, "connectionString": { "description": "Connection string for the storage account. Use this string if username and account key are not specified.", "type": "string" }, "sslStatus": { "description": "Signifies whether SSL needs to be enabled or not.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "SSLStatus" } }, "userName": { "description": "Username for the storage account.", "type": "string" } }, "required": [ "alias", "sslStatus", "accountType" ], "type": "object" }, "SymmetricKey": { "description": "Symmetric key for authentication.", "properties": { "connectionString": { "$ref": "#/definitions/AsymmetricEncryptedSecret", "description": "Connection string based on the symmetric key." } }, "type": "object" }, "TrackingInfo": { "description": "Tracking courier information.", "properties": { "carrierName": { "description": "Name of the carrier used in the delivery.", "type": "string" }, "serialNumber": { "description": "Serial number of the device being tracked.", "type": "string" }, "trackingId": { "description": "Tracking ID of the shipment.", "type": "string" }, "trackingUrl": { "description": "Tracking URL of the shipment.", "type": "string" } }, "type": "object" }, "Trigger": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Trigger details.", "discriminator": "kind", "properties": { "kind": { "description": "Trigger Kind.", "enum": [ "FileEvent", "PeriodicTimerEvent" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "TriggerEventType" } } }, "required": [ "kind" ], "type": "object" }, "TriggerList": { "description": "Collection of all trigger on the data box edge device.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of triggers.", "items": { "$ref": "#/definitions/Trigger" }, "readOnly": true, "type": "array" } }, "type": "object" }, "UpdateDownloadProgress": { "description": "Details about the download progress of update.", "properties": { "downloadPhase": { "description": "The download phase.", "enum": [ "Unknown", "Initializing", "Downloading", "Verifying" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DownloadPhase" } }, "numberOfUpdatesDownloaded": { "description": "Number of updates downloaded.", "format": "int32", "readOnly": true, "type": "integer" }, "numberOfUpdatesToDownload": { "description": "Number of updates to download.", "format": "int32", "readOnly": true, "type": "integer" }, "percentComplete": { "description": "Percentage of completion.", "format": "int32", "readOnly": true, "type": "integer" }, "totalBytesDownloaded": { "description": "Total bytes downloaded.", "format": "double", "readOnly": true, "type": "number" }, "totalBytesToDownload": { "description": "Total bytes to download.", "format": "double", "readOnly": true, "type": "number" } }, "type": "object" }, "UpdateInstallProgress": { "description": "Progress details during installation of updates.", "properties": { "numberOfUpdatesInstalled": { "description": "Number of updates installed.", "format": "int32", "readOnly": true, "type": "integer" }, "numberOfUpdatesToInstall": { "description": "Number of updates to install.", "format": "int32", "readOnly": true, "type": "integer" }, "percentComplete": { "description": "Percentage completed.", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "UpdateSummary": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Details about ongoing updates and availability of updates on the device.", "properties": { "properties": { "$ref": "#/definitions/UpdateSummaryProperties", "description": "The device update information summary.", "x-ms-client-flatten": true } }, "type": "object" }, "UpdateSummaryProperties": { "description": "The device update information summary.", "properties": { "deviceLastScannedDateTime": { "description": "The last time when a scan was done on the device.", "format": "date-time", "type": "string" }, "deviceVersionNumber": { "description": "The current version of the device in format: 1.2.17312.13.\",", "type": "string" }, "friendlyDeviceVersionName": { "description": "The current version of the device in text format.", "type": "string" }, "inProgressDownloadJobId": { "description": "The job ID of the download job in progress.", "readOnly": true, "type": "string" }, "inProgressDownloadJobStartedDateTime": { "description": "The time when the currently running download (if any) started.", "format": "date-time", "readOnly": true, "type": "string" }, "inProgressInstallJobId": { "description": "The job ID of the install job in progress.", "readOnly": true, "type": "string" }, "inProgressInstallJobStartedDateTime": { "description": "The time when the currently running install (if any) started.", "format": "date-time", "readOnly": true, "type": "string" }, "lastCompletedDownloadJobDateTime": { "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", "format": "date-time", "readOnly": true, "type": "string" }, "lastCompletedInstallJobDateTime": { "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", "format": "date-time", "readOnly": true, "type": "string" }, "lastCompletedScanJobDateTime": { "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", "format": "date-time", "type": "string" }, "ongoingUpdateOperation": { "description": "The current update operation.", "enum": [ "None", "Scan", "Download", "Install" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "UpdateOperation" } }, "rebootBehavior": { "description": "Indicates if updates are available and at least one of the updates needs a reboot.", "enum": [ "NeverReboots", "RequiresReboot", "RequestReboot" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "InstallRebootBehavior" } }, "totalNumberOfUpdatesAvailable": { "description": "The number of updates available for the current device version as per the last device scan.", "format": "int32", "readOnly": true, "type": "integer" }, "totalNumberOfUpdatesPendingDownload": { "description": "The total number of items pending download.", "format": "int32", "readOnly": true, "type": "integer" }, "totalNumberOfUpdatesPendingInstall": { "description": "The total number of items pending install.", "format": "int32", "readOnly": true, "type": "integer" }, "totalUpdateSizeInBytes": { "description": "The total size of updates available for download in bytes.", "format": "double", "readOnly": true, "type": "number" }, "updateTitles": { "description": "The list of updates available for install.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "type": "object" }, "UploadCertificateRequest": { "description": "The upload certificate request.", "properties": { "properties": { "$ref": "#/definitions/RawCertificateData", "description": "The Base 64 encoded certificate raw data.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "UploadCertificateResponse": { "description": "The upload registration certificate response.", "properties": { "aadAuthority": { "description": "Azure Active Directory tenant authority.", "type": "string" }, "aadTenantId": { "description": "Azure Active Directory tenant ID.", "type": "string" }, "authType": { "description": "Specifies authentication type.", "enum": [ "Invalid", "AzureActiveDirectory" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AuthenticationType" } }, "azureManagementEndpointAudience": { "description": "The azure management endpoint audience.", "type": "string" }, "resourceId": { "description": "The resource ID of the Data Box Edge/Gateway device.", "type": "string" }, "servicePrincipalClientId": { "description": "Azure Active Directory service principal client ID.", "type": "string" }, "servicePrincipalObjectId": { "description": "Azure Active Directory service principal object ID.", "type": "string" } }, "required": [ "resourceId", "aadAuthority", "aadTenantId", "servicePrincipalClientId", "servicePrincipalObjectId", "azureManagementEndpointAudience" ], "type": "object" }, "User": { "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.", "properties": { "properties": { "$ref": "#/definitions/UserProperties", "description": "The storage account credential properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "type": "object" }, "UserAccessRight": { "description": "The mapping between a particular user and the access type on the SMB share.", "properties": { "accessType": { "description": "Type of access to be allowed for the user.", "enum": [ "Change", "Read", "Custom" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ShareAccessType" } }, "userId": { "description": "User ID (already existing in the device).", "type": "string" } }, "required": [ "userId", "accessType" ], "type": "object" }, "UserList": { "description": "Collection of users.", "properties": { "nextLink": { "description": "Link to the next set of results.", "readOnly": true, "type": "string" }, "value": { "description": "The list of users.", "items": { "$ref": "#/definitions/User" }, "readOnly": true, "type": "array" } }, "type": "object" }, "UserProperties": { "description": "The user properties.", "properties": { "encryptedPassword": { "$ref": "#/definitions/AsymmetricEncryptedSecret", "description": "The password details." }, "shareAccessRights": { "description": "List of shares that the user has rights on. This field should not be specified during user creation.", "items": { "$ref": "#/definitions/ShareAccessRight" }, "type": "array" } }, "type": "object" } } }