diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json new file mode 100644 index 000000000000..f212bd1fea77 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json @@ -0,0 +1,3998 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-07-01", + "title": "DataBoxEdgeManagementClient" + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.DataBoxEdge/operations": { + "get": { + "tags": [ "Operations" ], + "summary": "Lists all the operations supported.", + "operationId": "Operations_List", + "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationsList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ "Devices" ], + "description": "Retrieves all data box edge/gateway devices in a subscription.", + "operationId": "Devices_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/apiVersionParameter" }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "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" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetBySubscription": { + "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ "Devices" ], + "description": "Retrieves all data box edge/gateway devices in a resource group.", + "operationId": "Devices_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "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" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByResourceGroup": { + "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { + "get": { + "tags": [ "Devices" ], + "description": "Returns the properties of the data box edge/gateway device.", + "operationId": "Devices_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByName": { + "$ref": "./examples/DataBoxEdgeDeviceGetByName.json" + } + } + }, + "put": { + "tags": [ "Devices" ], + "description": "Creates or updates a Data Box Edge/Gateway resource.", + "operationId": "Devices_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "DataBoxEdgeDevice", + "in": "body", + "description": "The resource object.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDevicePut": { + "$ref": "./examples/DataBoxEdgeDevicePut.json" + } + } + }, + "delete": { + "tags": [ "Devices" ], + "description": "Deletes the data box edge/gateway device.", + "operationId": "Devices_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDeviceDelete": { + "$ref": "./examples/DataBoxEdgeDeviceDelete.json" + } + } + }, + "patch": { + "tags": [ "Devices" ], + "description": "Updates data box edge/gateway device.", + "operationId": "Devices_Update", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The device update parameters.", + "required": true, + "schema": { "$ref": "#/definitions/DataBoxEdgeDevicePatch" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The data box edge/gateway device has been successfully updated.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePatch": { + "$ref": "./examples/DataBoxEdgeDevicePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Retrieves all the alerts for a data box edge/gateway device.", + "operationId": "Alerts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "AlertGetAllInDevice": { + "$ref": "./examples/AlertGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { + "get": { + "tags": [ "Alerts" ], + "summary": "Returns an alert by name.", + "operationId": "Alerts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the alert which needs to be retrieved.", + "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" } + } + }, + "x-ms-examples": { + "AlertGet": { + "$ref": "./examples/AlertGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { + "get": { + "tags": [ "BandwidthSchedules" ], + "description": "Returns all the bandwidth Schedules for a data box edge/gateway device.", + "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of bandwidth settings.", + "schema": { "$ref": "#/definitions/BandwidthSchedulesList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "BandwidthScheduleGetAllInDevice": { + "$ref": "./examples/BandwidthScheduleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { + "get": { + "tags": [ "BandwidthSchedules" ], + "description": "Returns the properties of the specified bandwidth schedule name.", + "operationId": "BandwidthSchedules_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The bandwidth settings.", + "schema": { "$ref": "#/definitions/BandwidthSchedule" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "BandwidthScheduleGet": { + "$ref": "./examples/BandwidthScheduleGet.json" + } + } + }, + "put": { + "tags": [ "BandwidthSchedules" ], + "description": "Creates or updates a bandwidth schedule.", + "operationId": "BandwidthSchedules_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The bandwidth schedule to be added or updated.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthSchedulePut": { + "$ref": "./examples/BandwidthSchedulePut.json" + } + } + }, + "delete": { + "tags": [ "BandwidthSchedules" ], + "description": "Deletes the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule 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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthScheduleDelete": { + "$ref": "./examples/BandwidthScheduleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Downloads the updates on the data box edge/gateway device.", + "operationId": "Devices_DownloadUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DownloadUpdatesPost": { + "$ref": "./examples/DownloadUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { + "put": { + "tags": [ "Devices" ], + "description": "Creates or updates the extended info of the data box edge/gateway device.", + "operationId": "Devices_CreateOrUpdateExtendedInfo", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The device extended information.", + "required": true, + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The extended information on the device has been successfully created/updated.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ExtendedInfoPut": { + "$ref": "./examples/ExtendedInfoPut.json" + } + } + }, + "post": { + "tags": [ "Devices" ], + "description": "Returns the extended information of the specified data box edge/gateway device.", + "operationId": "Devices_GetExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The data box edge/gateway device extended information.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ExtendedInfoPost": { + "$ref": "./examples/ExtendedInfoPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Installs the updates on the data box edge/gateway device.", + "operationId": "Devices_InstallUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InstallUpdatesPost": { + "$ref": "./examples/InstallUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { + "get": { + "tags": [ "Devices" ], + "description": "Returns the network settings of the specified data box edge/gateway device.", + "operationId": "Devices_GetNetworkSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-examples": { + "NetworkSettingsGet": { + "$ref": "./examples/NetworkSettingsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { + "get": { + "tags": [ "OperationsStatus" ], + "summary": "Returns the job details of the specified job on a data box edge/gateway device.", + "operationId": "OperationsStatus_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job 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" } + } + }, + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { + "get": { + "tags": [ "Orders" ], + "summary": "List all the orders related to the device.", + "operationId": "Orders_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List all orders placed for the Data Box Edge Device", + "schema": { "$ref": "#/definitions/OrderList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OrderGetAllInDevice": { + "$ref": "./examples/OrderGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { + "get": { + "tags": [ "Orders" ], + "summary": "Get a specific order by name.", + "operationId": "Orders_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The order with specified name in the given device.", + "schema": { "$ref": "#/definitions/Order" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "OrderGet": { + "$ref": "./examples/OrderGet.json" + } + } + }, + "put": { + "tags": [ "Orders" ], + "summary": "Creates or updates an order.", + "operationId": "Orders_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the edge device for which order needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "order", + "in": "body", + "description": "Order to be added.", + "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 prder." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderPut": { + "$ref": "./examples/OrderPut.json" + } + } + }, + "delete": { + "tags": [ "Orders" ], + "summary": "Deletes the order related to the device.", + "operationId": "Orders_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderDelete": { + "$ref": "./examples/OrderDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { + "get": { + "tags": [ "Roles" ], + "description": "Lists all the roles configured in a data box edge/gateway device.", + "operationId": "Roles_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List of all roles configured in the device.", + "schema": { "$ref": "#/definitions/RoleList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "RoleGetAllInDevice": { + "$ref": "./examples/RoleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { + "get": { + "tags": [ "Roles" ], + "description": "Get a specific role by name.", + "operationId": "Roles_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of role to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The role with specified name in the given device.", + "schema": { "$ref": "#/definitions/Role" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "RoleGet": { + "$ref": "./examples/RoleGet.json" + } + } + }, + "put": { + "tags": [ "Roles" ], + "description": "Create or update a role.", + "operationId": "Roles_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device in which the role needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the role to be updated.", + "required": true, + "type": "string" + }, + { + "name": "role", + "in": "body", + "description": "Role to be added.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RolePut": { + "$ref": "./examples/RolePut.json" + } + } + }, + "delete": { + "tags": [ "Roles" ], + "description": "Deletes the role on the gateway device.", + "operationId": "Roles_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the role which needs to be deleted.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RoleDelete": { + "$ref": "./examples/RoleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Scans for updates on a data box edge/gateway device.", + "operationId": "Devices_ScanForUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ScanForUpdatesPost": { + "$ref": "./examples/ScanForUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { + "post": { + "tags": [ "Devices" ], + "description": "Updates the security settings on a data box edge/gateway device.", + "operationId": "Devices_CreateOrUpdateSecuritySettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "securitySettings", + "in": "body", + "description": "The security settings.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/SecuritySettingsUpdatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { + "get": { + "tags": [ "Shares" ], + "summary": "Lists all the shares in a data box edge/gateway device.", + "operationId": "Shares_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of all shares on the device.", + "schema": { "$ref": "#/definitions/ShareList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/ShareGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { + "get": { + "tags": [ "Shares" ], + "summary": "Returns a particular share by name.", + "operationId": "Shares_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The share.", + "schema": { "$ref": "#/definitions/Share" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ShareGet": { + "$ref": "./examples/ShareGet.json" + } + } + }, + "put": { + "tags": [ "Shares" ], + "summary": "Creates a new share or update an existing share on the device.", + "operationId": "Shares_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "share", + "in": "body", + "description": "The share object containing the share details.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SharePut": { + "$ref": "./examples/SharePut.json" + } + } + }, + "delete": { + "tags": [ "Shares" ], + "description": "Deletes the share on the data box edge/gateway device.", + "operationId": "Shares_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share which needs to be deleted.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareDelete": { + "$ref": "./examples/ShareDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { + "post": { + "tags": [ "Shares" ], + "summary": "Triggers a manual refresh of the share metadata with the actual cloud storage account.", + "operationId": "Shares_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareRefreshPost": { + "$ref": "./examples/ShareRefreshPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { + "get": { + "tags": [ "StorageAccountCredentials" ], + "summary": "Gets all the storage account credentials in a data box edge/gateway device.", + "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "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" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "SACGetAllInDevice": { + "$ref": "./examples/SACGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { + "get": { + "tags": [ "StorageAccountCredentials" ], + "description": "Gets the properties of the specified storage account credential.", + "operationId": "StorageAccountCredentials_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the storage account credential to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The storage account credential.", + "schema": { "$ref": "#/definitions/StorageAccountCredential" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "SACGet": { + "$ref": "./examples/SACGet.json" + } + } + }, + "put": { + "tags": [ "StorageAccountCredentials" ], + "description": "Creates or updates the storage account credential.", + "operationId": "StorageAccountCredentials_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountCredential", + "in": "body", + "description": "The storage account credential to be added or updated.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACPut": { + "$ref": "./examples/SACPut.json" + } + } + }, + "delete": { + "tags": [ "StorageAccountCredentials" ], + "description": "Deletes the storage account credential.", + "operationId": "StorageAccountCredentials_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the storage account credential.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACDelete": { + "$ref": "./examples/SACDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { + "get": { + "tags": [ "Triggers" ], + "description": "List all the triggers configured in the device.", + "operationId": "Triggers_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List all triggers configured in the device", + "schema": { "$ref": "#/definitions/TriggerList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "TriggerGetAllInDevice": { + "$ref": "./examples/TriggerGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { + "get": { + "tags": [ "Triggers" ], + "description": "Get a specific trigger by name.", + "operationId": "Triggers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of trigger to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The trigger with specified name in the given device.", + "schema": { "$ref": "#/definitions/Trigger" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "TriggerGet": { + "$ref": "./examples/TriggerGet.json" + } + } + }, + "put": { + "tags": [ "Triggers" ], + "description": "Create or update a trigger.", + "operationId": "Triggers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the edge device in which trigger needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of trigger to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "trigger", + "in": "body", + "description": "Trigger to be added.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerPut": { + "$ref": "./examples/TriggerPut.json" + } + } + }, + "delete": { + "tags": [ "Triggers" ], + "description": "Deletes the trigger on the gateway device.", + "operationId": "Triggers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the trigger which needs to be deleted.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerDelete": { + "$ref": "./examples/TriggerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { + "get": { + "tags": [ "Devices" ], + "summary": "Returns information about the availability of updates as per the last scan done on the device. It also returns information about any ongoing download or install jobs on the device.", + "operationId": "Devices_GetUpdateSummary", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-examples": { + "UpdateSummaryGet": { + "$ref": "./examples/UpdateSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { + "post": { + "tags": [ "Devices" ], + "description": "Uploads registration certificate for the device.", + "operationId": "Devices_UploadCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The upload certificate request.", + "required": true, + "schema": { "$ref": "#/definitions/UploadCertificateRequest" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Uploaded the registration certificate.", + "schema": { "$ref": "#/definitions/UploadCertificateResponse" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "UploadCertificatePost": { + "$ref": "./examples/UploadCertificatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { + "get": { + "tags": [ "Users" ], + "description": "Returns all the users registered in a data box edge/gateway device.", + "operationId": "Users_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "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" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/UserGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { + "get": { + "tags": [ "Users" ], + "description": "Returns the properties of the specified user.", + "operationId": "Users_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be retrieved.", + "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" } + } + }, + "x-ms-examples": { + "UserGet": { + "$ref": "./examples/UserGet.json" + } + } + }, + "put": { + "tags": [ "Users" ], + "description": "Create a new user or update an existing user's information on a data box edge/gateway device.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The user object containing the user details and encrypted password.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserPut": { + "$ref": "./examples/UserPut.json" + } + } + }, + "delete": { + "tags": [ "Users" ], + "description": "Deletes the user on a databox edge/gateway device.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be deleted.", + "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" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserDelete": { + "$ref": "./examples/UserDelete.json" + } + } + } + } + }, + "definitions": { + "Address": { + "description": "The shipping address of the customer.", + "required": [ "addressLine1", "addressLine2", "addressLine3", "postalCode", "city", "state", "country" ], + "type": "object", + "properties": { + "addressLine1": { + "description": "The address line1.", + "type": "string" + }, + "addressLine2": { + "description": "The address line2.", + "type": "string" + }, + "addressLine3": { + "description": "The address line3.", + "type": "string" + }, + "postalCode": { + "description": "The postal code.", + "type": "string" + }, + "city": { + "description": "The city name.", + "type": "string" + }, + "state": { + "description": "The state name.", + "type": "string" + }, + "country": { + "description": "The country name.", + "type": "string" + } + } + }, + "Alert": { + "description": "Alert on the data box edge/gateway device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Properties of alert.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AlertErrorDetails": { + "description": "Error details for the alert.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message.", + "type": "string", + "readOnly": true + }, + "occurrences": { + "format": "int32", + "description": "Number of occurrences.", + "type": "integer", + "readOnly": true + } + } + }, + "AlertList": { + "description": "Collection of Alerts.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/Alert" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertProperties": { + "description": "Properties of alert.", + "type": "object", + "properties": { + "title": { + "description": "Title of the alert.", + "type": "string", + "readOnly": true + }, + "alertType": { + "description": "Type of the alert.", + "type": "string", + "readOnly": true + }, + "appearedAtDateTime": { + "format": "date-time", + "description": "UTC time at which the alert appeared.", + "type": "string", + "readOnly": true + }, + "recommendation": { + "description": "Recommendation for acting on the alert.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": "Severity of the alert.", + "enum": [ "Informational", "Warning", "Critical" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "errorDetails": { + "$ref": "#/definitions/AlertErrorDetails", + "description": "Error details of the alert.", + "readOnly": true + }, + "detailedInformation": { + "description": "Detailed information about the alert.", + "type": "object", + "additionalProperties": { "type": "string" }, + "readOnly": true + } + } + }, + "ARMBaseModel": { + "description": "Represents the base class for all object models.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "AsymmetricEncryptedSecret": { + "description": "Represent the secrets intended for encryption with asymmetric key pair.", + "required": [ "value", "encryptionAlgorithm" ], + "type": "object", + "properties": { + "value": { + "description": "The value of the secret.", + "type": "string" + }, + "encryptionCertThumbprint": { + "description": "Thumbprint certificate that was used to encrypt \"Value\". If the value in unencrypted, it will be null.", + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The algorithm used to encrypt \"Value\".", + "enum": [ "None", "AES256", "RSAES_PKCS1_v_1_5" ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": true + } + } + } + }, + "Authentication": { + "description": "Authentication mechanism for IoT devices.", + "type": "object", + "properties": { + "symmetricKey": { + "$ref": "#/definitions/SymmetricKey", + "description": "Symmetric key for authentication." + } + } + }, + "AzureContainerInfo": { + "description": "Azure container mapping of the endpoint.", + "required": [ "storageAccountCredentialId", "containerName", "dataFormat" ], + "type": "object", + "properties": { + "storageAccountCredentialId": { + "description": "ID of the Storage account credential to be used for accessing storage.", + "type": "string" + }, + "containerName": { + "description": "Container name (Based on the data format specified, represents the name of Azure file/ 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": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + } + } + }, + "BandwidthSchedule": { + "description": "The bandwidth schedule details.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/BandwidthScheduleProperties", + "description": "The properties of the bandwidth schedule.", + "x-ms-client-flatten": true + } + } + }, + "BandwidthScheduleProperties": { + "description": "The properties of the bandwidth schedule.", + "required": [ "start", "stop", "rateInMbps", "days" ], + "type": "object", + "properties": { + "start": { + "description": "The start time of the schedule in UTC.", + "type": "string" + }, + "stop": { + "description": "The stop time of the schedule in UTC.", + "type": "string" + }, + "rateInMbps": { + "format": "int32", + "description": "The bandwidth rate in Mbps.", + "type": "integer" + }, + "days": { + "description": "The days of the week when this schedule is applicable.", + "type": "array", + "items": { + "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + } + } + }, + "BandwidthSchedulesList": { + "description": "The collection of bandwidth schedules.", + "type": "object", + "properties": { + "value": { + "description": "The list of bandwidth schedules.", + "type": "array", + "items": { "$ref": "#/definitions/BandwidthSchedule" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ClientAccessRight": { + "description": "The mapping between a particular client ip and the type of access client has on the NFS share.", + "required": [ "client", "accessPermission" ], + "type": "object", + "properties": { + "client": { + "description": "Ip of the client.", + "type": "string" + }, + "accessPermission": { + "description": "Type of access to be allowed for the client.", + "enum": [ "NoAccess", "ReadOnly", "ReadWrite" ], + "type": "string", + "x-ms-enum": { + "name": "ClientPermissionType", + "modelAsString": true + } + } + } + }, + "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" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { "$ref": "#/definitions/CloudErrorBody" } + } + }, + "x-ms-external": true + }, + "ContactDetails": { + "description": "Contains all the contact details of the customer.", + "required": [ "contactPerson", "companyName", "phone", "emailList" ], + "type": "object", + "properties": { + "contactPerson": { + "description": "Gets or sets the contact person.", + "type": "string" + }, + "companyName": { + "description": "Gets or sets the name of the company.", + "type": "string" + }, + "phone": { + "description": "Gets or sets the phone number.", + "type": "string" + }, + "emailList": { + "description": "Gets or sets the email list.", + "type": "array", + "items": { "type": "string" } + } + } + }, + "DataBoxEdgeDevice": { + "description": "The Data Box Edge/Gateway device.", + "required": [ "location" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "location": { + "description": "The location of the device. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a device cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ "read", "create" ] + }, + "tags": { + "description": "The list of tags that describe the device. These tags can be used in viewing and grouping this device (across resource groups).", + "type": "object", + "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + }, + "etag": { + "description": "The etag of the devices.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties", + "description": "The properties of the Data Box Edge/Gateway device.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfo": { + "description": "The extended Info of the Data Box Edge/Gateway device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", + "description": "The extended info properties.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfoProperties": { + "description": "The properties of the Data Box Edge/Gateway device extended info.", + "required": [ "integrityKey" ], + "type": "object", + "properties": { + "integrityKey": { + "description": "The Channel Integrity Key (CIK) of the device.", + "type": "string" + }, + "encryptionKeyThumbprint": { + "description": "The certificate thumbprint that was used to encrypt the Channel Integrity Key (CIK).", + "type": "string" + }, + "encryptionKey": { + "description": "The Channel Integrity Key (CIK) of the device.", + "type": "string" + }, + "resourceKey": { + "description": "The Resource Id of the Resource.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceList": { + "description": "The collection of Data Box Edge/Gateway devices.", + "type": "object", + "properties": { + "value": { + "description": "The list of Data Box Edge/Gateway devices.", + "type": "array", + "items": { "$ref": "#/definitions/DataBoxEdgeDevice" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePatch": { + "description": "The Data Box Edge/Gateway device patch.", + "type": "object", + "properties": { + "tags": { + "description": "The tags attached to the Data Box Edge/Gateway resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "DataBoxEdgeDeviceProperties": { + "description": "The properties of the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "dataBoxEdgeDeviceStatus": { + "description": "The status of the Data Box Edge/Gateway device.", + "enum": [ "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected" ], + "type": "string", + "x-ms-enum": { + "name": "DataBoxEdgeDeviceStatus", + "modelAsString": true + } + }, + "serialNumber": { + "description": "The Serial Number of Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The Description of the Data Box Edge/Gateway device.", + "type": "string" + }, + "modelDescription": { + "description": "The description of the Data Box Edge/Gateway device model.", + "type": "string" + }, + "deviceType": { + "description": "The type of the Data Box Edge/Gateway device.", + "enum": [ "DataBoxEdgeDevice" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "The Data Box Edge/Gateway device name.", + "type": "string" + }, + "culture": { + "description": "The Data Box Edge/Gateway device culture.", + "type": "string", + "readOnly": true + }, + "deviceModel": { + "description": "The Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceSoftwareVersion": { + "description": "The Data Box Edge/Gateway device software version.", + "type": "string", + "readOnly": true + }, + "deviceLocalCapacity": { + "format": "int64", + "description": "The Data Box Edge/Gateway device local capacity in MB.", + "type": "integer", + "readOnly": true + }, + "timeZone": { + "description": "The Data Box Edge/Gateway device timezone.", + "type": "string", + "readOnly": true + }, + "deviceHcsVersion": { + "description": "The device software version number of the device (eg: 1.2.18105.6).", + "type": "string", + "readOnly": true + }, + "configuredRoleTypes": { + "description": "Type of compute roles configured.", + "type": "array", + "items": { + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "readOnly": true + } + } + }, + "FileEventTrigger": { + "description": "Trigger details.", + "required": [ "properties", "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Trigger" } ], + "properties": { + "properties": { + "$ref": "#/definitions/FileTriggerProperties", + "description": "File trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FileEvent" + }, + "FileSourceInfo": { + "description": "File source details.", + "required": [ "shareId" ], + "type": "object", + "properties": { + "shareId": { + "description": "File share ID.", + "type": "string" + } + } + }, + "FileTriggerProperties": { + "description": "File Trigger properties.", + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/FileSourceInfo", + "description": "File event source details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink info." + }, + "customContextTag": { + "description": "Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can be the name/image url of the module.", + "type": "string" + } + } + }, + "IoTDeviceInfo": { + "description": "Metadata of IoT device/IoT edge device to be configured.", + "required": [ "deviceId", "ioTHostHub" ], + "type": "object", + "properties": { + "deviceId": { + "description": "Id of the IoT device/edge device.", + "type": "string" + }, + "ioTHostHub": { + "description": "Host name for IoT hub which is associated to the device.", + "type": "string" + }, + "authentication": { + "$ref": "#/definitions/Authentication", + "description": "IoT device authentication info." + } + } + }, + "IoTRole": { + "description": "Compute role.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Role" } ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTRoleProperties", + "description": "Properties specific to IoT Role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IOT" + }, + "IoTRoleProperties": { + "description": "IoT role properties.", + "required": [ "hostPlatform", "ioTDeviceDetails", "ioTEdgeDeviceDetails", "roleStatus" ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS which IoT role support.", + "enum": [ "Windows", "Linux" ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "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." + }, + "shareMappings": { + "description": "Mount points of shares in role(s).", + "type": "array", + "items": { "$ref": "#/definitions/MountPointMap" } + }, + "roleStatus": { + "description": "Role status.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "Ipv4Config": { + "description": "Details related to the IPv4 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv4 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "The IPv4 subnet of the network adapter.", + "type": "string", + "readOnly": true + }, + "gateway": { + "description": "The IPv4 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Ipv6Config": { + "description": "Details related to the IPv6 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv6 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "prefixLength": { + "format": "int32", + "description": "The IPv6 prefix of the network adapter.", + "type": "integer", + "readOnly": true + }, + "gateway": { + "description": "The IPv6 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Job": { + "description": "A device job.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the job.", + "enum": [ "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", "Scheduled" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The UTC datetime at which the job was started.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The UTC datetime at which the job completed.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the job that is already complete.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/JobErrorDetails", + "description": "The Error details.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The properties of the job.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "JobErrorDetails": { + "description": "The job error information containing List of JobErrorItem.", + "type": "object", + "properties": { + "errorDetails": { + "description": "The error details.", + "type": "array", + "items": { "$ref": "#/definitions/JobErrorItem" }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message intended to describe the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobErrorItem": { + "description": "The job error items.", + "type": "object", + "properties": { + "recommendations": { + "description": "The recommended actions.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message intended to describe the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobProperties": { + "description": "The properties for the job.", + "type": "object", + "properties": { + "jobType": { + "description": "The type of the job.", + "enum": [ "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "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" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperationStage", + "modelAsString": true + } + }, + "downloadProgress": { + "$ref": "#/definitions/UpdateDownloadProgress", + "description": "The download progress.", + "readOnly": true + }, + "installProgress": { + "$ref": "#/definitions/UpdateInstallProgress", + "description": "The install progress.", + "readOnly": true + }, + "totalRefreshErrors": { + "format": "int32", + "description": "Total number of errors encountered during the refresh process.", + "type": "integer", + "readOnly": true + }, + "errorManifestFile": { + "description": "Local Share/Remote Container relative path to the error manifest file of the refresh.", + "type": "string", + "readOnly": true + }, + "shareId": { + "description": "ARM id of the Share on which the Refresh operation was done.", + "type": "string", + "readOnly": true + }, + "folder": { + "description": "If only subfolders need to be refreshed, then the sub folder path inside the share. Empty otherwise.", + "type": "string" + } + } + }, + "MetricDimension_V1": { + "description": "Metric Dimension v1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metrics dimension.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metrics dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "MetricSpecification_V1": { + "description": "Metric specification version 1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Description of the metric to be displayed.", + "type": "string" + }, + "unit": { + "description": "Metric units.", + "enum": [ "NotSpecified", "Percent", "Count", "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", "CountPerSecond" ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "aggregationType": { + "description": "Metric aggregation type.", + "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + }, + "dimensions": { + "description": "Metric dimensions, other than default dimension which is resource.", + "type": "array", + "items": { "$ref": "#/definitions/MetricDimension_V1" } + }, + "fillGapWithZero": { + "description": "set true to fill the gaps with zero.", + "type": "boolean" + }, + "category": { + "description": "Metric category.", + "enum": [ "Capacity", "Transaction" ], + "type": "string", + "x-ms-enum": { + "name": "MetricCategory", + "modelAsString": true + } + }, + "resourceIdDimensionNameOverride": { + "description": "Resource name override.", + "type": "string" + }, + "supportedTimeGrainTypes": { + "description": "Support granularity of metrics.", + "type": "array", + "items": { + "enum": [ "PT1M", "PT5M", "PT15M", "PT30M", "PT1H", "PT6H", "PT12H", "PT1D" ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "type": "array", + "items": { + "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + } + } + }, + "MountPointMap": { + "description": "The share mount point.", + "required": [ "shareId" ], + "type": "object", + "properties": { + "shareId": { + "description": "ID of the share which is mounted to role VM.", + "type": "string" + }, + "roleId": { + "description": "ID of the role to which share is mounted.", + "type": "string", + "readOnly": true + }, + "mountPoint": { + "description": "Mount point for the share.", + "type": "string", + "readOnly": true + }, + "roleType": { + "description": "Role type.", + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + } + }, + "NetworkAdapter": { + "description": "Represents the networkAdapter on a device.", + "type": "object", + "properties": { + "adapterId": { + "description": "Instance ID of network adapter.", + "type": "string", + "readOnly": true + }, + "adapterPosition": { + "$ref": "#/definitions/NetworkAdapterPosition", + "description": "Hardware position of network adapter.", + "readOnly": true + }, + "index": { + "format": "int32", + "description": "Logical index of the adapter.", + "type": "integer", + "readOnly": true + }, + "nodeId": { + "description": "Node ID of the network adapter.", + "type": "string", + "readOnly": true + }, + "networkAdapterName": { + "description": "Network Adapter Name.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Hardware label for the adapter.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "MAC Address.", + "type": "string", + "readOnly": true + }, + "linkSpeed": { + "format": "int64", + "description": "Link Speed.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "Value indicating whether this adapter is valid.", + "enum": [ "Inactive", "Active" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkAdapterStatus", + "modelAsString": true + } + }, + "rdmaStatus": { + "description": "Value indicating whether this adapter is RDMA Capable.", + "enum": [ "Incapable", "Capable" ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterRDMAStatus", + "modelAsString": true + } + }, + "dhcpStatus": { + "description": "Value indicating whether this adapter has DHCP Enabled.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterDHCPStatus", + "modelAsString": true + } + }, + "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.", + "type": "string", + "readOnly": true + }, + "dnsServers": { + "description": "The list DNS Servers of the device.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + } + } + }, + "NetworkAdapterPosition": { + "description": "The network adapter position.", + "type": "object", + "properties": { + "networkGroup": { + "description": "The network group.", + "enum": [ "None", "NonRDMA", "RDMA" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkGroup", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "The port.", + "type": "integer", + "readOnly": true + } + } + }, + "NetworkSettings": { + "description": "The NetworkSettings of a device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSettingsProperties", + "description": "The properties of network settings of a device.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NetworkSettingsProperties": { + "description": "The properties of NetworkSettings.", + "type": "object", + "properties": { + "networkAdapters": { + "description": "The network adapter list on the device.", + "type": "array", + "items": { "$ref": "#/definitions/NetworkAdapter" }, + "readOnly": true + } + } + }, + "Operation": { + "description": "Operations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties to displayed for the operation." + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display properties.", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "The type of resource in which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation to be performed on the resource.", + "type": "string" + }, + "description": { + "description": "Description of the operation to be performed.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operations Properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification." + } + } + }, + "OperationsList": { + "description": "Class for set of operations used for discovery of available provider operations.", + "required": [ "value" ], + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/Operation" } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string" + } + } + }, + "Order": { + "description": "The order details.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "The order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderList": { + "description": "List of order entities.", + "type": "object", + "properties": { + "value": { + "description": "The list of orders.", + "type": "array", + "items": { "$ref": "#/definitions/Order" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "OrderProperties": { + "description": "Order Properties.", + "type": "object", + "properties": { + "contactInformation": { + "$ref": "#/definitions/ContactDetails", + "description": "The contact details." + }, + "shippingAddress": { + "$ref": "#/definitions/Address", + "description": "The shipping address." + }, + "changeStatusTo": { + "$ref": "#/definitions/OrderStatus", + "description": "Current status of the Order." + }, + "orderHistory": { + "description": "List of status changes in the order.", + "type": "array", + "items": { "$ref": "#/definitions/OrderStatus" }, + "readOnly": true + }, + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "deliveryTrackingInfo": { + "description": "Tracking information related to the packages being delivered to the customer whether original or replacement devices.", + "type": "array", + "items": { "$ref": "#/definitions/TrackingInfo" }, + "readOnly": true + }, + "returnTrackingInfo": { + "description": "Tracking information related to the package being returned from the customer whether original or replacement devices.", + "type": "array", + "items": { "$ref": "#/definitions/TrackingInfo" }, + "readOnly": true + } + } + }, + "OrderStatus": { + "description": "Represents a single status change.", + "required": [ "status" ], + "type": "object", + "properties": { + "status": { + "description": "Status of the order pertaining to the allowed StatusTypes.", + "enum": [ "Untracked", "AwaitingFulfilment", "AwaitingPreparation", "AwaitingShipment", "Shipped", "Arriving", "Delivered", "ReplacementRequested", "LostDevice", "Declined", "ReturnInitiated", "AwaitingReturnShipment", "ShippedBack", "CollectedAtMicrosoft" ], + "type": "string", + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "updateDateTime": { + "format": "date-time", + "description": "Time of status update.", + "type": "string", + "readOnly": true + }, + "comments": { + "description": "Comments related to this status change.", + "type": "string" + } + } + }, + "PeriodicTimerEventTrigger": { + "description": "Trigger details.", + "required": [ "properties", "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Trigger" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PeriodicTimerProperties", + "description": "Periodic timer trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "PeriodicTimerEvent" + }, + "PeriodicTimerProperties": { + "description": "Periodic Timer Trigger properties.", + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/PeriodicTimerSourceInfo", + "description": "Periodic timer details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink info." + }, + "customContextTag": { + "description": "Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can be the name/image url of the module.", + "type": "string" + } + } + }, + "PeriodicTimerSourceInfo": { + "description": "Periodic timer event source.", + "required": [ "startTime", "schedule" ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Time time [UTC] of the day, from which the trigger will be valid. Schedule will be computed with reference to the time specified.", + "type": "string" + }, + "schedule": { + "description": "Periodic frequency at which timer event needs to be raised. Supports Daily, Hourly, Minutes and seconds.", + "type": "string" + }, + "topic": { + "description": "Topic with which periodic events needs to be published to IOT device.", + "type": "string" + } + } + }, + "RawCertificateData": { + "description": "Raw Certificate Data.", + "required": [ "certificate" ], + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type.", + "enum": [ "Invalid", "AzureActiveDirectory" ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "certificate": { + "description": "The base64 encoded certificate raw data.", + "type": "string" + } + } + }, + "RefreshDetails": { + "description": "Fields for tracking refresh job on the share.", + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "description": "If a RefreshShare job is currently inprogress on this share - this field indicates the ArmId of that job. Empty otherwise.", + "type": "string" + }, + "lastCompletedRefreshJobTimeInUTC": { + "format": "date-time", + "description": "Indicates the job completed time of the last refresh job on this particular share, if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + }, + "errorManifestFile": { + "description": "Indicates the relative path of the error xml for the last refresh job on this particular share, if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + }, + "lastJob": { + "description": "Indicates the id of the last refresh job on this particular share,if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + } + } + }, + "Role": { + "description": "Compute role.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "kind": { + "description": "Role type.", + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "RoleList": { + "description": "Collection of all role on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "type": "array", + "items": { "$ref": "#/definitions/Role" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "RoleSinkInfo": { + "description": "Compute role against which events will be raised.", + "required": [ "roleId" ], + "type": "object", + "properties": { + "roleId": { + "description": "Compute role ID.", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "The security settings of a device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SecuritySettingsProperties", + "description": "Properties of the security settings.", + "x-ms-client-flatten": true + } + } + }, + "SecuritySettingsProperties": { + "description": "The properties of security settings.", + "required": [ "deviceAdminPassword" ], + "type": "object", + "properties": { + "deviceAdminPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to log into the local web UI of the device. Actual password could have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." + } + } + }, + "ServiceSpecification": { + "description": "Service specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specification as defined by shoebox.", + "type": "array", + "items": { "$ref": "#/definitions/MetricSpecification_V1" } + } + } + }, + "Share": { + "description": "Represents a share on the Data Box Edge/Gateway device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ShareProperties", + "description": "The share properties.", + "x-ms-client-flatten": true + } + } + }, + "ShareAccessRight": { + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", + "required": [ "shareId", "accessType" ], + "type": "object", + "properties": { + "shareId": { + "description": "Id of the share.", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed on the share for this user.", + "enum": [ "Change", "Read", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "ShareList": { + "description": "Collection of all shares on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of shares.", + "type": "array", + "items": { "$ref": "#/definitions/Share" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ShareProperties": { + "description": "The share properties.", + "required": [ "shareStatus", "monitoringStatus", "accessProtocol" ], + "type": "object", + "properties": { + "description": { + "description": "Description for the share.", + "type": "string" + }, + "shareStatus": { + "description": "Current status of the share.", + "enum": [ "Online", "Offline" ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true + } + }, + "monitoringStatus": { + "description": "Current monitoring status of the share.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "azureContainerInfo": { + "$ref": "#/definitions/AzureContainerInfo", + "description": "Azure container mapping for the share." + }, + "accessProtocol": { + "description": "Access protocol to be used by the share.", + "enum": [ "SMB", "NFS" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessProtocol", + "modelAsString": true + } + }, + "userAccessRights": { + "description": "Mapping of Users and corresponding access rights on the share (mandatory for SMB protocol).", + "type": "array", + "items": { "$ref": "#/definitions/UserAccessRight" } + }, + "clientAccessRights": { + "description": "List of IP addresses and corresponding access rights on the share(mandatory for NFS protocol).", + "type": "array", + "items": { "$ref": "#/definitions/ClientAccessRight" } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this share." + }, + "shareMappings": { + "description": "Share mount point to the role.", + "type": "array", + "items": { "$ref": "#/definitions/MountPointMap" }, + "readOnly": true + }, + "dataPolicy": { + "description": "Data policy of the share.", + "enum": [ "Cloud", "Local" ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + } + } + }, + "Sku": { + "description": "The SKU type.", + "type": "object", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ "Gateway", "Edge" ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ "Standard" ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "StorageAccountCredential": { + "description": "The storage account credential.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountCredentialProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredentialList": { + "description": "The collection of storage account credential entities.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/StorageAccountCredential" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountCredentialProperties": { + "description": "The storage account credential properties.", + "required": [ "alias", "sslStatus", "accountType" ], + "type": "object", + "properties": { + "alias": { + "description": "Alias for the storage account.", + "type": "string" + }, + "userName": { + "description": "UserName for the storage account.", + "type": "string" + }, + "accountKey": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted storage key." + }, + "connectionString": { + "description": "ConnectionString for the storage account. This needs to be specified if UserName/AccountKey are not specified.", + "type": "string" + }, + "sslStatus": { + "description": "Signifies whether SSL needs to be enabled or not.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "SSLStatus", + "modelAsString": true + } + }, + "blobDomainName": { + "description": "Blob end point for private clouds.", + "type": "string" + }, + "accountType": { + "description": "Type of storage accessed on the storage account.", + "enum": [ "GeneralPurposeStorage", "BlobStorage" ], + "type": "string", + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + } + } + }, + "SymmetricKey": { + "description": "Symmetric Key for authentication.", + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Connection string based on symmetric key." + } + } + }, + "TrackingInfo": { + "description": "Tracking courier information.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device being tracked.", + "type": "string" + }, + "carrierName": { + "description": "Name of the carrier used in the delivery.", + "type": "string" + }, + "trackingId": { + "description": "Tracking ID of the shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Tracking URL of the shipment.", + "type": "string" + } + } + }, + "Trigger": { + "description": "Trigger details.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "kind": { + "description": "Trigger Kind.", + "enum": [ "FileEvent", "PeriodicTimerEvent" ], + "type": "string", + "x-ms-enum": { + "name": "TriggerEventType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "TriggerList": { + "description": "Collection of all trigger on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The list of triggers.", + "type": "array", + "items": { "$ref": "#/definitions/Trigger" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateDownloadProgress": { + "description": "Details about the download progress of update.", + "type": "object", + "properties": { + "downloadPhase": { + "description": "The download phase.", + "enum": [ "Unknown", "Initializing", "Downloading", "Verifying" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DownloadPhase", + "modelAsString": true + } + }, + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "totalBytesToDownload": { + "format": "double", + "description": "Total bytes to download.", + "type": "number", + "readOnly": true + }, + "totalBytesDownloaded": { + "format": "double", + "description": "Total bytes downloaded.", + "type": "number", + "readOnly": true + }, + "numberOfUpdatesToDownload": { + "format": "int32", + "description": "Number of updates to download.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesDownloaded": { + "format": "int32", + "description": "Number of updates downloaded.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateInstallProgress": { + "description": "Details about the progress during installation of updates.", + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesToInstall": { + "format": "int32", + "description": "Number of updates to install.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesInstalled": { + "format": "int32", + "description": "Number of updates installed.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateSummary": { + "description": "Details about ongoing updates and availability of updates on the device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UpdateSummaryProperties", + "description": "The device update information summary.", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummaryProperties": { + "description": "The device update information summary.", + "type": "object", + "properties": { + "deviceVersionNumber": { + "description": "The current version of the device, of format: 1.2.17312.13.", + "type": "string" + }, + "friendlyDeviceVersionName": { + "description": "The current version of the device represented in text format.", + "type": "string" + }, + "deviceLastScannedDateTime": { + "format": "date-time", + "description": "The last time when a scan was done on the device.", + "type": "string" + }, + "lastCompletedScanJobDateTime": { + "format": "date-time", + "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", + "type": "string" + }, + "lastCompletedDownloadJobDateTime": { + "format": "date-time", + "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedInstallJobDateTime": { + "format": "date-time", + "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "totalNumberOfUpdatesAvailable": { + "format": "int32", + "description": "Count of updates that are available for the current device version as per the last scan on the device.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingDownload": { + "format": "int32", + "description": "The total number of items pending download.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingInstall": { + "format": "int32", + "description": "The total number of items pending install.", + "type": "integer", + "readOnly": true + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the update items detected needs a reboot.", + "enum": [ "NeverReboots", "RequiresReboot", "RequestReboot" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "ongoingUpdateOperation": { + "description": "The current update operation.", + "enum": [ "None", "Scan", "Download", "Install" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperation", + "modelAsString": true + } + }, + "inProgressDownloadJobId": { + "description": "The Job ID of the download job if a download is in progress.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobId": { + "description": "The Job ID of the install job if an install is in progress.", + "type": "string", + "readOnly": true + }, + "inProgressDownloadJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running download (if any) started.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running install (if any) started.", + "type": "string", + "readOnly": true + }, + "updateTitles": { + "description": "The list of update titles which are available for install.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + }, + "totalUpdateSizeInBytes": { + "format": "double", + "description": "The total size of updates available for download in bytes.", + "type": "number", + "readOnly": true + } + } + }, + "UploadCertificateRequest": { + "description": "The Upload certificate request.", + "required": [ "properties" ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData", + "description": "The Base 64 encoded certificate raw data.", + "x-ms-client-flatten": true + } + } + }, + "UploadCertificateResponse": { + "description": "The upload registration certificate response.", + "required": [ "resourceId", "aadAuthority", "aadTenantId", "servicePrincipalClientId", "servicePrincipalObjectId", "azureManagementEndpointAudience" ], + "type": "object", + "properties": { + "authType": { + "description": "Specifies the Authentication type.", + "enum": [ "Invalid", "AzureActiveDirectory" ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "resourceId": { + "description": "The resource ID of the edge device.", + "type": "string" + }, + "aadAuthority": { + "description": "Azure Active Directory tenant authority.", + "type": "string" + }, + "aadTenantId": { + "description": "Azure Active Directory tenant ID.", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "Azure Active Directory service principal client ID.", + "type": "string" + }, + "servicePrincipalObjectId": { + "description": "Azure Active Directory service principal Object ID.", + "type": "string" + }, + "azureManagementEndpointAudience": { + "description": "The Azure Management Endpoint Audience.", + "type": "string" + } + } + }, + "User": { + "description": "Represents a user who has access to one or more shares on the Edge storage device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "UserAccessRight": { + "description": "The mapping between a particular user and the type of access they have on the SMB share.", + "required": [ "userId", "accessType" ], + "type": "object", + "properties": { + "userId": { + "description": "Id of the user (already existing in the device).", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed for the user.", + "enum": [ "Change", "Read", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "UserList": { + "description": "Collection of users.", + "type": "object", + "properties": { + "value": { + "description": "The list of users.", + "type": "array", + "items": { "$ref": "#/definitions/User" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UserProperties": { + "description": "The User properties.", + "type": "object", + "properties": { + "encryptedPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "The details of the password specified for the user." + }, + "shareAccessRights": { + "description": "List of shares that the user has rights on. This field should not be specified during user creation.", + "type": "array", + "items": { "$ref": "#/definitions/ShareAccessRight" } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version.", + "required": true, + "type": "string" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { "user_impersonation": "impersonate your user account." } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json new file mode 100644 index 000000000000..0b614e17f97d --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json new file mode 100644 index 000000000000..ae659e83af59 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "title": "Device password has changed", + "alertType": "PasswordChangedEvent", + "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", + "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.", + "severity": "Informational", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 2 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790", + "name": "83eccd0b-134b-40b0-ad62-b5f124d03790", + "type": "dataBoxEdgeDevices/alerts" + }, + { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json new file mode 100644 index 000000000000..3624f97deb1b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json new file mode 100644 index 000000000000..9d0df9800de0 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json new file mode 100644 index 000000000000..e65175193018 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json new file mode 100644 index 000000000000..9e9d8809d8e5 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "start": "0:0:0", + "stop": "13:59:0", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSettings" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json new file mode 100644 index 000000000000..84ffc3af1604 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json new file mode 100644 index 000000000000..a301c091b7ed --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-16T08%3A03%3A27.61Z'\"_W/\"datetime'2018-12-16T08%3A03%3A27.653Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json new file mode 100644 index 000000000000..a1f489b0c10b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json new file mode 100644 index 000000000000..a1fdb28f372a --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json new file mode 100644 index 000000000000..4587d563f3cf --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "tags": { + "Key1": "value1", + "Key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": { + "Key1": "value1", + "Key2": "value2" + }, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2018-12-19T06%3A33%3A24.983Z'\"_W/\"datetime'2018-12-19T06%3A33%3A25.013Z'\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json new file mode 100644 index 000000000000..0439922e6a5f --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "DataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "standard" + }, + "name": "testedgedevice" + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json new file mode 100644 index 000000000000..645cfcaaec74 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "integrityKey": "Test-integrity-key", + "resourceKey": "3482840729935603111" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json new file mode 100644 index 000000000000..a85597f42c7c --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "integrityKey": "Test-integrity-key" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "integrityKey": "Test-integrity-key", + "resourceKey": "3482840729935603111" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json new file mode 100644 index 000000000000..26afdd045924 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "networkAdapters": [ + { + "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", + "adapterPosition": { + "networkGroup": "NonRDMA", + "port": 0 + }, + "index": 1, + "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", + "networkAdapterName": "DATA1", + "label": "DATA1", + "macAddress": "00155D4E265B", + "linkSpeed": 10000000000, + "status": "Inactive", + "rdmaStatus": "Incapable", + "dhcpStatus": "Disabled", + "ipv4Configuration": { + "ipAddress": "10.150.78.56", + "subnet": "255.255.252.0", + "gateway": "10.150.76.1" + }, + "ipv6Configuration": { + "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", + "prefixLength": 64, + "gateway": "fe80::12f3:11ff:fe36:994b%5" + }, + "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", + "dnsServers": [ + "10.50.50.50", + "10.50.10.50" + ] + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json new file mode 100644 index 000000000000..fe7d62ef4210 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json @@ -0,0 +1,717 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Creates or updates share users", + "description": "Creates or updates the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Delete share users", + "description": "Deletes the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Creates or updates bandwidth schedules", + "description": "Creates or updates the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Delete bandwidth schedules", + "description": "Deletes the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Creates or updates ArmApiRes_roles", + "description": "Creates or updates the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Delete ArmApiRes_roles", + "description": "Deletes the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Creates or updates shares", + "description": "Creates or updates the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "ArmApiOp_action_refresh_shares", + "description": "ArmApiDesc_action_refresh_shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Delete shares", + "description": "Deletes the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Upload certificates", + "description": "Upload certificate for device registration" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Delete Data Box Edge devices", + "description": "Deletes the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", + "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Gets resource extended information", + "description": "Retrieves resource extended information" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device network settings", + "operation": "List Device network settings", + "description": "Lists or gets the Device network settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device security settings", + "operation": "Update security settings", + "description": "Update security settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "update summary", + "operation": "List update summary", + "description": "Lists or gets the update summary" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Scan for updates", + "description": "Scan for updates" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Download Updates", + "description": "Download Updates in device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Install Updates", + "description": "Install Updates on device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "jobs", + "operation": "List jobs", + "description": "Lists or gets the jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Creates or updates storage account credentials", + "description": "Creates or updates the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Delete storage account credentials", + "description": "Deletes the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read Data Box Edge device metric definition", + "description": "Gets the available Data Box Edge device level metrics" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "NICReadThroughput", + "displayName": "Read Throughput (Network)", + "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "NICWriteThroughput", + "displayName": "Write Throughput (Network)", + "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughputPerShare", + "displayName": "Cloud Download Throughput (Share)", + "displayDescription": "The download throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughputPerShare", + "displayName": "Cloud Upload Throughput (Share)", + "displayDescription": "The upload throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloudPerShare", + "displayName": "Cloud Bytes Uploaded (Share)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "TotalCapacity", + "displayName": "Total Capacity", + "displayDescription": "Total Capacity", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "AvailableCapacity", + "displayName": "Available Capacity", + "displayDescription": "The available capacity in bytes during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughput", + "displayName": "Cloud Upload Throughput", + "displayDescription": "The cloud upload throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughput", + "displayName": "Cloud Read Throughput", + "displayDescription": "The cloud download throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloud", + "displayName": "Cloud Bytes Uploaded (Device)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Write diagnostics setting", + "description": "Creates or updates the diagnostics setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read diagnostics setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..2f687b673c06 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json new file mode 100644 index 000000000000..f88586a70ec2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json new file mode 100644 index 000000000000..ae14cce37fdb --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ], + "returnTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json new file mode 100644 index 000000000000..b9737e6ca36b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ], + "returnTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json new file mode 100644 index 000000000000..55291d6a41c2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "order": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "comments": "Send the parcel to this address" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "comments": "Send the parcel to this address" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json new file mode 100644 index 000000000000..540c9accd335 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": "" + }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json new file mode 100644 index 000000000000..899fed7862f7 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json new file mode 100644 index 000000000000..8c88cc0ed298 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json new file mode 100644 index 000000000000..618c97313a47 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "role": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "348586569999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "1245475856069999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "shareMappings": [ + ], + + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/Roles/IoTRole1", + "name": "IoTRole3", + "type": "dataBoxEdgeDevices/roles" + } + }, + "responses": { + "200": { + "body": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json new file mode 100644 index 000000000000..761907831c81 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json new file mode 100644 index 000000000000..b5abe7d74f59 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json new file mode 100644 index 000000000000..031d95442dee --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alias": "sac1128180128323", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "GeneralPurposeStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", + "name": "sac1128180128323", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + { + "properties": { + "alias": "sac1128180128312", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", + "name": "sac1128180128312", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json new file mode 100644 index 000000000000..a7125f57241b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccountCredential": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "accountKey": { + "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==", + "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", + "encryptionAlgorithm": "AES256" + }, + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "name": "sac1" + } + }, + "responses": { + "200": { + "body": + { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json new file mode 100644 index 000000000000..d76e454df190 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "AzureVM", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "securitySettings": { + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/AzureVM/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/securitySettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings", + "properties": { + "deviceAdminPassword": { + "value": "jJ5MvXa/AEWvwxviS92uCjatCXeyLYTy8jx/k105MjQRXT7i6Do8qpEcQ8d+OBbwmQTnwKW0CYyzzVRCc0uZcPCf6PsWtP4l6wvcKGAP66PwK68eEkTUOmp+wUHc4hk02kWmTWeAjBZkuDBP3xK1RnZo95g2RE4i1UgKNP5BEKCLd71O104DW3AWW41mh9XLWNOaxw+VjQY7wmvlE6XkvpkMhcGuha2u7lx8zi9ZkcMvJVYDYK36Fb/K3KhBAmDjjDmVq04jtBlcSTXQObt0nlj4BwGGtdrpeIpr67zqr5i3cPm6e6AleIaIhp6sI/uyGSMiT3oev2eg49u2ii7kVA==", + "encryptionAlgorithm": "AES256", + "encryptionCertThumbprint": "7DCBDFC44ED968D232C9A998FC105B5C70E84BE0" + } + } + } + }, + "responses": { + "202": { "body": "" }, + "204": { } + + } +} diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json new file mode 100644 index 000000000000..2dbe4e980cc9 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json new file mode 100644 index 000000000000..0e45ac2d19c2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json new file mode 100644 index 000000000000..802fe2e6f800 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json new file mode 100644 index 000000000000..663e9e617aa3 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "share": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Enabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "dataPolicy": "Cloud" + }, + "name": "testShare1234SMB" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json new file mode 100644 index 000000000000..133495d19895 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json new file mode 100644 index 000000000000..0c5ef20cdbad --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json new file mode 100644 index 000000000000..1f63ac18f6c6 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json new file mode 100644 index 000000000000..b643c83f2f67 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json new file mode 100644 index 000000000000..af6b32d9f129 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "trigger": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json new file mode 100644 index 000000000000..4ad324d6beb7 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "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==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "1.2.18183.2", + "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", + "totalNumberOfUpdatesAvailable": 0, + "totalNumberOfUpdatesPendingDownload": 0, + "totalNumberOfUpdatesPendingInstall": 0, + "rebootBehavior": "NeverReboots", + "ongoingUpdateOperation": "None", + "totalUpdateSizeInBytes": 0.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json new file mode 100644 index 000000000000..5577c30bd205 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "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==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "1.2.18183.2", + "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", + "totalNumberOfUpdatesAvailable": 0, + "totalNumberOfUpdatesPendingDownload": 0, + "totalNumberOfUpdatesPendingInstall": 0, + "rebootRequiredForInstall": false, + "ongoingUpdateOperation": "None", + "totalUpdateSizeInBytes": 0.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json new file mode 100644 index 000000000000..04217a281c56 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "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==" + } + } + }, + "responses": { + "200": { + "body": { + "authType": "AzureActiveDirectory", + "resourceId": "392799901267771", + "aadAuthority": "https://login.windows.net", + "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", + "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", + "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4", + "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json new file mode 100644 index 000000000000..47e2e2884ec8 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json new file mode 100644 index 000000000000..88ba17c06bea --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "202": { "body": "" } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json new file mode 100644 index 000000000000..32a31d565f94 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "name": "user2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json new file mode 100644 index 000000000000..27d3a1f40d4d --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "user": { + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users", + "properties": { + "encryptedPassword": { + "value": "Password@1", + "encryptionAlgorithm": "None", + "EncryptionCertThumbprint": "blah" + }, + "shareAccessRights": [] + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/readme.go.md b/specification/edgegateway/resource-manager/readme.go.md new file mode 100644 index 000000000000..5969ef05f9be --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: edgegateway + clear-output-folder: true +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and go + +These settings apply only when `--tag=package-2018-07 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2018-07' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-07-01/$(namespace) +``` diff --git a/specification/edgegateway/resource-manager/readme.md b/specification/edgegateway/resource-manager/readme.md new file mode 100644 index 000000000000..4a1fa69dbbff --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.md @@ -0,0 +1,147 @@ +# DataBox + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataBox. + + + +--- +## Getting Started +To build the SDK for DataBox, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DataBox API. + +``` yaml +openapi-type: arm +tag: package-2018-07 +``` + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-2018-07` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07' +input-file: +- Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-go + - repo: azure-sdk-for-java + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_edgegateway'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.EdgeGateway + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/EdgeGateway/Management.EdgeGateway/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.edgegateway + package-name: azure-mgmt-edgegateway + title: EdgeGatewayManagementClient + description: The EdgeGateway Client. + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-edgegateway/azure/mgmt/edgegateway +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-edgegateway +``` + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.edgegateway + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-edgegateway +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and java + +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.edgegateway.v2018_07_01 + output-folder: $(azure-libraries-for-java-folder)/edgegateway/resource-manager/v2018_07_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/edgegateway/resource-manager/readme.nodejs.md b/specification/edgegateway/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..8d98dd22b64a --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.nodejs.md @@ -0,0 +1,16 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-arm-edgegateway + output-folder: $(node-sdks-folder)/lib/services/edgegatewayManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/edgegateway/resource-manager/readme.ruby.md b/specification/edgegateway/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..ed26d6096555 --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +package-name: azure_mgmt_edgedateway +package-version: "0.0.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and ruby + +These settings apply only when `--tag=package-2018-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2018_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_edgedateway/lib +``` diff --git a/specification/edgegateway/resource-manager/readme.typescript.md b/specification/edgegateway/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..c1417348b906 --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: "@azure/arm-edgedateway" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-edgedateway" + generate-metadata: true +```