Microsoft.DataBox (stable:2018-01-01)

2025/09/12 • 12 new, 12 deleted methods

Operations_List (new)
Description :  This method gets all the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataBox/operations
{
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action} ,
Required: False ,
}
string ,
display:
{
Description: Operation display values. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource name. ,
Required: False ,
}
string ,
operation:
{
Description: Localized name of the operation for display purpose. ,
Required: False ,
}
string ,
description:
{
Description: Localized description of the operation for display purpose. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation properties. ,
Required: False ,
}
object ,
origin:
{
Description: Origin of the operation. Can be : user|system|user,system ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of operations. ,
Required: False ,
}
string ,
}
Jobs_List (new)
Description :  Lists all the jobs available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}
Service_ListAvailableSkus (new)
Description :  This method provides the list of available skus for the given subscription and location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
availableSkuRequest:
{
Description: Filters for showing the available skus. ,
Required: True ,
}
{
transferType:
{
Description: Type of the transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
}
,
Required: True ,
}
enum ,
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 ,
Required: True ,
}
string ,
location:
{
Description: Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuNames:
{
Description: Sku Names to filter for available skus ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of available skus. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
DataBox: DataBox. ,
DataBoxDisk: DataBoxDisk. ,
DataBoxHeavy: DataBoxHeavy. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The display name of the sku. ,
Required: False ,
}
string ,
family:
{
Description: The sku family. ,
Required: False ,
}
string ,
}
,
enabled:
{
Description: The sku is enabled or not. ,
Required: False ,
}
boolean ,
properties:
{
Description: Properties of the sku. ,
Required: False ,
}
{
destinationToServiceLocationMap:
{
Description: The map of destination location to service location. ,
Required: False ,
}
[
{
destinationLocation:
{
Description: Location of the destination. ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Location of the service. ,
Required: False ,
}
string ,
}
,
]
,
capacity:
{
Description: Capacity of the Sku. ,
Required: False ,
}
{
usable:
{
Description: Usable capacity in TB. ,
Required: False ,
}
string ,
maximum:
{
Description: Maximum capacity in TB. ,
Required: False ,
}
string ,
}
,
costs:
{
Description: Cost of the Sku. ,
Required: False ,
}
[
{
meterId:
{
Description: Meter id of the Sku. ,
Required: False ,
}
string ,
meterType:
{
Description: The type of the meter. ,
Required: False ,
}
string ,
}
,
]
,
apiVersions:
{
Description: Api versions that support this Sku. ,
Required: False ,
}
[
string ,
]
,
disabledReason:
{
Description: Reason why the Sku is disabled. ,
Enum:
{
None: SKU is not disabled. ,
Country: SKU is not available in the requested country. ,
Region: SKU is not available to push data to the requested Azure region. ,
Feature: Required features are not enabled for the SKU. ,
OfferType: Subscription does not have required offer types for the SKU. ,
NoSubscriptionInfo: Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the Sku is disabled. ,
Required: False ,
}
string ,
requiredFeature:
{
Description: Required feature to access the sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of skus. ,
Required: False ,
}
string ,
}
Service_ValidateAddress (new)
Description :  This method validates the customer shipping address and provide alternate addresses if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
validateAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deviceType:
{
Description: Device type to be used for the job. ,
Enum:
{
DataBox: DataBox. ,
DataBoxDisk: DataBoxDisk. ,
DataBoxHeavy: DataBoxHeavy. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The address validation properties. ,
Required: False ,
}
{
validationStatus:
{
Description: The address validation status. ,
Enum:
{
Valid: Address provided is valid. ,
Invalid: Address provided is invalid or not supported. ,
Ambiguous: Address provided is ambiguous, please choose one of the alternate addresses returned. ,
}
,
Required: False ,
}
enum ,
alternateAddresses:
{
Description: List of alternate addresses. ,
Required: False ,
}
[
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
Jobs_ListByResourceGroup (new)
Description :  Lists all the jobs available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}
Jobs_Get (new)
Description :  Gets information about the specified job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on details parameter for job, which provides details on the job stages. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
Jobs_Create (new)
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
jobResource:
{
Description: Job details from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Jobs_Delete (new)
Description :  Deletes a job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_Update (new)
Description :  Updates the properties of an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. ,
Required: False ,
}
string ,
jobResourceUpdateParameter:
{
Description: Job update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of a job to be updated. ,
Required: False ,
}
{
details:
{
Description: Details of a job to be updated. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: False ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: False ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
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). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Jobs_BookShipmentPickUp (new)
Description :  Book shipment pick up.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
shipmentPickUpRequest:
{
Description: Details of shipment pick up request. ,
Required: True ,
}
{
startTime:
{
Description: Minimum date after which the pick up should commence, this must be in local time of pick up area. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Maximum date before which the pick up should commence, this must be in local time of pick up area. ,
Format: date-time ,
Required: True ,
}
string ,
shipmentLocation:
{
Description: Shipment Location in the pickup place. Eg.front desk ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
confirmationNumber:
{
Description: Confirmation number for the pick up request. ,
Required: False ,
}
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 ,
Required: False ,
}
string ,
}
Jobs_Cancel (new)
Description :  CancelJob.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: True ,
}
{
reason:
{
Description: Reason for cancellation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (204)

{}
Jobs_ListCredentials (new)
Description :  This method gets the unencrypted secrets related to the job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of unencrypted credentials. ,
Required: False ,
}
[
{
jobName:
{
Description: Name of the job. ,
Required: False ,
}
string ,
jobSecrets:
{
Description: Secrets related to this job. ,
Required: False ,
}
{
jobSecretsType:
{
Description: Used to indicate what type of job secrets object. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of unencrypted credentials. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  This method gets all the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataBox/operations
{
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action} ,
Required: False ,
}
string ,
display:
{
Description: Operation display values. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource name. ,
Required: False ,
}
string ,
operation:
{
Description: Localized name of the operation for display purpose. ,
Required: False ,
}
string ,
description:
{
Description: Localized description of the operation for display purpose. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation properties. ,
Required: False ,
}
object ,
origin:
{
Description: Origin of the operation. Can be : user|system|user,system ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of operations. ,
Required: False ,
}
string ,
}
Jobs_List (removed)
Description :  Lists all the jobs available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}
Service_ListAvailableSkus (removed)
Description :  This method provides the list of available skus for the given subscription and location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
availableSkuRequest:
{
Description: Filters for showing the available skus. ,
Required: True ,
}
{
transferType:
{
Description: Type of the transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
}
,
Required: True ,
}
enum ,
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 ,
Required: True ,
}
string ,
location:
{
Description: Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuNames:
{
Description: Sku Names to filter for available skus ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of available skus. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
DataBox: DataBox. ,
DataBoxDisk: DataBoxDisk. ,
DataBoxHeavy: DataBoxHeavy. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The display name of the sku. ,
Required: False ,
}
string ,
family:
{
Description: The sku family. ,
Required: False ,
}
string ,
}
,
enabled:
{
Description: The sku is enabled or not. ,
Required: False ,
}
boolean ,
properties:
{
Description: Properties of the sku. ,
Required: False ,
}
{
destinationToServiceLocationMap:
{
Description: The map of destination location to service location. ,
Required: False ,
}
[
{
destinationLocation:
{
Description: Location of the destination. ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Location of the service. ,
Required: False ,
}
string ,
}
,
]
,
capacity:
{
Description: Capacity of the Sku. ,
Required: False ,
}
{
usable:
{
Description: Usable capacity in TB. ,
Required: False ,
}
string ,
maximum:
{
Description: Maximum capacity in TB. ,
Required: False ,
}
string ,
}
,
costs:
{
Description: Cost of the Sku. ,
Required: False ,
}
[
{
meterId:
{
Description: Meter id of the Sku. ,
Required: False ,
}
string ,
meterType:
{
Description: The type of the meter. ,
Required: False ,
}
string ,
}
,
]
,
apiVersions:
{
Description: Api versions that support this Sku. ,
Required: False ,
}
[
string ,
]
,
disabledReason:
{
Description: Reason why the Sku is disabled. ,
Enum:
{
None: SKU is not disabled. ,
Country: SKU is not available in the requested country. ,
Region: SKU is not available to push data to the requested Azure region. ,
Feature: Required features are not enabled for the SKU. ,
OfferType: Subscription does not have required offer types for the SKU. ,
NoSubscriptionInfo: Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the Sku is disabled. ,
Required: False ,
}
string ,
requiredFeature:
{
Description: Required feature to access the sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of skus. ,
Required: False ,
}
string ,
}
Service_ValidateAddress (removed)
Description :  This method validates the customer shipping address and provide alternate addresses if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
validateAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deviceType:
{
Description: Device type to be used for the job. ,
Enum:
{
DataBox: DataBox. ,
DataBoxDisk: DataBoxDisk. ,
DataBoxHeavy: DataBoxHeavy. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The address validation properties. ,
Required: False ,
}
{
validationStatus:
{
Description: The address validation status. ,
Enum:
{
Valid: Address provided is valid. ,
Invalid: Address provided is invalid or not supported. ,
Ambiguous: Address provided is ambiguous, please choose one of the alternate addresses returned. ,
}
,
Required: False ,
}
enum ,
alternateAddresses:
{
Description: List of alternate addresses. ,
Required: False ,
}
[
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
Jobs_ListByResourceGroup (removed)
Description :  Lists all the jobs available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}
Jobs_Get (removed)
Description :  Gets information about the specified job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on details parameter for job, which provides details on the job stages. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
Jobs_Create (removed)
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
jobResource:
{
Description: Job details from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Jobs_Delete (removed)
Description :  Deletes a job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_Update (removed)
Description :  Updates the properties of an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. ,
Required: False ,
}
string ,
jobResourceUpdateParameter:
{
Description: Job update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of a job to be updated. ,
Required: False ,
}
{
details:
{
Description: Details of a job to be updated. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: False ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: False ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
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). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
isDeletable:
{
Description: Describes whether the job is deletable or not. ,
Required: False ,
}
boolean ,
isShippingAddressEditable:
{
Description: Describes whether the shipping address is editable or not. ,
Required: False ,
}
boolean ,
status:
{
Description: Name of the stage which is in progress. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
jobStages:
{
Description: List of stages that run in the job. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
Dispatched: Device has been dispatched to the user of the order. ,
Delivered: Device has been delivered to the user of the order. ,
PickedUp: Device has been picked up from user and in transit to azure datacenter. ,
AtAzureDC: Device has been received at azure datacenter from the user. ,
DataCopy: Data copy from the device at azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user. ,
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at azure datacenter. ,
Aborted: Order has been aborted. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
SucceededWithErrors: Stage has succeeded with errors. ,
}
,
Required: False ,
}
enum ,
stageTime:
{
Description: Time for the job stage in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contactDetails:
{
Description: Contact details for notification and shipping. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
notificationPreference:
{
Description: Notification preference for a job stage. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
DevicePrepared: Notification at device prepared stage. ,
Dispatched: Notification at device dispatched stage. ,
Delivered: Notification at device delivered stage. ,
PickedUp: Notification at device picked up from user stage. ,
AtAzureDC: Notification at device received at azure datacenter stage. ,
DataCopy: Notification at data copy started stage. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
shippingAddress:
{
Description: Shipping address of the customer. ,
Required: True ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: True ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
}
,
destinationAccountDetails:
{
Description: Destination account details. ,
Required: True ,
}
[
{
dataDestinationType:
{
Description: Data Destination Type. ,
Enum:
{
UnknownType: Unknown type. ,
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
accountId:
{
Description: Arm Id of the destination where the data has to be moved. ,
Required: False ,
}
string ,
}
,
]
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Message for the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Code for the error. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Required: False ,
}
[
string ,
]
,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
reverseShipmentLabelSasKey:
{
Description: Shared access key to download the return shipment label ,
Required: False ,
}
string ,
chainOfCustodySasKey:
{
Description: Shared access key to download the chain of custody logs ,
Required: False ,
}
string ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
id:
{
Description: Id of the object. ,
Required: False ,
}
string ,
type:
{
Description: Type of the object. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Jobs_BookShipmentPickUp (removed)
Description :  Book shipment pick up.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
shipmentPickUpRequest:
{
Description: Details of shipment pick up request. ,
Required: True ,
}
{
startTime:
{
Description: Minimum date after which the pick up should commence, this must be in local time of pick up area. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Maximum date before which the pick up should commence, this must be in local time of pick up area. ,
Format: date-time ,
Required: True ,
}
string ,
shipmentLocation:
{
Description: Shipment Location in the pickup place. Eg.front desk ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
confirmationNumber:
{
Description: Confirmation number for the pick up request. ,
Required: False ,
}
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 ,
Required: False ,
}
string ,
}
Jobs_Cancel (removed)
Description :  CancelJob.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: True ,
}
{
reason:
{
Description: Reason for cancellation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (204)

{}
Jobs_ListCredentials (removed)
Description :  This method gets the unencrypted secrets related to the job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
jobName:
{
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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of unencrypted credentials. ,
Required: False ,
}
[
{
jobName:
{
Description: Name of the job. ,
Required: False ,
}
string ,
jobSecrets:
{
Description: Secrets related to this job. ,
Required: False ,
}
{
jobSecretsType:
{
Description: Used to indicate what type of job secrets object. ,
Enum:
{
DataBox: DataBox orders. ,
DataBoxDisk: DataBoxDisk orders. ,
DataBoxHeavy: DataBoxHeavy orders. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of unencrypted credentials. ,
Required: False ,
}
string ,
}