{ "swagger": "2.0", "schemes": [ "https" ], "host": "management.azure.com", "info": { "title": "DataBoxManagementClient", "version": "2019-09-01", "x-apisguru-categories": [ "cloud" ], "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databox/resource-manager/Microsoft.DataBox/stable/2019-09-01/databox.json", "version": "2.0" } ], "x-preferred": true, "x-providerName": "azure.com", "x-serviceName": "databox", "x-tags": [ "Azure", "Microsoft" ] }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "scopes": { "user_impersonation": "impersonate your user account" }, "type": "oauth2" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "parameters": { "apiVersionParameter": { "description": "The API Version", "in": "query", "name": "api-version", "required": true, "type": "string" }, "jobNameParameter": { "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", "in": "path", "maxLength": 24, "minLength": 3, "name": "jobName", "pattern": "^[-\\w\\.]+$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "locationParameter": { "description": "The location of the resource", "in": "path", "name": "location", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "resourceGroupNameParameter": { "description": "The Resource Group Name", "in": "path", "name": "resourceGroupName", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "subscriptionIdParameter": { "description": "The Subscription Id", "in": "path", "name": "subscriptionId", "required": true, "type": "string" } }, "paths": { "/providers/Microsoft.DataBox/operations": { "get": { "description": "This method gets all the operations.", "operationId": "Operations_List", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The supported operations list.", "schema": { "$ref": "#/definitions/OperationList" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Operations" ], "x-ms-examples": { "OperationsGet": { "parameters": { "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2018-01-01", "x-ms-client-request-id": [ "69fc02f6-5d9f-42d5-8d98-b5a943b8c888" ] }, "responses": { "200": { "body": { "value": [ { "display": { "description": "Cancels an order in progress.", "operation": "Cancel", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/cancel/action", "origin": "user", "properties": {} }, { "display": { "description": "Allows to book a pick up for return shipments.", "operation": "Book Shipment Pick Up", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action", "origin": "user", "properties": {} }, { "display": { "description": "List or get the Orders", "operation": "List Orders", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/read", "origin": "user", "properties": {} }, { "display": { "description": "Delete the Orders", "operation": "Delete Orders", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/delete", "origin": "user", "properties": {} }, { "display": { "description": "Create or update the Orders", "operation": "Create or Update Orders", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/write", "origin": "user", "properties": {} }, { "display": { "description": "Lists the unencrypted credentials related to the order.", "operation": "List Credentials", "provider": "Azure Data Box", "resource": "Orders" }, "name": "Microsoft.DataBox/jobs/listCredentials/action", "origin": "user", "properties": {} }, { "display": { "description": "Validates the shipping address and provides alternate addresses if any.", "operation": "Validate Address", "provider": "Azure Data Box", "resource": "Validate Address" }, "name": "Microsoft.DataBox/locations/validateAddress/action", "origin": "user", "properties": {} }, { "display": { "description": "This method returns the list of available skus.", "operation": "Availabe Skus", "provider": "Azure Data Box", "resource": "Available Skus" }, "name": "Microsoft.DataBox/locations/availableSkus/action", "origin": "user", "properties": {} } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": { "get": { "description": "Lists all the jobs available under the subscription.", "operationId": "Jobs_List", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", "in": "query", "name": "$skipToken", "required": false, "type": "string" } ], "responses": { "200": { "description": "List of jobs available under the subscription.", "schema": { "$ref": "#/definitions/JobResourceList" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsList": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "a3118d2e-2b53-4e95-860e-cd141dd57b15" ] }, "responses": { "200": { "body": { "nextLink": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/jobs?api-version=2019-09-01&$skipToken=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTE2Ij8%2bDQo8Q29udGludWF0aW9uVG9rZW4%2bDQogIDxDb250aW51YXRpb25Ub2tlbj4NCiAgICA8VmVyc2lvbj4yLjA8L1ZlcnNpb24%2bDQogICAgPFR5cGU%2bVGFibGU8L1R5cGU%2bDQogICAgPE5leHRQYXJ0aXRpb25LZXk%2bMSE4NCFabUUyT0RBNE1tWXRPR1ptTnkwMFlUSTFMVGsxWXpjdFkyVTVaR0UxTkRFeU5ESm1YekJmYldsamNtOXpiMlowTG1SaGRHRmliM2hmTUY5cWIySno8L05leHRQYXJ0aXRpb25LZXk%2bDQogICAgPE5leHRSb3dLZXk%2bMSE3MiFjbVZ6YjNWeVkyVnRZWEJ3YVc1blh6QmZjbWRmTUY5aGEzWmxibXRoZEY4d1gzUmxjM1J6WTJobFpIVnNaVEF4TFdOc2IyNWw8L05leHRSb3dLZXk%2bDQogICAgPFRhcmdldExvY2F0aW9uPlByaW1hcnk8L1RhcmdldExvY2F0aW9uPg0KICA8L0NvbnRpbnVhdGlvblRva2VuPg0KPC9Db250aW51YXRpb25Ub2tlbj4%3d", "value": [ { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ93/providers/Microsoft.DataBox/jobs/testbadresourcegroup", "location": "westus", "name": "testbadresourcegroup", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2018-11-27T15:17:49.0760408+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/andipodtest4jan", "location": "westus", "name": "andipodtest4jan", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-04T09:08:49.9928621+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdeepak04-07", "location": "westus", "name": "testdeepak04-07", "properties": { "cancellationReason": "IncorrectOrder null", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-07-04T14:01:50.9232807+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurga-heavy", "location": "westus", "name": "testdurga-heavy", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-11T12:33:16.6231232+05:30", "status": "Cancelled" }, "sku": { "name": "DataBoxHeavy" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurga-heavy1", "location": "westus", "name": "testdurga-heavy1", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-11T12:38:49.0620094+05:30", "status": "Cancelled" }, "sku": { "name": "DataBoxHeavy" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurga2", "location": "westus", "name": "testdurga2", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-09T16:12:43.2931373+05:30", "status": "Cancelled" }, "sku": { "name": "DataBoxHeavy" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgad", "location": "westus", "name": "testdurgad", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-09T15:59:47.4375821+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgadisk", "location": "westus", "name": "testdurgadisk", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-09T19:04:31.4461343+05:30", "status": "Cancelled" }, "sku": { "name": "DataBoxDisk" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgadisk-Clone", "location": "westus", "name": "testdurgadisk-Clone", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-09T19:10:08.2854968+05:30", "status": "Cancelled" }, "sku": { "name": "DataBoxDisk" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgam", "location": "westus", "name": "testdurgam", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2018-12-19T14:23:06.8155601+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgam-1", "location": "westus", "name": "testdurgam-1", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2018-12-19T16:46:12.824436+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgam-Clone", "location": "westus", "name": "testdurgam-Clone", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-03-04T12:00:17.7643558+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-1", "location": "westus", "name": "testdurgasm-1", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2018-12-19T18:24:23.0774328+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-1-1", "location": "westus", "name": "testdurgasm-1-1", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-03-04T11:58:13.4876698+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-1-Clone", "location": "westus", "name": "testdurgasm-1-Clone", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-11T14:28:55.4375406+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-11", "location": "westus", "name": "testdurgasm-11", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-15T12:51:12.2717434+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-12", "location": "westus", "name": "testdurgasm-12", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-15T12:54:58.9886188+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-1dssd", "location": "westus", "name": "testdurgasm-1dssd", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-15T13:33:29.8417562+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-ccxcx", "location": "westus", "name": "testdurgasm-ccxcx", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-15T15:35:39.937519+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-Clone", "location": "westus", "name": "testdurgasm-Clone", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-01-09T15:56:58.4277564+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-Clone-Clone", "location": "westus", "name": "testdurgasm-Clone-Clone", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-10T14:46:10.401621+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-compute", "location": "westus", "name": "testdurgasm-compute", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-02-10T14:52:37.2363289+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurgasm-compute1", "location": "westus", "name": "testdurgasm-compute1", "properties": { "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": false, "isShippingAddressEditable": false, "startTime": "2019-02-10T14:57:32.3159255+05:30", "status": "ReadyToDispatchFromAzureDC" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/TestPortalContract", "location": "westus", "name": "TestPortalContract", "properties": { "cancellationReason": "Old job which is still in ordered state cancelled by the service", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2018-09-08T22:46:11.5143859+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" }, { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testschedule01", "location": "westus", "name": "testschedule01", "properties": { "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": true, "isCancellableWithoutFee": true, "isDeletable": false, "isShippingAddressEditable": true, "startTime": "2019-07-30T10:47:22.083517+05:30", "status": "DeviceOrdered" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { "post": { "description": "This method provides the list of available skus for the given subscription and location.", "operationId": "Service_ListAvailableSkus", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Filters for showing the available skus.", "in": "body", "name": "availableSkuRequest", "required": true, "schema": { "$ref": "#/definitions/AvailableSkuRequest" } } ], "responses": { "200": { "description": "The list of available skus under subscription.", "schema": { "$ref": "#/definitions/AvailableSkusResult" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "AvailableSkusPost": { "parameters": { "Accept-Language": [ "en-US" ], "Content-Length": [ "84" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "availableSkuRequest": { "country": "US", "location": "westus", "transferType": "ImportToAzure" }, "location": "westus", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "130a5941-a075-412d-817f-e65065af00dd" ] }, "responses": { "200": { "body": { "value": [ { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "100", "usable": "80" }, "costs": [ { "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", "meterType": "DataBoxServiceFee" }, { "meterId": "a701f058-119b-4713-a923-bed7da4b7801", "meterType": "DataBoxShippingFee" }, { "meterId": "049fa331-0a48-4a81-9991-a6bef3c79fed", "meterType": "DataBoxExtraDayFee" }, { "meterId": "c3ea978d-6a0a-4632-b094-4fffcafcb057", "meterType": "DataBoxLostOrDamagedDeviceFee" } ], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None" }, "sku": { "name": "DataBox" } }, { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "40", "usable": "35" }, "costs": [ { "meterId": "d95cd8b5-b6f1-4cd9-ae86-a016d1945d6f", "meterType": "DataBoxDiskServiceFee" }, { "meterId": "4b8cf572-cb04-4ef3-9528-2cda4e9b544e", "meterType": "DataBoxDiskShippingFee" }, { "meterId": "b6ae9bbf-815d-49dd-bb2b-77c497b72ba4", "meterType": "DataBoxDiskDailyUsageFee" }, { "meterId": "08bc0ea1-6c82-421b-b953-2a7a65810d2e", "meterType": "DataBoxDiskLostDeviceFee" } ], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None" }, "sku": { "name": "DataBoxDisk" } }, { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "1000", "usable": "800" }, "costs": [ { "meterId": "d0dccaaf-3de9-4c7a-ba97-f83551b90126", "meterType": "DataBoxHeavyServiceFee" }, { "meterId": "7b49d11f-d4f7-4029-a197-04998fd282f9", "meterType": "DataBoxHeavyShippingFee" }, { "meterId": "c2c66d53-11b4-4f11-9642-43c7c336f0b7", "meterType": "DataBoxHeavyExtraDayFee" }, { "meterId": "188dcd7e-fbd7-4a41-aa42-162b81b0510f", "meterType": "DataBoxHeavyLostOrDamagedDeviceFee" } ], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None", "requiredFeature": "HeavyCreateAccess" }, "sku": { "name": "DataBoxHeavy" } } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": { "post": { "description": "This API provides configuration details specific to given region/location.", "operationId": "Service_RegionConfiguration", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Request body to get the configuration for the region.", "in": "body", "name": "regionConfigurationRequest", "required": true, "schema": { "$ref": "#/definitions/RegionConfigurationRequest" } } ], "responses": { "200": { "description": "Region configuration response.", "schema": { "$ref": "#/definitions/RegionConfigurationResponse" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "ServiceRegionConfiguration": { "parameters": { "Content-Length": [ "311" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2019-09-01", "location": "westus", "regionConfigurationRequest": { "scheduleAvailabilityRequest": { "skuName": "DataBox", "storageLocation": "westus" } }, "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f" }, "responses": { "200": { "body": { "scheduleAvailabilityResponse": { "availableDates": [ "2019-07-11T00:00:00+00:00", "2019-07-12T00:00:00+00:00", "2019-07-13T00:00:00+00:00", "2019-07-14T00:00:00+00:00", "2019-07-15T00:00:00+00:00", "2019-07-16T00:00:00+00:00", "2019-07-17T00:00:00+00:00", "2019-07-18T00:00:00+00:00", "2019-07-19T00:00:00+00:00", "2019-07-20T00:00:00+00:00", "2019-07-21T00:00:00+00:00", "2019-07-22T00:00:00+00:00", "2019-07-23T00:00:00+00:00", "2019-07-24T00:00:00+00:00", "2019-07-25T00:00:00+00:00", "2019-07-26T00:00:00+00:00", "2019-07-27T00:00:00+00:00", "2019-07-28T00:00:00+00:00", "2019-07-29T00:00:00+00:00", "2019-07-30T00:00:00+00:00", "2019-07-31T00:00:00+00:00" ] } } } } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { "post": { "deprecated": true, "description": "[DEPRECATED NOTICE: This operation will soon be removed] This method validates the customer shipping address and provide alternate addresses if any.", "operationId": "Service_ValidateAddress", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Shipping address of the customer.", "in": "body", "name": "validateAddress", "required": true, "schema": { "$ref": "#/definitions/ValidateAddress" } } ], "responses": { "200": { "description": "The valid and alternate addresses.", "schema": { "$ref": "#/definitions/AddressValidationOutput" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "ValidateAddressPost": { "parameters": { "Content-Length": [ "311" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2019-09-01", "location": "westus", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "validateAddress": { "deviceType": "DataBox", "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" }, "validationType": "ValidateAddress" }, "x-ms-client-request-id": [ "9f1830f8-1cf7-4145-8b34-0742d9c9be13" ] }, "responses": { "200": { "body": { "properties": { "alternateAddresses": [ { "addressType": "None", "city": "SAN FRANCISCO", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1", "streetAddress3": "" } ], "validationStatus": "Valid", "validationType": "ValidateAddress" } } } } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { "post": { "description": "This method does all necessary pre-job creation validation under subscription.", "operationId": "Service_ValidateInputs", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Inputs of the customer.", "in": "body", "name": "validationRequest", "required": true, "schema": { "$ref": "#/definitions/ValidationRequest" } } ], "responses": { "200": { "description": "The validation status and responses of each validating parameter.", "schema": { "$ref": "#/definitions/ValidationResponse" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "ServiceValidateInputs": { "parameters": { "Content-Length": [ "311" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2019-09-01", "location": "westus", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "validationRequest": { "individualRequestDetails": [ { "destinationAccountDetails": [ { "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "location": "westus", "validationType": "ValidateDataDestinationDetails" }, { "deviceType": "DataBox", "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" }, "validationType": "ValidateAddress" } ], "validationCategory": "JobCreationValidation" }, "x-ms-client-request-id": [ "ee686d79-42c2-4b01-9afe-5e99f4cabfee" ] }, "responses": { "200": { "body": { "properties": { "individualResponseDetails": [ { "error": {}, "status": "Valid", "validationType": "ValidateDataDestinationDetails" }, { "alternateAddresses": [ { "addressType": "None", "city": "SAN FRANCISCO", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1", "streetAddress3": "" } ], "error": {}, "validationStatus": "Valid", "validationType": "ValidateAddress" } ], "status": "AllValidToProceed" } } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": { "get": { "description": "Lists all the jobs available under the given resource group.", "operationId": "Jobs_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", "in": "query", "name": "$skipToken", "required": false, "type": "string" } ], "responses": { "200": { "description": "List of jobs by resource group.", "schema": { "$ref": "#/definitions/JobResourceList" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsListByResourceGroup": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "dc5cb221-1401-492c-abe7-9f74a5193c65" ] }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "isCancellable": true, "isCancellableWithoutFee": true, "isDeletable": false, "isShippingAddressEditable": true, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "DeviceOrdered" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": { "delete": { "description": "Deletes a job.", "operationId": "Jobs_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Accepted request for delete Job." }, "204": { "description": "Job deleted." }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsDelete": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "70328b56-a888-4a73-8b25-752da61cbc36" ] }, "responses": { "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets information about the specified job.", "operationId": "Jobs_Get", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "$expand is supported on details parameter for job, which provides details on the job stages.", "in": "query", "name": "$expand", "required": false, "type": "string" } ], "responses": { "200": { "description": "Job object.", "schema": { "$ref": "#/definitions/JobResource" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsGet": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "4a4a42b7-4d1a-40d7-aca7-9364f62832e1" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Public SDK Test", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [], "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Processed", "stageName": "DevicePrepared", "stageStatus": "None" }, { "displayName": "Dispatched", "stageName": "Dispatched", "stageStatus": "None" }, { "displayName": "Delivered", "stageName": "Delivered", "stageStatus": "None" }, { "displayName": "Picked up", "stageName": "PickedUp", "stageStatus": "None" }, { "displayName": "Received", "stageName": "AtAzureDC", "stageStatus": "None" }, { "displayName": "Data copy in progress", "stageName": "DataCopy", "stageStatus": "None" }, { "displayName": "Completed", "stageName": "Completed", "stageStatus": "None" } ], "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": true, "isCancellableWithoutFee": true, "isDeletable": false, "isShippingAddressEditable": true, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "DeviceOrdered" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } }, "JobsGet1": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3970", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "5822ad95-d3d8-40d2-9a0e-c6f318e5ac45" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3970", "location": "westus", "name": "SdkJob3970", "properties": { "cancellationReason": "CancelTest", "deliveryType": "NonScheduled", "details": { "chainOfCustodySasKey": "https://wusbeta.blob.core.windows.net/chainofcustody/6ce2f399-1cc7-4144-ba92-c50bd5324a5c.txt?sv=2017-04-17&sr=b&sig=pWxYQP3CDKU9TzRgzvbbT%2F48a1BjLeF10Rtz86%2FZ3qI%3D&st=2019-09-21T09%3A15%3A43Z&se=2019-09-21T09%3A45%3A43Z&sp=r", "contactDetails": { "contactName": " ", "emailList": [], "notificationPreference": [], "phone": "1234567890" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } }, "JobsGet2": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "f5665abc-b241-4cfb-88a5-3b3d2f7863e4" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "cancellationReason": "CancelTest", "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Update Job", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } }, "JobsGet3": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "5822ad95-d3d8-40d2-9a0e-c6f318e5ac45" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "cancellationReason": "CancelTest", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "details": { "chainOfCustodySasKey": "https://wusbeta.blob.core.windows.net/chainofcustody/6ce2f399-1cc7-4144-ba92-c50bd5324a5c.txt?sv=2017-04-17&sr=b&sig=pWxYQP3CDKU9TzRgzvbbT%2F48a1BjLeF10Rtz86%2FZ3qI%3D&st=2019-09-21T09%3A15%3A43Z&se=2019-09-21T09%3A45%3A43Z&sp=r", "contactDetails": { "contactName": " ", "emailList": [], "notificationPreference": [], "phone": "1234567890" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } }, "JobsGet4": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "f5665abc-b241-4cfb-88a5-3b3d2f7863e4" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "cancellationReason": "CancelTest", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Update Job", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } }, "JobsGet5": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "f5665abc-b241-4cfb-88a5-3b3d2f7863e4" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "cancellationReason": "CancelTest", "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Update Job", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } } } } } }, "patch": { "description": "Updates the properties of an existing job.", "operationId": "Jobs_Update", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", "in": "header", "name": "If-Match", "type": "string" }, { "description": "Job update parameters from request body.", "in": "body", "name": "jobResourceUpdateParameter", "required": true, "schema": { "$ref": "#/definitions/JobResourceUpdateParameter" } } ], "responses": { "200": { "description": "Job object.", "schema": { "$ref": "#/definitions/JobResource" } }, "202": { "description": "Accepted request for job updated." }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsPatch": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "Content-Length": [ "584" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "jobResourceUpdateParameter": { "properties": { "details": { "contactDetails": { "contactName": "Update Job", "emailList": [ "testing@microsoft.com" ], "phone": "1234567890", "phoneExtension": "1234" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } } } }, "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "04bb03ba-8e90-47c8-a1af-15e083036c6f" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "cancellationReason": "CancelTest", "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Update Job", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "bytesSentToCloud": 0, "dataDestinationType": "StorageAccount", "storageAccountName": "databoxbvttestaccount", "totalBytesToProcess": 0 } ], "deliveryPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Canceled", "stageName": "Cancelled", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:50:39.468691+05:30" } ], "returnPackage": { "carrierName": "", "trackingId": "", "trackingUrl": "" }, "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": false, "isCancellableWithoutFee": false, "isDeletable": true, "isShippingAddressEditable": false, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "Cancelled" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } }, "202": {} } } }, "x-ms-long-running-operation": true }, "put": { "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.", "operationId": "Jobs_Create", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Job details from request body.", "in": "body", "name": "jobResource", "required": true, "schema": { "$ref": "#/definitions/JobResource" } } ], "responses": { "200": { "description": "Job object.", "schema": { "$ref": "#/definitions/JobResource" } }, "202": { "description": "Accepted request for create Job." }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsCreate": { "parameters": { "Accept-Language": [ "en-US" ], "Content-Length": [ "983" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "SdkJob3971", "jobResource": { "location": "westus", "properties": { "details": { "contactDetails": { "contactName": "Public SDK Test", "emailList": [ "testing@microsoft.com" ], "phone": "1234567890", "phoneExtension": "1234" }, "destinationAccountDetails": [ { "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "jobDetailsType": "DataBox", "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } } }, "sku": { "name": "DataBox" } }, "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "f0ce17be-5da4-4184-88c9-50a701ad7d11" ] }, "responses": { "200": { "body": { "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg4981/providers/Microsoft.DataBox/jobs/SdkJob3971", "location": "westus", "name": "SdkJob3971", "properties": { "deliveryInfo": { "scheduledDateTime": "0001-01-01T05:30:00+05:30" }, "deliveryType": "NonScheduled", "details": { "contactDetails": { "contactName": "Public SDK Test", "emailList": [ "testing@microsoft.com" ], "notificationPreference": [ { "sendNotification": true, "stageName": "DevicePrepared" }, { "sendNotification": true, "stageName": "Dispatched" }, { "sendNotification": true, "stageName": "Delivered" }, { "sendNotification": true, "stageName": "PickedUp" }, { "sendNotification": true, "stageName": "AtAzureDC" }, { "sendNotification": true, "stageName": "DataCopy" } ], "phone": "1234567890", "phoneExtension": "1234" }, "copyLogDetails": [], "copyProgress": [], "destinationAccountDetails": [ { "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "errorDetails": [], "jobDetailsType": "DataBox", "jobStages": [ { "displayName": "Ordered", "stageName": "DeviceOrdered", "stageStatus": "Succeeded", "stageTime": "2019-09-21T14:49:52.3995743+05:30" }, { "displayName": "Processed", "stageName": "DevicePrepared", "stageStatus": "None" }, { "displayName": "Dispatched", "stageName": "Dispatched", "stageStatus": "None" }, { "displayName": "Delivered", "stageName": "Delivered", "stageStatus": "None" }, { "displayName": "Picked up", "stageName": "PickedUp", "stageStatus": "None" }, { "displayName": "Received", "stageName": "AtAzureDC", "stageStatus": "None" }, { "displayName": "Data copy in progress", "stageName": "DataCopy", "stageStatus": "None" }, { "displayName": "Completed", "stageName": "Completed", "stageStatus": "None" } ], "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" } }, "isCancellable": true, "isCancellableWithoutFee": true, "isDeletable": false, "isShippingAddressEditable": true, "startTime": "2019-09-21T14:49:49.0027611+05:30", "status": "DeviceOrdered" }, "sku": { "name": "DataBox" }, "tags": {}, "type": "Microsoft.DataBox/jobs" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { "post": { "description": "Book shipment pick up.", "operationId": "Jobs_BookShipmentPickUp", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Details of shipment pick up request.", "in": "body", "name": "shipmentPickUpRequest", "required": true, "schema": { "$ref": "#/definitions/ShipmentPickUpRequest" } } ], "responses": { "200": { "description": "Booked shipment pick up successfully.", "schema": { "$ref": "#/definitions/ShipmentPickUpResponse" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "BookShipmentPickupPost": { "parameters": { "Accept-Language": [ "en-US" ], "Content-Length": [ "118" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "TJ-636646322037905056", "resourceGroupName": "bvttoolrg6", "shipmentPickUpRequest": { "endTime": "2019-09-22T18:30:00Z", "shipmentLocation": "Front desk", "startTime": "2019-09-20T18:30:00Z" }, "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "e1437186-b41d-492e-9b7a-e197c28a517a" ] }, "responses": { "200": { "body": { "confirmationNumber": "2929602E9CP", "readyByTime": "2019-09-20T18:30:00Z" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": { "post": { "description": "CancelJob.", "operationId": "Jobs_Cancel", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Reason for cancellation.", "in": "body", "name": "cancellationReason", "required": true, "schema": { "$ref": "#/definitions/CancellationReason" } } ], "responses": { "204": { "description": "Job cancelled." }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsCancelPost": { "parameters": { "$expand": "details", "Accept-Language": [ "en-US" ], "Content-Length": [ "30" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "cancellationReason": { "reason": "CancelTest" }, "jobName": "SdkJob3971", "resourceGroupName": "SdkRg4981", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "5e3d8f70-7ee0-45aa-9c12-6d505e577b54" ] }, "responses": { "204": {} } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials": { "post": { "description": "This method gets the unencrypted secrets related to the job.", "operationId": "Jobs_ListCredentials", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/jobNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "List of unencrypted credentials of the job.", "schema": { "$ref": "#/definitions/UnencryptedCredentialsList" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Jobs" ], "x-ms-examples": { "JobsListCredentials": { "parameters": { "Accept-Language": [ "en-US" ], "User-Agent": [ "FxVersion/4.6.27817.01", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.18362.", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "api-version": "2019-09-01", "jobName": "TJ-636646322037905056", "resourceGroupName": "bvttoolrg6", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "03b50fba-1fac-429d-9edb-e3bfd95b9c20" ] }, "responses": { "200": { "body": { "value": [ { "jobName": "TJ-636646322037905056", "jobSecrets": { "dcAccessSecurityCode": {}, "jobSecretsType": "DataBox", "podSecrets": [ { "accountCredentialDetails": [ { "accountConnectionString": "", "accountName": "databoxbvttestaccount", "dataDestinationType": "StorageAccount", "shareCredentialDetails": [ { "password": "4N)K4(j6tyR", "shareName": "databoxbvttestaccount_PageBlob", "shareType": "PageBlob", "supportedAccessProtocols": [ "SMB" ], "userName": "databoxbvttestac_903" }, { "password": "4N)K4(j6tyR", "shareName": "databoxbvttestaccount_BlockBlob", "shareType": "BlockBlob", "supportedAccessProtocols": [ "SMB" ], "userName": "databoxbvttestac_903" }, { "password": "4N)K4(j6tyR", "shareName": "databoxbvttestaccount_AzFile", "shareType": "AzureFile", "supportedAccessProtocols": [ "SMB" ], "userName": "databoxbvttestac_903" } ] } ], "devicePassword": "cT5nt8R;S%5", "deviceSerialNumber": "testimolapod-3ecc44ce", "encodedValidationCertPubKey": "5CYoAoVKEBa4WgPVis8keX94w30pon4jGMADSqcdE/NlHLChj6Cmhbl4q9QOFKSB/US4AwhS7zY1QS3YMDrkAPfOy7Hi6kWMBpJWZidTq3oXX8FAQjg+IqQESti/2jvAlcDpO2453rgd7Yb6XZ43P8MMTpTjcarI0ImCf//eITQWnFa3AzfIJ9C+hxCCaA7HTYhwQEPUBMwyQJsI6v6WuQysROtlBgx1YtbWFhDVbcqYRSLIbaj+RdzlvxvDJSo70kv+8em5upuDTpVE7xP+WePLlARdSPNwwfRzHnvCUqC2UqXHpRUhQlYnMqAJEcjjroRnyIGumPmmQ8O155X8aw==", "networkConfigurations": [ { "macAddress": "D05099C1F439", "name": "DataPort3" }, { "macAddress": "EC0D9A21A6C0", "name": "DataPort1" }, { "macAddress": "EC0D9A21A6C1", "name": "DataPort2" } ] } ] } } ] } } } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { "post": { "description": "This method provides the list of available skus for the given subscription, resource group and location.", "operationId": "Service_ListAvailableSkusByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Filters for showing the available skus.", "in": "body", "name": "availableSkuRequest", "required": true, "schema": { "$ref": "#/definitions/AvailableSkuRequest" } } ], "responses": { "200": { "description": "The list of available skus under Resource group.", "schema": { "$ref": "#/definitions/AvailableSkusResult" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "AvailableSkusByResourceGroup": { "parameters": { "Content-Length": [ "84" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2018-01-01", "availableSkuRequest": { "country": "US", "location": "westus", "transferType": "ImportToAzure" }, "location": "westus", "resourceGroupName": "SdkRg9836", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "x-ms-client-request-id": [ "a69a48a0-a372-444d-9251-83828238a521" ] }, "responses": { "200": { "body": { "value": [ { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "100", "usable": "80" }, "costs": [ { "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", "meterType": "DataBoxServiceFee" }, { "meterId": "a701f058-119b-4713-a923-bed7da4b7801", "meterType": "DataBoxShippingFee" }, { "meterId": "049fa331-0a48-4a81-9991-a6bef3c79fed", "meterType": "DataBoxExtraDayFee" } ], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None" }, "sku": { "name": "DataBox" } }, { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "40", "usable": "35" }, "costs": [], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None" }, "sku": { "name": "DataBoxDisk" } }, { "enabled": true, "properties": { "apiVersions": [ "2018-01-01" ], "capacity": { "maximum": "1000", "usable": "800" }, "costs": [], "destinationToServiceLocationMap": [ { "destinationLocation": "westus", "serviceLocation": "westus" }, { "destinationLocation": "centralus", "serviceLocation": "westus" }, { "destinationLocation": "eastus", "serviceLocation": "westus" }, { "destinationLocation": "eastus2", "serviceLocation": "westus" }, { "destinationLocation": "northcentralus", "serviceLocation": "westus" }, { "destinationLocation": "southcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westcentralus", "serviceLocation": "westus" }, { "destinationLocation": "westus2", "serviceLocation": "westus" }, { "destinationLocation": "centraluseuap", "serviceLocation": "centraluseuap" }, { "destinationLocation": "eastus2euap", "serviceLocation": "eastus2euap" } ], "disabledReason": "None", "requiredFeature": "HeavyCreateAccess" }, "sku": { "name": "DataBoxHeavy" } } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { "post": { "description": "This method does all necessary pre-job creation validation under resource group.", "operationId": "Service_ValidateInputsByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/locationParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "description": "Inputs of the customer.", "in": "body", "name": "validationRequest", "required": true, "schema": { "$ref": "#/definitions/ValidationRequest" } } ], "responses": { "200": { "description": "The validation status and responses of each validating parameter.", "schema": { "$ref": "#/definitions/ValidationResponse" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "Service" ], "x-ms-examples": { "ServiceValidateInputsByResourceGroup": { "parameters": { "Content-Length": [ "311" ], "Content-Type": [ "application/json; charset=utf-8" ], "User-Agent": [ "FxVersion/4.6.26614.01", "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" ], "accept-language": [ "en-US" ], "api-version": "2019-09-01", "location": "westus", "resourceGroupName": "SdkRg9836", "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "validationRequest": { "individualRequestDetails": [ { "destinationAccountDetails": [ { "dataDestinationType": "StorageAccount", "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" } ], "location": "westus", "validationType": "ValidateDataDestinationDetails" }, { "deviceType": "DataBox", "shippingAddress": { "addressType": "Commercial", "city": "San Francisco", "companyName": "Microsoft", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1" }, "validationType": "ValidateAddress" } ], "validationCategory": "JobCreationValidation" }, "x-ms-client-request-id": [ "ee686d79-42c2-4b01-9afe-5e99f4cabfee" ] }, "responses": { "200": { "body": { "properties": { "individualResponseDetails": [ { "error": {}, "status": "Valid", "validationType": "ValidateDataDestinationDetails" }, { "alternateAddresses": [ { "addressType": "None", "city": "SAN FRANCISCO", "country": "US", "postalCode": "94107", "stateOrProvince": "CA", "streetAddress1": "16 TOWNSEND ST", "streetAddress2": "Unit 1", "streetAddress3": "" } ], "error": {}, "validationStatus": "Valid", "validationType": "ValidateAddress" } ], "status": "AllValidToProceed" } } } } } } } } }, "definitions": { "AccountCredentialDetails": { "description": "Credential details of the account.", "properties": { "accountConnectionString": { "description": "Connection string of the account endpoint to use the account as a storage endpoint on the device.", "readOnly": true, "type": "string" }, "accountName": { "description": "Name of the account.", "readOnly": true, "type": "string" }, "dataDestinationType": { "description": "Data Destination Type.", "enum": [ "StorageAccount", "ManagedDisk" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "DataDestinationType", "values": [ { "description": "Storage Accounts .", "value": "StorageAccount" }, { "description": "Azure Managed disk storage.", "value": "ManagedDisk" } ] } }, "shareCredentialDetails": { "description": "Per share level unencrypted access credentials.", "items": { "$ref": "#/definitions/ShareCredentialDetails" }, "readOnly": true, "type": "array" } }, "type": "object" }, "AddressValidationOutput": { "description": "Output of the address validation api.", "properties": { "properties": { "$ref": "#/definitions/AddressValidationProperties", "description": "The address validation properties.", "readOnly": true, "x-ms-client-flatten": true } }, "type": "object" }, "AddressValidationProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "The address validation output.", "properties": { "alternateAddresses": { "description": "List of alternate addresses.", "items": { "$ref": "#/definitions/ShippingAddress" }, "readOnly": true, "type": "array" }, "validationStatus": { "description": "The address validation status.", "enum": [ "Valid", "Invalid", "Ambiguous" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "AddressValidationStatus", "values": [ { "description": "Address provided is valid.", "value": "Valid" }, { "description": "Address provided is invalid or not supported.", "value": "Invalid" }, { "description": "Address provided is ambiguous, please choose one of the alternate addresses returned.", "value": "Ambiguous" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateAddress" }, "ApplianceNetworkConfiguration": { "description": "The Network Adapter configuration of a DataBox.", "properties": { "macAddress": { "description": "Mac Address.", "readOnly": true, "type": "string" }, "name": { "description": "Name of the network.", "readOnly": true, "type": "string" } }, "type": "object" }, "ArmBaseObject": { "description": "Base class for all objects under resource.", "properties": { "id": { "description": "Id of the object.", "readOnly": true, "type": "string" }, "name": { "description": "Name of the object.", "readOnly": true, "type": "string" }, "type": { "description": "Type of the object.", "readOnly": true, "type": "string" } }, "type": "object" }, "AvailableSkuRequest": { "description": "The filters for showing the available skus.", "properties": { "country": { "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", "type": "string" }, "location": { "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", "type": "string" }, "skuNames": { "description": "Sku Names to filter for available skus", "items": { "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Databox.", "value": "DataBox" }, { "description": "DataboxDisk.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy.", "value": "DataBoxHeavy" } ] } }, "type": "array" }, "transferType": { "description": "Type of the transfer.", "enum": [ "ImportToAzure" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "TransferType", "values": [ { "description": "Import data to azure.", "value": "ImportToAzure" } ] } } }, "required": [ "transferType", "country", "location" ], "type": "object" }, "AvailableSkusResult": { "description": "The available skus operation response.", "properties": { "nextLink": { "description": "Link for the next set of skus.", "type": "string" }, "value": { "description": "List of available skus.", "items": { "$ref": "#/definitions/SkuInformation" }, "readOnly": true, "type": "array" } }, "type": "object" }, "CancellationReason": { "description": "Reason for cancellation.", "properties": { "reason": { "description": "Reason for cancellation.", "type": "string" } }, "required": [ "reason" ], "type": "object" }, "CloudError": { "description": "The error information object.", "properties": { "code": { "description": "Error code string.", "readOnly": true, "type": "string" }, "details": { "description": "More detailed error information.", "items": { "$ref": "#/definitions/CloudError" }, "type": "array" }, "message": { "description": "Descriptive error information.", "readOnly": true, "type": "string" }, "target": { "description": "Error target", "type": "string" } }, "x-ms-external": true }, "ContactDetails": { "description": "Contact Details.", "properties": { "contactName": { "description": "Contact name of the person.", "type": "string" }, "emailList": { "description": "List of Email-ids to be notified about job progress.", "items": { "type": "string" }, "type": "array" }, "mobile": { "description": "Mobile number of the contact person.", "type": "string" }, "notificationPreference": { "description": "Notification preference for a job stage.", "items": { "$ref": "#/definitions/NotificationPreference" }, "type": "array" }, "phone": { "description": "Phone number of the contact person.", "type": "string" }, "phoneExtension": { "description": "Phone extension number of the contact person.", "type": "string" } }, "required": [ "contactName", "phone", "emailList" ], "type": "object" }, "CopyLogDetails": { "description": "Details for log generated during copy.", "discriminator": "copyLogDetailsType", "properties": { "copyLogDetailsType": { "description": "Indicates the type of job details.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": false, "name": "ClassDiscriminator", "values": [ { "description": "Databox orders.", "value": "DataBox" }, { "description": "DataboxDisk orders.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy orders.", "value": "DataBoxHeavy" } ] } } }, "required": [ "copyLogDetailsType" ], "type": "object" }, "CopyProgress": { "description": "Copy progress.", "properties": { "accountId": { "description": "Id of the account where the data needs to be uploaded.", "readOnly": true, "type": "string" }, "bytesSentToCloud": { "description": "Amount of data uploaded by the job as of now.", "format": "int64", "readOnly": true, "type": "integer" }, "dataDestinationType": { "description": "Data Destination Type.", "enum": [ "StorageAccount", "ManagedDisk" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "DataDestinationType", "values": [ { "description": "Storage Accounts .", "value": "StorageAccount" }, { "description": "Azure Managed disk storage.", "value": "ManagedDisk" } ] } }, "filesErroredOut": { "description": "Number of files which could not be copied", "format": "int64", "readOnly": true, "type": "integer" }, "filesProcessed": { "description": "Number of files processed by the job as of now.", "format": "int64", "readOnly": true, "type": "integer" }, "invalidFileBytesUploaded": { "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming", "format": "int64", "readOnly": true, "type": "integer" }, "invalidFilesProcessed": { "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming", "format": "int64", "readOnly": true, "type": "integer" }, "renamedContainerCount": { "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming", "format": "int64", "readOnly": true, "type": "integer" }, "storageAccountName": { "description": "Name of the storage account where the data needs to be uploaded.", "readOnly": true, "type": "string" }, "totalBytesToProcess": { "description": "Total amount of data to be processed by the job.", "format": "int64", "readOnly": true, "type": "integer" }, "totalFilesToProcess": { "description": "Total number of files to be processed by the job.", "format": "int64", "readOnly": true, "type": "integer" } }, "type": "object" }, "CreateJobValidations": { "allOf": [ { "$ref": "#/definitions/ValidationRequest" } ], "description": "It does all pre-job creation validations.", "properties": {}, "required": [ "validationCategory", "individualRequestDetails" ], "type": "object", "x-ms-discriminator-value": "JobCreationValidation" }, "CreateOrderLimitForSubscriptionValidationRequest": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "Request to validate create order limit for current subscription.", "properties": { "deviceType": { "description": "Device type to be used for the job.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Data Box.", "value": "DataBox" }, { "description": "Data Box Disk.", "value": "DataBoxDisk" }, { "description": "Data Box Heavy.", "value": "DataBoxHeavy" } ] } } }, "required": [ "deviceType", "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateCreateOrderLimit" }, "CreateOrderLimitForSubscriptionValidationResponseProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "Properties of create order limit for subscription validation response.", "properties": { "status": { "description": "Create order limit validation status.", "enum": [ "Valid", "Invalid", "Skipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationStatus", "values": [ { "description": "Validation is successful", "value": "Valid" }, { "description": "Validation is not successful", "value": "Invalid" }, { "description": "Validation is skipped", "value": "Skipped" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateCreateOrderLimit" }, "DataBoxAccountCopyLogDetails": { "allOf": [ { "$ref": "#/definitions/CopyLogDetails" } ], "description": "Copy log details for a storage account of a DataBox job", "properties": { "accountName": { "description": "Destination account name.", "readOnly": true, "type": "string" }, "copyLogLink": { "description": "Link for copy logs.", "readOnly": true, "type": "string" } }, "required": [ "copyLogDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBox" }, "DataBoxDiskCopyLogDetails": { "allOf": [ { "$ref": "#/definitions/CopyLogDetails" } ], "description": "Copy Log Details for a disk", "properties": { "diskSerialNumber": { "description": "Disk Serial Number.", "readOnly": true, "type": "string" }, "errorLogLink": { "description": "Link for copy error logs.", "readOnly": true, "type": "string" }, "verboseLogLink": { "description": "Link for copy verbose logs.", "readOnly": true, "type": "string" } }, "required": [ "copyLogDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxDisk" }, "DataBoxDiskCopyProgress": { "description": "DataBox Disk Copy Progress", "properties": { "bytesCopied": { "description": "Bytes copied during the copy of disk.", "format": "int64", "readOnly": true, "type": "integer" }, "percentComplete": { "description": "Indicates the percentage completed for the copy of the disk.", "format": "int32", "readOnly": true, "type": "integer" }, "serialNumber": { "description": "The serial number of the disk", "readOnly": true, "type": "string" }, "status": { "description": "The Status of the copy", "enum": [ "NotStarted", "InProgress", "Completed", "CompletedWithErrors", "Failed", "NotReturned", "HardwareError", "DeviceFormatted", "DeviceMetadataModified", "StorageAccountNotAccessible", "UnsupportedData" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "CopyStatus", "values": [ { "description": "Data copy hasn't started yet.", "value": "NotStarted" }, { "description": "Data copy is in progress.", "value": "InProgress" }, { "description": "Data copy completed.", "value": "Completed" }, { "description": "Data copy completed with errors.", "value": "CompletedWithErrors" }, { "description": "Data copy failed. No data was copied.", "value": "Failed" }, { "description": "No copy triggered as device was not returned.", "value": "NotReturned" }, { "description": "The Device has hit hardware issues.", "value": "HardwareError" }, { "description": "Data copy failed. The Device was formatted by user.", "value": "DeviceFormatted" }, { "description": "Data copy failed. Device metadata was modified by user.", "value": "DeviceMetadataModified" }, { "description": "Data copy failed. Storage Account was not accessible during copy.", "value": "StorageAccountNotAccessible" }, { "description": "Data copy failed. The Device data content is not supported.", "value": "UnsupportedData" } ] } } }, "type": "object" }, "DataBoxDiskJobDetails": { "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "description": "DataBox Disk Job Details.", "properties": { "copyProgress": { "description": "Copy progress per disk.", "items": { "$ref": "#/definitions/DataBoxDiskCopyProgress" }, "readOnly": true, "type": "array" }, "disksAndSizeDetails": { "additionalProperties": { "format": "int32", "type": "integer" }, "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.", "readOnly": true, "type": "object" }, "passkey": { "description": "User entered passkey for DataBox Disk job.", "type": "string" }, "preferredDisks": { "additionalProperties": { "format": "int32", "type": "integer" }, "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.", "type": "object" } }, "required": [ "contactDetails", "shippingAddress", "destinationAccountDetails", "jobDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxDisk" }, "DataBoxDiskJobSecrets": { "allOf": [ { "$ref": "#/definitions/JobSecrets" } ], "description": "The secrets related to disk job.", "properties": { "diskSecrets": { "description": "Contains the list of secrets object for that device.", "items": { "$ref": "#/definitions/DiskSecret" }, "readOnly": true, "type": "array" }, "isPasskeyUserDefined": { "description": "Whether passkey was provided by user.", "readOnly": true, "type": "boolean" }, "passKey": { "description": "PassKey for the disk Job.", "readOnly": true, "type": "string" } }, "required": [ "jobSecretsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxDisk" }, "DataBoxHeavyAccountCopyLogDetails": { "allOf": [ { "$ref": "#/definitions/CopyLogDetails" } ], "description": "Copy log details for a storage account for Databox heavy", "properties": { "accountName": { "description": "Destination account name.", "readOnly": true, "type": "string" }, "copyLogLink": { "description": "Link for copy logs.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "copyLogDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavyJobDetails": { "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "description": "Databox Heavy Device Job Details", "properties": { "copyProgress": { "description": "Copy progress per account.", "items": { "$ref": "#/definitions/CopyProgress" }, "readOnly": true, "type": "array" }, "devicePassword": { "description": "Set Device password for unlocking Databox Heavy", "type": "string" } }, "required": [ "contactDetails", "shippingAddress", "destinationAccountDetails", "jobDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavyJobSecrets": { "allOf": [ { "$ref": "#/definitions/JobSecrets" } ], "description": "The secrets related to a databox heavy job.", "properties": { "cabinetPodSecrets": { "description": "Contains the list of secret objects for a databox heavy job.", "items": { "$ref": "#/definitions/DataBoxHeavySecret" }, "readOnly": true, "type": "array" } }, "required": [ "jobSecretsType" ], "type": "object", "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavySecret": { "description": "The secrets related to a databox heavy.", "properties": { "accountCredentialDetails": { "description": "Per account level access credentials.", "items": { "$ref": "#/definitions/AccountCredentialDetails" }, "readOnly": true, "type": "array" }, "devicePassword": { "description": "Password for out of the box experience on device.", "readOnly": true, "type": "string" }, "deviceSerialNumber": { "description": "Serial number of the assigned device.", "readOnly": true, "type": "string" }, "encodedValidationCertPubKey": { "description": "The base 64 encoded public key to authenticate with the device", "readOnly": true, "type": "string" }, "networkConfigurations": { "description": "Network configuration of the appliance.", "items": { "$ref": "#/definitions/ApplianceNetworkConfiguration" }, "readOnly": true, "type": "array" } }, "type": "object" }, "DataBoxJobDetails": { "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "description": "Databox Job Details", "properties": { "copyProgress": { "description": "Copy progress per storage account.", "items": { "$ref": "#/definitions/CopyProgress" }, "readOnly": true, "type": "array" }, "devicePassword": { "description": "Set Device password for unlocking Databox", "type": "string" } }, "required": [ "contactDetails", "shippingAddress", "destinationAccountDetails", "jobDetailsType" ], "type": "object", "x-ms-discriminator-value": "DataBox" }, "DataBoxScheduleAvailabilityRequest": { "allOf": [ { "$ref": "#/definitions/ScheduleAvailabilityRequest" } ], "description": "Request body to get the availability for scheduling data box orders orders.", "properties": {}, "required": [ "storageLocation", "skuName" ], "type": "object", "x-ms-discriminator-value": "DataBox" }, "DataBoxSecret": { "description": "The secrets related to a DataBox.", "properties": { "accountCredentialDetails": { "description": "Per account level access credentials.", "items": { "$ref": "#/definitions/AccountCredentialDetails" }, "readOnly": true, "type": "array" }, "devicePassword": { "description": "Password for out of the box experience on device.", "readOnly": true, "type": "string" }, "deviceSerialNumber": { "description": "Serial number of the assigned device.", "readOnly": true, "type": "string" }, "encodedValidationCertPubKey": { "description": "The base 64 encoded public key to authenticate with the device", "readOnly": true, "type": "string" }, "networkConfigurations": { "description": "Network configuration of the appliance.", "items": { "$ref": "#/definitions/ApplianceNetworkConfiguration" }, "readOnly": true, "type": "array" } }, "type": "object" }, "DataDestinationDetailsValidationRequest": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "Request to validate data destination details.", "properties": { "destinationAccountDetails": { "description": "Destination account details list.", "items": { "$ref": "#/definitions/DestinationAccountDetails" }, "type": "array" }, "location": { "description": "Location of stamp or geo.", "type": "string" } }, "required": [ "destinationAccountDetails", "location", "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateDataDestinationDetails" }, "DataDestinationDetailsValidationResponseProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "Properties of data destination details validation response.", "properties": { "status": { "description": "Data destination details validation status.", "enum": [ "Valid", "Invalid", "Skipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationStatus", "values": [ { "description": "Validation is successful", "value": "Valid" }, { "description": "Validation is not successful", "value": "Invalid" }, { "description": "Validation is skipped", "value": "Skipped" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateDataDestinationDetails" }, "DataboxJobSecrets": { "allOf": [ { "$ref": "#/definitions/JobSecrets" } ], "description": "The secrets related to a databox job.", "properties": { "podSecrets": { "description": "Contains the list of secret objects for a job.", "items": { "$ref": "#/definitions/DataBoxSecret" }, "type": "array" } }, "required": [ "jobSecretsType" ], "type": "object", "x-ms-discriminator-value": "DataBox" }, "DcAccessSecurityCode": { "description": "Dc Access Security code for device.", "properties": { "forwardDcAccessCode": { "description": "Dc Access Code for dispatching from DC.", "type": "string" }, "reverseDcAccessCode": { "description": "Dc Access code for dropping off at DC.", "type": "string" } }, "type": "object" }, "DestinationAccountDetails": { "description": "Details of the destination storage accounts.", "discriminator": "dataDestinationType", "properties": { "accountId": { "description": "Arm Id of the destination where the data has to be moved.", "type": "string" }, "dataDestinationType": { "description": "Data Destination Type.", "enum": [ "StorageAccount", "ManagedDisk" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "DataDestinationType", "values": [ { "description": "Storage Accounts .", "value": "StorageAccount" }, { "description": "Azure Managed disk storage.", "value": "ManagedDisk" } ] } }, "sharePassword": { "description": "Share password to be shared by all shares in SA.", "type": "string" } }, "required": [ "dataDestinationType" ], "type": "object" }, "DestinationManagedDiskDetails": { "allOf": [ { "$ref": "#/definitions/DestinationAccountDetails" } ], "description": "Details for the destination compute disks.", "properties": { "resourceGroupId": { "description": "Destination Resource Group Id where the Compute disks should be created.", "type": "string" }, "stagingStorageAccountId": { "description": "Arm Id of the storage account that can be used to copy the vhd for staging.", "type": "string" } }, "required": [ "resourceGroupId", "stagingStorageAccountId", "dataDestinationType" ], "type": "object", "x-ms-discriminator-value": "ManagedDisk" }, "DestinationStorageAccountDetails": { "allOf": [ { "$ref": "#/definitions/DestinationAccountDetails" } ], "description": "Details for the destination storage account.", "properties": { "storageAccountId": { "description": "Destination Storage Account Arm Id.", "type": "string" } }, "required": [ "storageAccountId", "dataDestinationType" ], "type": "object", "x-ms-discriminator-value": "StorageAccount" }, "DestinationToServiceLocationMap": { "description": "Map of destination location to service location.", "properties": { "destinationLocation": { "description": "Location of the destination.", "readOnly": true, "type": "string" }, "serviceLocation": { "description": "Location of the service.", "readOnly": true, "type": "string" } }, "type": "object" }, "DiskScheduleAvailabilityRequest": { "allOf": [ { "$ref": "#/definitions/ScheduleAvailabilityRequest" } ], "description": "Request body to get the availability for scheduling disk orders.", "properties": { "expectedDataSizeInTerabytes": { "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", "format": "int32", "type": "integer" } }, "required": [ "expectedDataSizeInTerabytes", "storageLocation", "skuName" ], "type": "object", "x-ms-discriminator-value": "DataBoxDisk" }, "DiskSecret": { "description": "Contains all the secrets of a Disk.", "properties": { "bitLockerKey": { "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.", "readOnly": true, "type": "string" }, "diskSerialNumber": { "description": "Serial number of the assigned disk.", "readOnly": true, "type": "string" } }, "type": "object" }, "Error": { "description": "Top level error for the job.", "properties": { "code": { "description": "Error code that can be used to programmatically identify the error.", "readOnly": true, "type": "string" }, "message": { "description": "Describes the error in detail and provides debugging information.", "readOnly": true, "type": "string" } }, "type": "object" }, "HeavyScheduleAvailabilityRequest": { "allOf": [ { "$ref": "#/definitions/ScheduleAvailabilityRequest" } ], "description": "Request body to get the availability for scheduling heavy orders.", "properties": {}, "required": [ "storageLocation", "skuName" ], "type": "object", "x-ms-discriminator-value": "DataBoxHeavy" }, "JobDeliveryInfo": { "description": "Additional delivery info.", "properties": { "scheduledDateTime": { "description": "Scheduled date time.", "format": "date-time", "type": "string" } }, "type": "object" }, "JobDetails": { "description": "Job details.", "discriminator": "jobDetailsType", "properties": { "chainOfCustodySasKey": { "description": "Shared access key to download the chain of custody logs", "readOnly": true, "type": "string" }, "contactDetails": { "$ref": "#/definitions/ContactDetails", "description": "Contact details for notification and shipping." }, "copyLogDetails": { "description": "List of copy log details.", "items": { "$ref": "#/definitions/CopyLogDetails" }, "readOnly": true, "type": "array" }, "deliveryPackage": { "$ref": "#/definitions/PackageShippingDetails", "description": "Delivery package shipping details.", "readOnly": true }, "destinationAccountDetails": { "description": "Destination account details.", "items": { "$ref": "#/definitions/DestinationAccountDetails" }, "type": "array" }, "errorDetails": { "description": "Error details for failure. This is optional.", "items": { "$ref": "#/definitions/JobErrorDetails" }, "readOnly": true, "type": "array" }, "expectedDataSizeInTerabytes": { "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", "format": "int32", "type": "integer" }, "jobDetailsType": { "description": "Indicates the type of job details.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": false, "name": "ClassDiscriminator", "values": [ { "description": "Databox orders.", "value": "DataBox" }, { "description": "DataboxDisk orders.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy orders.", "value": "DataBoxHeavy" } ] } }, "jobStages": { "description": "List of stages that run in the job.", "items": { "$ref": "#/definitions/JobStages" }, "readOnly": true, "type": "array" }, "preferences": { "$ref": "#/definitions/Preferences", "description": "Preferences for the order." }, "returnPackage": { "$ref": "#/definitions/PackageShippingDetails", "description": "Return package shipping details.", "readOnly": true }, "reverseShipmentLabelSasKey": { "description": "Shared access key to download the return shipment label", "readOnly": true, "type": "string" }, "shippingAddress": { "$ref": "#/definitions/ShippingAddress", "description": "Shipping address of the customer." } }, "required": [ "contactDetails", "shippingAddress", "destinationAccountDetails", "jobDetailsType" ], "type": "object" }, "JobErrorDetails": { "description": "Job Error Details for providing the information and recommended action.", "properties": { "errorCode": { "description": "Code for the error.", "format": "int32", "readOnly": true, "type": "integer" }, "errorMessage": { "description": "Message for the error.", "readOnly": true, "type": "string" }, "exceptionMessage": { "description": "Contains the non localized exception message", "readOnly": true, "type": "string" }, "recommendedAction": { "description": "Recommended action for the error.", "readOnly": true, "type": "string" } }, "type": "object" }, "JobProperties": { "description": "Job Properties", "properties": { "cancellationReason": { "description": "Reason for cancellation.", "readOnly": true, "type": "string" }, "deliveryInfo": { "$ref": "#/definitions/JobDeliveryInfo", "description": "Delivery Info of Job." }, "deliveryType": { "description": "Delivery type of Job.", "enum": [ "NonScheduled", "Scheduled" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "JobDeliveryType", "values": [ { "description": "Non Scheduled job.", "value": "NonScheduled" }, { "description": "Scheduled job.", "value": "Scheduled" } ] } }, "details": { "$ref": "#/definitions/JobDetails", "description": "Details of a job run. This field will only be sent for expand details filter." }, "error": { "$ref": "#/definitions/Error", "description": "Top level error for the job.", "readOnly": true }, "isCancellable": { "description": "Describes whether the job is cancellable or not.", "readOnly": true, "type": "boolean" }, "isCancellableWithoutFee": { "description": "Flag to indicate cancellation of scheduled job.", "readOnly": true, "type": "boolean" }, "isDeletable": { "description": "Describes whether the job is deletable or not.", "readOnly": true, "type": "boolean" }, "isShippingAddressEditable": { "description": "Describes whether the shipping address is editable or not.", "readOnly": true, "type": "boolean" }, "startTime": { "description": "Time at which the job was started in UTC ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "Name of the stage which is in progress.", "enum": [ "DeviceOrdered", "DevicePrepared", "Dispatched", "Delivered", "PickedUp", "AtAzureDC", "DataCopy", "Completed", "CompletedWithErrors", "Cancelled", "Failed_IssueReportedAtCustomer", "Failed_IssueDetectedAtAzureDC", "Aborted", "CompletedWithWarnings", "ReadyToDispatchFromAzureDC", "ReadyToReceiveAtAzureDC" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "StageName", "values": [ { "description": "An order has been created.", "value": "DeviceOrdered" }, { "description": "A device has been prepared for the order.", "value": "DevicePrepared" }, { "description": "Device has been dispatched to the user of the order.", "value": "Dispatched" }, { "description": "Device has been delivered to the user of the order.", "value": "Delivered" }, { "description": "Device has been picked up from user and in transit to azure datacenter.", "value": "PickedUp" }, { "description": "Device has been received at azure datacenter from the user.", "value": "AtAzureDC" }, { "description": "Data copy from the device at azure datacenter.", "value": "DataCopy" }, { "description": "Order has completed.", "value": "Completed" }, { "description": "Order has completed with errors.", "value": "CompletedWithErrors" }, { "description": "Order has been cancelled.", "value": "Cancelled" }, { "description": "Order has failed due to issue reported by user.", "value": "Failed_IssueReportedAtCustomer" }, { "description": "Order has failed due to issue detected at azure datacenter.", "value": "Failed_IssueDetectedAtAzureDC" }, { "description": "Order has been aborted.", "value": "Aborted" }, { "description": "Order has completed with warnings.", "value": "CompletedWithWarnings" }, { "description": "Device is ready to be handed to customer from Azure DC.", "value": "ReadyToDispatchFromAzureDC" }, { "description": "Device can be dropped off at Azure DC.", "value": "ReadyToReceiveAtAzureDC" } ] } } }, "type": "object" }, "JobResource": { "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Job Resource.", "properties": { "id": { "description": "Id of the object.", "readOnly": true, "type": "string" }, "name": { "description": "Name of the object.", "readOnly": true, "type": "string" }, "properties": { "$ref": "#/definitions/JobProperties", "description": "Properties of a job.", "x-ms-client-flatten": true }, "type": { "description": "Type of the object.", "readOnly": true, "type": "string" } }, "required": [ "properties" ], "type": "object" }, "JobResourceList": { "description": "Job Resource Collection", "properties": { "nextLink": { "description": "Link for the next set of job resources.", "type": "string" }, "value": { "description": "List of job resources.", "items": { "$ref": "#/definitions/JobResource" }, "type": "array" } }, "type": "object" }, "JobResourceUpdateParameter": { "description": "The JobResourceUpdateParameter.", "properties": { "properties": { "$ref": "#/definitions/UpdateJobProperties", "description": "Properties of a job to be updated.", "x-ms-client-flatten": true }, "tags": { "additionalProperties": { "type": "string" }, "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", "type": "object" } }, "type": "object" }, "JobSecrets": { "description": "The base class for the secrets", "discriminator": "jobSecretsType", "properties": { "dcAccessSecurityCode": { "$ref": "#/definitions/DcAccessSecurityCode", "description": "Dc Access Security Code for Customer Managed Shipping" }, "jobSecretsType": { "description": "Used to indicate what type of job secrets object.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": false, "name": "ClassDiscriminator", "values": [ { "description": "Databox orders.", "value": "DataBox" }, { "description": "DataboxDisk orders.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy orders.", "value": "DataBoxHeavy" } ] } } }, "required": [ "jobSecretsType" ], "type": "object" }, "JobStages": { "description": "Job stages.", "properties": { "displayName": { "description": "Display name of the job stage.", "readOnly": true, "type": "string" }, "errorDetails": { "description": "Error details for the stage.", "items": { "$ref": "#/definitions/JobErrorDetails" }, "readOnly": true, "type": "array" }, "jobStageDetails": { "description": "Job Stage Details", "readOnly": true, "type": "object" }, "stageName": { "description": "Name of the job stage.", "enum": [ "DeviceOrdered", "DevicePrepared", "Dispatched", "Delivered", "PickedUp", "AtAzureDC", "DataCopy", "Completed", "CompletedWithErrors", "Cancelled", "Failed_IssueReportedAtCustomer", "Failed_IssueDetectedAtAzureDC", "Aborted", "CompletedWithWarnings", "ReadyToDispatchFromAzureDC", "ReadyToReceiveAtAzureDC" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "StageName", "values": [ { "description": "An order has been created.", "value": "DeviceOrdered" }, { "description": "A device has been prepared for the order.", "value": "DevicePrepared" }, { "description": "Device has been dispatched to the user of the order.", "value": "Dispatched" }, { "description": "Device has been delivered to the user of the order.", "value": "Delivered" }, { "description": "Device has been picked up from user and in transit to azure datacenter.", "value": "PickedUp" }, { "description": "Device has been received at azure datacenter from the user.", "value": "AtAzureDC" }, { "description": "Data copy from the device at azure datacenter.", "value": "DataCopy" }, { "description": "Order has completed.", "value": "Completed" }, { "description": "Order has completed with errors.", "value": "CompletedWithErrors" }, { "description": "Order has been cancelled.", "value": "Cancelled" }, { "description": "Order has failed due to issue reported by user.", "value": "Failed_IssueReportedAtCustomer" }, { "description": "Order has failed due to issue detected at azure datacenter.", "value": "Failed_IssueDetectedAtAzureDC" }, { "description": "Order has been aborted.", "value": "Aborted" }, { "description": "Order has completed with warnings.", "value": "CompletedWithWarnings" }, { "description": "Device is ready to be handed to customer from Azure DC.", "value": "ReadyToDispatchFromAzureDC" }, { "description": "Device can be dropped off at Azure DC.", "value": "ReadyToReceiveAtAzureDC" } ] } }, "stageStatus": { "description": "Status of the job stage.", "enum": [ "None", "InProgress", "Succeeded", "Failed", "Cancelled", "Cancelling", "SucceededWithErrors" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "StageStatus", "values": [ { "description": "No status available yet.", "value": "None" }, { "description": "Stage is in progress.", "value": "InProgress" }, { "description": "Stage has succeeded.", "value": "Succeeded" }, { "description": "Stage has failed.", "value": "Failed" }, { "description": "Stage has been cancelled.", "value": "Cancelled" }, { "description": "Stage is cancelling.", "value": "Cancelling" }, { "description": "Stage has succeeded with errors.", "value": "SucceededWithErrors" } ] } }, "stageTime": { "description": "Time for the job stage in UTC ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object" }, "NotificationPreference": { "description": "Notification preference for a job stage.", "properties": { "sendNotification": { "description": "Notification is required or not.", "type": "boolean" }, "stageName": { "description": "Name of the stage.", "enum": [ "DevicePrepared", "Dispatched", "Delivered", "PickedUp", "AtAzureDC", "DataCopy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "NotificationStageName", "values": [ { "description": "Notification at device prepared stage.", "value": "DevicePrepared" }, { "description": "Notification at device dispatched stage.", "value": "Dispatched" }, { "description": "Notification at device delivered stage.", "value": "Delivered" }, { "description": "Notification at device picked up from user stage.", "value": "PickedUp" }, { "description": "Notification at device received at azure datacenter stage.", "value": "AtAzureDC" }, { "description": "Notification at data copy started stage.", "value": "DataCopy" } ] } } }, "required": [ "stageName", "sendNotification" ], "type": "object" }, "Operation": { "description": "Operation entity.", "properties": { "display": { "$ref": "#/definitions/OperationDisplay", "description": "Operation display values.", "readOnly": true }, "name": { "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}", "readOnly": true, "type": "string" }, "origin": { "description": "Origin of the operation. Can be : user|system|user,system", "readOnly": true, "type": "string" }, "properties": { "$ref": "#/definitions/OperationProperties", "description": "Operation properties.", "readOnly": true, "x-ms-client-flatten": true } }, "type": "object" }, "OperationDisplay": { "description": "Operation display", "properties": { "description": { "description": "Localized description of the operation for display purpose.", "type": "string" }, "operation": { "description": "Localized name of the operation for display purpose.", "type": "string" }, "provider": { "description": "Provider name.", "type": "string" }, "resource": { "description": "Resource name.", "type": "string" } }, "type": "object" }, "OperationList": { "description": "Operation Collection.", "properties": { "nextLink": { "description": "Link for the next set of operations.", "type": "string" }, "value": { "description": "List of operations.", "items": { "$ref": "#/definitions/Operation" }, "readOnly": true, "type": "array" } }, "type": "object" }, "OperationProperties": { "description": "Operation properties.", "properties": {}, "type": "object" }, "PackageShippingDetails": { "description": "Shipping details.", "properties": { "carrierName": { "description": "Name of the carrier.", "readOnly": true, "type": "string" }, "trackingId": { "description": "Tracking Id of shipment.", "readOnly": true, "type": "string" }, "trackingUrl": { "description": "Url where shipment can be tracked.", "readOnly": true, "type": "string" } }, "type": "object" }, "Preferences": { "description": "Preferences related to the order", "properties": { "preferredDataCenterRegion": { "description": "Preferred Data Center Region.", "items": { "type": "string" }, "type": "array" }, "transportPreferences": { "$ref": "#/definitions/TransportPreferences", "description": "Preferences related to the shipment logistics of the sku." } }, "type": "object" }, "PreferencesValidationRequest": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "Request to validate preference of transport and data center.", "properties": { "deviceType": { "description": "Device type to be used for the job.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Data Box.", "value": "DataBox" }, { "description": "Data Box Disk.", "value": "DataBoxDisk" }, { "description": "Data Box Heavy.", "value": "DataBoxHeavy" } ] } }, "preference": { "$ref": "#/definitions/Preferences", "description": "Preference requested with respect to transport type and data center" } }, "required": [ "deviceType", "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidatePreferences" }, "PreferencesValidationResponseProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "Properties of data center and transport preference validation response.", "properties": { "status": { "description": "Validation status of requested data center and transport.", "enum": [ "Valid", "Invalid", "Skipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationStatus", "values": [ { "description": "Validation is successful", "value": "Valid" }, { "description": "Validation is not successful", "value": "Invalid" }, { "description": "Validation is skipped", "value": "Skipped" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidatePreferences" }, "RegionConfigurationRequest": { "description": "Request body to get the configuration for the region.", "properties": { "scheduleAvailabilityRequest": { "$ref": "#/definitions/ScheduleAvailabilityRequest", "description": "Request body to get the availability for scheduling orders." }, "transportAvailabilityRequest": { "$ref": "#/definitions/TransportAvailabilityRequest", "description": "Request body to get the transport availability for given sku." } }, "type": "object" }, "RegionConfigurationResponse": { "description": "Configuration response specific to a region.", "properties": { "scheduleAvailabilityResponse": { "$ref": "#/definitions/ScheduleAvailabilityResponse", "description": "Schedule availability for given sku in a region.", "readOnly": true }, "transportAvailabilityResponse": { "$ref": "#/definitions/TransportAvailabilityResponse", "description": "Transport options available for given sku in a region.", "readOnly": true } }, "type": "object" }, "Resource": { "description": "Model of the Resource.", "properties": { "location": { "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.", "type": "string", "x-ms-mutability": [ "read", "create" ] }, "sku": { "$ref": "#/definitions/Sku", "description": "The sku type." }, "tags": { "additionalProperties": { "type": "string" }, "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", "type": "object" } }, "required": [ "location", "sku" ], "type": "object", "x-ms-azure-resource": true }, "ScheduleAvailabilityRequest": { "description": "Request body to get the availability for scheduling orders.", "discriminator": "skuName", "properties": { "skuName": { "description": "Sku Name for which the order is to be scheduled.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Data Box.", "value": "DataBox" }, { "description": "Data Box Disk.", "value": "DataBoxDisk" }, { "description": "Data Box Heavy.", "value": "DataBoxHeavy" } ] } }, "storageLocation": { "description": "Location for data transfer. \r\nFor locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", "type": "string" } }, "required": [ "storageLocation", "skuName" ], "type": "object" }, "ScheduleAvailabilityResponse": { "description": "Schedule availability response for given sku in a region.", "properties": { "availableDates": { "description": "List of dates available to schedule", "items": { "format": "date-time", "type": "string" }, "readOnly": true, "type": "array" } }, "type": "object" }, "ShareCredentialDetails": { "description": "Credential details of the shares in account.", "properties": { "password": { "description": "Password for the share.", "readOnly": true, "type": "string" }, "shareName": { "description": "Name of the share.", "readOnly": true, "type": "string" }, "shareType": { "description": "Type of the share.", "enum": [ "UnknownType", "HCS", "BlockBlob", "PageBlob", "AzureFile", "ManagedDisk" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ShareDestinationFormatType", "values": [ { "description": "Unknown format.", "value": "UnknownType" }, { "description": "Storsimple data format.", "value": "HCS" }, { "description": "Azure storage block blob format.", "value": "BlockBlob" }, { "description": "Azure storage page blob format.", "value": "PageBlob" }, { "description": "Azure storage file format.", "value": "AzureFile" }, { "description": "Azure Compute Disk.", "value": "ManagedDisk" } ] } }, "supportedAccessProtocols": { "description": "Access protocols supported on the device.", "items": { "enum": [ "SMB", "NFS" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "AccessProtocol", "values": [ { "description": "Server Message Block protocol(SMB).", "value": "SMB" }, { "description": "Network File System protocol(NFS).", "value": "NFS" } ] } }, "readOnly": true, "type": "array" }, "userName": { "description": "User name for the share.", "readOnly": true, "type": "string" } }, "type": "object" }, "ShipmentPickUpRequest": { "description": "Shipment pick up request details.", "properties": { "endTime": { "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.", "format": "date-time", "type": "string" }, "shipmentLocation": { "description": "Shipment Location in the pickup place. Eg.front desk", "type": "string" }, "startTime": { "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.", "format": "date-time", "type": "string" } }, "required": [ "startTime", "endTime", "shipmentLocation" ], "type": "object" }, "ShipmentPickUpResponse": { "description": "Shipment pick up response.", "properties": { "confirmationNumber": { "description": "Confirmation number for the pick up request.", "readOnly": true, "type": "string" }, "readyByTime": { "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object" }, "ShippingAddress": { "description": "Shipping address where customer wishes to receive the device.", "properties": { "addressType": { "description": "Type of address.", "enum": [ "None", "Residential", "Commercial" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "AddressType", "values": [ { "description": "Address type not known.", "value": "None" }, { "description": "Residential Address.", "value": "Residential" }, { "description": "Commercial Address.", "value": "Commercial" } ] } }, "city": { "description": "Name of the City.", "type": "string" }, "companyName": { "description": "Name of the company.", "type": "string" }, "country": { "description": "Name of the Country.", "type": "string" }, "postalCode": { "description": "Postal code.", "type": "string" }, "stateOrProvince": { "description": "Name of the State or Province.", "type": "string" }, "streetAddress1": { "description": "Street Address line 1.", "type": "string" }, "streetAddress2": { "description": "Street Address line 2.", "type": "string" }, "streetAddress3": { "description": "Street Address line 3.", "type": "string" }, "zipExtendedCode": { "description": "Extended Zip Code.", "type": "string" } }, "required": [ "streetAddress1", "country", "postalCode" ], "type": "object" }, "Sku": { "description": "The Sku.", "properties": { "displayName": { "description": "The display name of the sku.", "type": "string" }, "family": { "description": "The sku family.", "type": "string" }, "name": { "description": "The sku name.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Databox.", "value": "DataBox" }, { "description": "DataboxDisk.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy.", "value": "DataBoxHeavy" } ] } } }, "required": [ "name" ], "type": "object" }, "SkuAvailabilityValidationRequest": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "Request to validate sku availability.", "properties": { "country": { "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", "type": "string" }, "deviceType": { "description": "Device type to be used for the job.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Data Box.", "value": "DataBox" }, { "description": "Data Box Disk.", "value": "DataBoxDisk" }, { "description": "Data Box Heavy.", "value": "DataBoxHeavy" } ] } }, "location": { "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", "type": "string" }, "transferType": { "description": "Type of the transfer.", "enum": [ "ImportToAzure" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "TransferType", "values": [ { "description": "Import data to azure.", "value": "ImportToAzure" } ] } } }, "required": [ "deviceType", "transferType", "country", "location", "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateSkuAvailability" }, "SkuAvailabilityValidationResponseProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "Properties of sku availability validation response.", "properties": { "status": { "description": "Sku availability validation status.", "enum": [ "Valid", "Invalid", "Skipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationStatus", "values": [ { "description": "Validation is successful", "value": "Valid" }, { "description": "Validation is not successful", "value": "Invalid" }, { "description": "Validation is skipped", "value": "Skipped" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateSkuAvailability" }, "SkuCapacity": { "description": "Capacity of the sku.", "properties": { "maximum": { "description": "Maximum capacity in TB.", "readOnly": true, "type": "string" }, "usable": { "description": "Usable capacity in TB.", "readOnly": true, "type": "string" } }, "type": "object" }, "SkuCost": { "description": "Describes metadata for retrieving price info.", "properties": { "meterId": { "description": "Meter id of the Sku.", "readOnly": true, "type": "string" }, "meterType": { "description": "The type of the meter.", "readOnly": true, "type": "string" } }, "type": "object" }, "SkuInformation": { "description": "Information of the sku.", "properties": { "enabled": { "description": "The sku is enabled or not.", "readOnly": true, "type": "boolean" }, "properties": { "$ref": "#/definitions/SkuProperties", "description": "Properties of the sku.", "readOnly": true, "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/Sku", "description": "The Sku.", "readOnly": true } }, "type": "object" }, "SkuProperties": { "description": "Properties of the sku.", "properties": { "apiVersions": { "description": "Api versions that support this Sku.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "capacity": { "$ref": "#/definitions/SkuCapacity", "description": "Capacity of the Sku.", "readOnly": true }, "costs": { "description": "Cost of the Sku.", "items": { "$ref": "#/definitions/SkuCost" }, "readOnly": true, "type": "array" }, "destinationToServiceLocationMap": { "description": "The map of destination location to service location.", "items": { "$ref": "#/definitions/DestinationToServiceLocationMap" }, "readOnly": true, "type": "array" }, "disabledReason": { "description": "Reason why the Sku is disabled.", "enum": [ "None", "Country", "Region", "Feature", "OfferType", "NoSubscriptionInfo" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuDisabledReason", "values": [ { "description": "SKU is not disabled.", "value": "None" }, { "description": "SKU is not available in the requested country.", "value": "Country" }, { "description": "SKU is not available to push data to the requested Azure region.", "value": "Region" }, { "description": "Required features are not enabled for the SKU.", "value": "Feature" }, { "description": "Subscription does not have required offer types for the SKU.", "value": "OfferType" }, { "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification.", "value": "NoSubscriptionInfo" } ] } }, "disabledReasonMessage": { "description": "Message for why the Sku is disabled.", "readOnly": true, "type": "string" }, "requiredFeature": { "description": "Required feature to access the sku.", "readOnly": true, "type": "string" } }, "type": "object" }, "SubscriptionIsAllowedToCreateJobValidationRequest": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "Request to validate subscription permission to create jobs.", "properties": {}, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" }, "SubscriptionIsAllowedToCreateJobValidationResponseProperties": { "allOf": [ { "$ref": "#/definitions/ValidationInputResponse" } ], "description": "Properties of subscription permission to create job validation response.", "properties": { "status": { "description": "Validation status of subscription permission to create job.", "enum": [ "Valid", "Invalid", "Skipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationStatus", "values": [ { "description": "Validation is successful", "value": "Valid" }, { "description": "Validation is not successful", "value": "Invalid" }, { "description": "Validation is skipped", "value": "Skipped" } ] } } }, "required": [ "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" }, "TransportAvailabilityDetails": { "description": "Transport options availability details for given region.", "properties": { "shipmentType": { "description": "Transport Shipment Type supported for given region.", "enum": [ "CustomerManaged", "MicrosoftManaged" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "TransportShipmentTypes", "values": [ { "description": "Shipment Logistics is handled by the customer.", "value": "CustomerManaged" }, { "description": "Shipment Logistics is handled by Microsoft.", "value": "MicrosoftManaged" } ] } } }, "type": "object" }, "TransportAvailabilityRequest": { "description": "Request body to get the transport availability for given sku.", "properties": { "skuName": { "description": "Type of the device.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Data Box.", "value": "DataBox" }, { "description": "Data Box Disk.", "value": "DataBoxDisk" }, { "description": "Data Box Heavy.", "value": "DataBoxHeavy" } ] } } }, "type": "object" }, "TransportAvailabilityResponse": { "description": "Transport options available for given sku in a region.", "properties": { "transportAvailabilityDetails": { "description": "List of transport availability details for given region", "items": { "$ref": "#/definitions/TransportAvailabilityDetails" }, "readOnly": true, "type": "array" } }, "type": "object" }, "TransportPreferences": { "description": "Preferences related to the shipment logistics of the sku", "properties": { "preferredShipmentType": { "description": "Indicates Shipment Logistics type that the customer preferred.", "enum": [ "CustomerManaged", "MicrosoftManaged" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "TransportShipmentTypes", "values": [ { "description": "Shipment Logistics is handled by the customer.", "value": "CustomerManaged" }, { "description": "Shipment Logistics is handled by Microsoft.", "value": "MicrosoftManaged" } ] } } }, "required": [ "preferredShipmentType" ], "type": "object" }, "UnencryptedCredentials": { "description": "Unencrypted credentials for accessing device.", "properties": { "jobName": { "description": "Name of the job.", "readOnly": true, "type": "string" }, "jobSecrets": { "$ref": "#/definitions/JobSecrets", "description": "Secrets related to this job.", "readOnly": true } }, "type": "object" }, "UnencryptedCredentialsList": { "description": "List of unencrypted credentials for accessing device.", "properties": { "nextLink": { "description": "Link for the next set of unencrypted credentials.", "type": "string" }, "value": { "description": "List of unencrypted credentials.", "items": { "$ref": "#/definitions/UnencryptedCredentials" }, "type": "array" } }, "type": "object" }, "UpdateJobDetails": { "description": "Job details for update.", "properties": { "contactDetails": { "$ref": "#/definitions/ContactDetails", "description": "Contact details for notification and shipping." }, "shippingAddress": { "$ref": "#/definitions/ShippingAddress", "description": "Shipping address of the customer." } }, "type": "object" }, "UpdateJobProperties": { "description": "Job Properties for update", "properties": { "destinationAccountDetails": { "description": "Destination account details.", "items": { "$ref": "#/definitions/DestinationAccountDetails" }, "type": "array" }, "details": { "$ref": "#/definitions/UpdateJobDetails", "description": "Details of a job to be updated." } }, "type": "object" }, "ValidateAddress": { "allOf": [ { "$ref": "#/definitions/ValidationInputRequest" } ], "description": "The requirements to validate customer address where the device needs to be shipped.", "properties": { "deviceType": { "description": "Device type to be used for the job.", "enum": [ "DataBox", "DataBoxDisk", "DataBoxHeavy" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "SkuName", "values": [ { "description": "Databox.", "value": "DataBox" }, { "description": "DataboxDisk.", "value": "DataBoxDisk" }, { "description": "DataboxHeavy.", "value": "DataBoxHeavy" } ] } }, "shippingAddress": { "$ref": "#/definitions/ShippingAddress", "description": "Shipping address of the customer." }, "transportPreferences": { "$ref": "#/definitions/TransportPreferences", "description": "Preferences related to the shipment logistics of the sku." } }, "required": [ "shippingAddress", "deviceType", "validationType" ], "type": "object", "x-ms-discriminator-value": "ValidateAddress" }, "ValidationInputRequest": { "description": "Minimum fields that must be present in any type of validation request.", "discriminator": "validationType", "properties": { "validationType": { "description": "Identifies the type of validation request.", "enum": [ "ValidateAddress", "ValidateDataDestinationDetails", "ValidateSubscriptionIsAllowedToCreateJob", "ValidatePreferences", "ValidateCreateOrderLimit", "ValidateSkuAvailability" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationInputDiscriminator", "values": [ { "description": "Identify request and response of address validation.", "value": "ValidateAddress" }, { "description": "Identify request and response of data destination details validation.", "value": "ValidateDataDestinationDetails" }, { "description": "Identify request and response for validation of subscription permission to create job.", "value": "ValidateSubscriptionIsAllowedToCreateJob" }, { "description": "Identify request and response of preference validation.", "value": "ValidatePreferences" }, { "description": "Identify request and response of create order limit for subscription validation.", "value": "ValidateCreateOrderLimit" }, { "description": "Identify request and response of active job limit for sku availability.", "value": "ValidateSkuAvailability" } ] } } }, "required": [ "validationType" ], "type": "object" }, "ValidationInputResponse": { "description": "Minimum properties that should be present in each individual validation response.", "discriminator": "validationType", "properties": { "error": { "$ref": "#/definitions/Error", "description": "Error code and message of validation response.", "readOnly": true }, "validationType": { "description": "Identifies the type of validation response.", "enum": [ "ValidateAddress", "ValidateDataDestinationDetails", "ValidateSubscriptionIsAllowedToCreateJob", "ValidatePreferences", "ValidateCreateOrderLimit", "ValidateSkuAvailability" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationInputDiscriminator", "values": [ { "description": "Identify request and response of address validation.", "value": "ValidateAddress" }, { "description": "Identify request and response of data destination details validation.", "value": "ValidateDataDestinationDetails" }, { "description": "Identify request and response for validation of subscription permission to create job.", "value": "ValidateSubscriptionIsAllowedToCreateJob" }, { "description": "Identify request and response of preference validation.", "value": "ValidatePreferences" }, { "description": "Identify request and response of create order limit for subscription validation.", "value": "ValidateCreateOrderLimit" }, { "description": "Identify request and response of active job limit for sku availability.", "value": "ValidateSkuAvailability" } ] } } }, "required": [ "validationType" ], "type": "object" }, "ValidationRequest": { "description": "Input request for all pre job creation validation.", "discriminator": "validationCategory", "properties": { "individualRequestDetails": { "description": "List of request details contain validationType and its request as key and value respectively.", "items": { "$ref": "#/definitions/ValidationInputRequest" }, "type": "array" }, "validationCategory": { "description": "Identify the nature of validation.", "enum": [ "JobCreationValidation" ], "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "ValidationCategory", "values": [ { "description": "Identify request of pre-job creation validations.", "value": "JobCreationValidation" } ] } } }, "required": [ "validationCategory", "individualRequestDetails" ], "type": "object" }, "ValidationResponse": { "description": "Response of pre job creation validations.", "properties": { "properties": { "$ref": "#/definitions/ValidationResponseProperties", "description": "Properties of pre job creation validation response.", "readOnly": true, "x-ms-client-flatten": true } }, "type": "object" }, "ValidationResponseProperties": { "description": "Properties of pre job creation validation response.", "properties": { "individualResponseDetails": { "description": "List of response details contain validationType and its response as key and value respectively.", "items": { "$ref": "#/definitions/ValidationInputResponse" }, "readOnly": true, "type": "array" }, "status": { "description": "Overall validation status.", "enum": [ "AllValidToProceed", "InputsRevisitRequired", "CertainInputValidationsSkipped" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsExtensible": true, "name": "OverallValidationStatus", "values": [ { "description": "Every input request is valid.", "value": "AllValidToProceed" }, { "description": "Some input requests are not valid.", "value": "InputsRevisitRequired" }, { "description": "Certain input validations skipped.", "value": "CertainInputValidationsSkipped" } ] } } }, "type": "object" } } }