Microsoft.DataBox (stable:2025-02-01)

2025/02/21 • 18 new 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 ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Link for the next set of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
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 ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Mitigate (new)
Description :  Request to mitigate for a given job
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate
{
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 ,
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 ,
mitigateJobRequest:
{
Description: Mitigation Request ,
Required: True ,
}
{
customerResolutionCode:
{
Description: Resolution code for the job ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
serialNumberCustomerResolutionMap:
{
Description: Serial number and the customer resolution code corresponding to each serial number ,
Required: False ,
}
object ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Jobs_MarkDevicesShipped (new)
Description :  Request to mark devices for a given job as shipped
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped
{
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 ,
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 ,
markDevicesShippedRequest:
{
Description: Mark Devices Shipped Request ,
Required: True ,
}
{
deliverToDcPackageDetails:
{
Description: Delivery package details ,
Required: True ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_ListAvailableSkusByResourceGroup (new)
Description :  This method provides the list of available skus for the given subscription, resource group and location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
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. ,
ExportFromAzure: Export data from 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: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The display name of the sku. ,
Required: False ,
}
string ,
family:
{
Description: The sku family. ,
Required: False ,
}
string ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
enabled:
{
Description: The sku is enabled or not. ,
Required: False ,
}
boolean ,
properties:
{
Description: Properties of the sku. ,
Required: False ,
}
{
dataLocationToServiceLocationMap:
{
Description: The map of data location to service location. ,
Required: False ,
}
[
{
dataLocation:
{
Description: Location of the data. ,
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 ,
individualSkuUsable:
{
Description: Maximum capacity per device 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 ,
multiplier:
{
Description: Multiplier specifies the region specific value to be multiplied with 1$ guid. Eg: Our new regions will be using 1$ shipping guid with appropriate multiplier specific to region. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
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 ,
countriesWithinCommerceBoundary:
{
Description: List of all the Countries in the SKU specific commerce boundary ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of skus. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_ValidateAddress (new)
Description :  [DEPRECATED NOTICE: This operation will soon be removed]. 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deviceType:
{
Description: Device type to be used for the job. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_ValidateInputsByResourceGroup (new)
Description :  This method does all necessary pre-job creation validation under resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
validationRequest:
{
Description: Inputs of the customer. ,
Required: True ,
}
{
validationCategory:
{
Description: Identify the nature of validation. ,
Enum:
{
JobCreationValidation: Identify request of pre-job creation validations. ,
}
,
Required: True ,
}
enum ,
individualRequestDetails:
{
Description: List of request details contain validationType and its request as key and value respectively. ,
Required: True ,
}
[
{
validationType:
{
Description: Identifies the type of validation request. ,
Enum:
{
ValidateAddress: Identify request and response of address validation. ,
ValidateSubscriptionIsAllowedToCreateJob: Identify request and response for validation of subscription permission to create job. ,
ValidatePreferences: Identify request and response of preference validation. ,
ValidateCreateOrderLimit: Identify request and response of create order limit for subscription validation. ,
ValidateSkuAvailability: Identify request and response of active job limit for sku availability. ,
ValidateDataTransferDetails: Identify request and response of data transfer details validation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of pre job creation validation response. ,
Required: False ,
}
{
status:
{
Description: Overall validation status. ,
Enum:
{
AllValidToProceed: Every input request is valid. ,
InputsRevisitRequired: Some input requests are not valid. ,
CertainInputValidationsSkipped: Certain input validations skipped. ,
}
,
Required: False ,
}
enum ,
individualResponseDetails:
{
Description: List of response details contain validationType and its response as key and value respectively. ,
Required: False ,
}
[
{
validationType:
{
Description: Identifies the type of validation response. ,
Enum:
{
ValidateAddress: Identify request and response of address validation. ,
ValidateSubscriptionIsAllowedToCreateJob: Identify request and response for validation of subscription permission to create job. ,
ValidatePreferences: Identify request and response of preference validation. ,
ValidateCreateOrderLimit: Identify request and response of create order limit for subscription validation. ,
ValidateSkuAvailability: Identify request and response of active job limit for sku availability. ,
ValidateDataTransferDetails: Identify request and response of data transfer details validation. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error code and message of validation response. ,
Required: False ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_ValidateInputs (new)
Description :  This method does all necessary pre-job creation validation under subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs
{
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 ,
validationRequest:
{
Description: Inputs of the customer. ,
Required: True ,
}
{
validationCategory:
{
Description: Identify the nature of validation. ,
Enum:
{
JobCreationValidation: Identify request of pre-job creation validations. ,
}
,
Required: True ,
}
enum ,
individualRequestDetails:
{
Description: List of request details contain validationType and its request as key and value respectively. ,
Required: True ,
}
[
{
validationType:
{
Description: Identifies the type of validation request. ,
Enum:
{
ValidateAddress: Identify request and response of address validation. ,
ValidateSubscriptionIsAllowedToCreateJob: Identify request and response for validation of subscription permission to create job. ,
ValidatePreferences: Identify request and response of preference validation. ,
ValidateCreateOrderLimit: Identify request and response of create order limit for subscription validation. ,
ValidateSkuAvailability: Identify request and response of active job limit for sku availability. ,
ValidateDataTransferDetails: Identify request and response of data transfer details validation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of pre job creation validation response. ,
Required: False ,
}
{
status:
{
Description: Overall validation status. ,
Enum:
{
AllValidToProceed: Every input request is valid. ,
InputsRevisitRequired: Some input requests are not valid. ,
CertainInputValidationsSkipped: Certain input validations skipped. ,
}
,
Required: False ,
}
enum ,
individualResponseDetails:
{
Description: List of response details contain validationType and its response as key and value respectively. ,
Required: False ,
}
[
{
validationType:
{
Description: Identifies the type of validation response. ,
Enum:
{
ValidateAddress: Identify request and response of address validation. ,
ValidateSubscriptionIsAllowedToCreateJob: Identify request and response for validation of subscription permission to create job. ,
ValidatePreferences: Identify request and response of preference validation. ,
ValidateCreateOrderLimit: Identify request and response of create order limit for subscription validation. ,
ValidateSkuAvailability: Identify request and response of active job limit for sku availability. ,
ValidateDataTransferDetails: Identify request and response of data transfer details validation. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error code and message of validation response. ,
Required: False ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
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 ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
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 ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
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 ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
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 (200)

{}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Shipping Address and contact details for a job. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
preferences:
{
Description: Preferences related to the order ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
keyEncryptionKey:
{
Description: Key encryption key for the job. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
returnToCustomerPackageDetails:
{
Description: Return package details of job. ,
Required: False ,
}
{
carrierAccountNumber:
{
Description: Carrier Account Number of customer for customer disk. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
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 ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a job. ,
Required: True ,
}
{
transferType:
{
Description: Type of the data transfer. ,
Enum:
{
ImportToAzure: Import data to azure. ,
ExportFromAzure: Export data from azure. ,
}
,
Required: True ,
}
enum ,
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 ,
reverseShippingDetailsUpdate:
{
Description: The Editable status for Reverse Shipping Address and Contact Info ,
Enum:
{
Enabled: Reverse shipping details can be edited. ,
Disabled: Edit is disabled for Reverse shipping details. ,
NotSupported: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
reverseTransportPreferenceUpdate:
{
Description: The Editable status for Reverse Transport preferences ,
Enum:
{
Enabled: Reverse Transport Preferences can be edited. ,
Disabled: Edit is disabled for Reverse Transport Preferences. ,
NotSupported: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. ,
}
,
Required: False ,
}
enum ,
isPrepareToShipEnabled:
{
Description: Is Prepare To Ship Enabled on this job ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
Required: False ,
}
enum ,
delayedStage:
{
Description: Name of the stage where delay might be present. ,
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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 ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
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. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Created: Job created by the customer. ,
ShippedToAzureDC: User shipped the device to AzureDC. ,
AwaitingShipmentDetails: Awaiting shipment details of device from customer. ,
PreparingToShipFromAzureDC: Preparing the device to ship to customer. ,
ShippedToCustomer: Shipped the device to customer. ,
}
,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action. ,
}
,
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 ,
delayInformation:
{
Description: Delay information for the job stages. ,
Required: False ,
}
[
{
status:
{
Description: Status of notification ,
Enum:
{
Active: Delay is still active ,
Resolved: Delay has been resolved ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Delay Error code ,
Enum:
{
InternalIssueDelay: Delay due to any internal reasons ,
ActiveOrderLimitBreachedDelay: Active Order limit breached. ,
HighDemandDelay: High demand ,
LargeNumberOfFilesDelay: Slow copy due to large number of files ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the delay. ,
Required: False ,
}
string ,
startTime:
{
Description: Timestamp when the delay notification was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolutionTime:
{
Description: Timestamp when the delay notification was resolved. ,
Format: date-time ,
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. ,
Created: Notification at job created stage. ,
ShippedToCustomer: Notification at shipped devices to customer 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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Delivery package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: Return package shipping details. ,
Required: False ,
}
{
trackingUrl:
{
Description: Url where shipment can be tracked. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
trackingId:
{
Description: Tracking Id of shipment. ,
Required: False ,
}
string ,
}
,
dataImportDetails:
{
Description: Details of the data to be imported into azure. ,
Required: False ,
}
[
{
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dataExportDetails:
{
Description: Details of the data to be exported from azure. ,
Required: False ,
}
[
{
transferConfiguration:
{
Description: Configuration for the data transfer. ,
Required: True ,
}
{
transferConfigurationType:
{
Description: Type of the configuration for transfer. ,
Enum:
{
TransferAll: Transfer all the data. ,
TransferUsingFilter: Transfer using filter. ,
}
,
Required: True ,
}
enum ,
transferFilterDetails:
{
Description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. ,
Required: False ,
}
{
include:
{
Description: Details of the filtering the transfer of data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
blobFilterDetails:
{
Description: Filter details to transfer blobs. ,
Required: False ,
}
{
blobPrefixList:
{
Description: Prefix list of the Azure blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
blobPathList:
{
Description: List of full path of the blobs to be transferred. ,
Required: False ,
}
[
string ,
]
,
containerList:
{
Description: List of blob containers to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
azureFileFilterDetails:
{
Description: Filter details to transfer Azure files. ,
Required: False ,
}
{
filePrefixList:
{
Description: Prefix list of the Azure files to be transferred. ,
Required: False ,
}
[
string ,
]
,
filePathList:
{
Description: List of full path of the files to be transferred. ,
Required: False ,
}
[
string ,
]
,
fileShareList:
{
Description: List of file shares to be transferred. ,
Required: False ,
}
[
string ,
]
,
}
,
filterFileDetails:
{
Description: Details of the filter files to be used for data transfer. ,
Required: False ,
}
[
{
filterFileType:
{
Description: Type of the filter file. ,
Enum:
{
AzureBlob: Filter file is of the type AzureBlob. ,
AzureFile: Filter file is of the type AzureFiles. ,
}
,
Required: True ,
}
enum ,
filterFilePath:
{
Description: Path of the file that contains the details of all items to transfer. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
transferAllDetails:
{
Description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll ,
Required: False ,
}
{
include:
{
Description: Details to transfer all data. ,
Required: False ,
}
{
dataAccountType:
{
Description: Type of the account of data ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
transferAllBlobs:
{
Description: To indicate if all Azure blobs have to be transferred ,
Required: False ,
}
boolean ,
transferAllFiles:
{
Description: To indicate if all Azure Files have to be transferred ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
logCollectionLevel:
{
Description: Level of the logs to be collected. ,
Enum:
{
Error: Only Errors will be collected in the logs. ,
Verbose: Verbose logging (includes Errors, CRC, size information and others). ,
}
,
Required: False ,
}
enum ,
accountDetails:
{
Description: Account details of the data to be transferred ,
Required: True ,
}
{
dataAccountType:
{
Description: Account Type of the data to be transferred. ,
Enum:
{
StorageAccount: Storage Accounts . ,
ManagedDisk: Azure Managed disk storage. ,
}
,
Required: True ,
}
enum ,
sharePassword:
{
Description: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ ,
Required: False ,
}
string ,
}
,
}
,
]
,
jobDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
preferences:
{
Description: Preferences for the order. ,
Required: False ,
}
{
preferredDataCenterRegion:
{
Description: Preferred data center region. ,
Required: False ,
}
[
string ,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
reverseTransportPreferences:
{
Description: Optional Preferences related to the reverse shipment logistics of the sku. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
isUpdated:
{
Description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. ,
Required: False ,
}
boolean ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryption:
{
Description: Defines secondary layer of software-based encryption enablement. ,
Enum:
{
Enabled: Software-based encryption is enabled. ,
Disabled: Software-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
hardwareEncryption:
{
Description: Defines Hardware level encryption (Only for disk) ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
storageAccountAccessTierPreferences:
{
Description: Preferences related to the Access Tier of storage accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
reverseShippingDetails:
{
Description: Optional Reverse Shipping details for order. ,
Required: False ,
}
{
contactDetails:
{
Description: Contact Info. ,
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 ,
}
,
shippingAddress:
{
Description: Shipping address where customer wishes to receive the device. ,
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: False ,
}
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 ,
skipAddressValidation:
{
Description: Flag to indicate if customer has chosen to skip default address validation ,
Required: False ,
}
boolean ,
taxIdentificationNumber:
{
Description: Tax Identification Number ,
Required: False ,
}
string ,
}
,
isUpdated:
{
Description: A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. Read only field ,
Required: False ,
}
boolean ,
}
,
copyLogDetails:
{
Description: List of copy log details. ,
Required: False ,
}
[
{
copyLogDetailsType:
{
Description: Indicates the type of job details. ,
Enum:
{
DataBox: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk 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 ,
deviceErasureDetails:
{
Description: Holds device data erasure details ,
Required: False ,
}
{
deviceErasureStatus:
{
Description: Holds the device erasure completion status ,
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. ,
WaitingForCustomerAction: Stage is stuck until customer takes some action. ,
SucceededWithWarnings: Stage has succeeded with warnings. ,
WaitingForCustomerActionForKek: Stage is waiting for customer action for kek action items. ,
WaitingForCustomerActionForCleanUp: Stage is waiting for customer action for clean up. ,
CustomerActionPerformedForCleanUp: Stage has performed customer action for clean up. ,
CustomerActionPerformed: Stage has performed customer action for clean up. ,
}
,
Required: False ,
}
enum ,
erasureOrDestructionCertificateSasKey:
{
Description: Shared access key to download cleanup or destruction certificate for device ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Details about which key encryption type is being used. ,
Required: False ,
}
{
kekType:
{
Description: Type of encryption key used for key encryption. ,
Enum:
{
MicrosoftManaged: Key encryption key is managed by Microsoft. ,
CustomerManaged: Key encryption key is managed by the Customer. ,
}
,
Required: True ,
}
enum ,
identityProperties:
{
Description: Managed identity properties used for key encryption. ,
Required: False ,
}
{
type:
{
Description: Managed service identity type. ,
Required: False ,
}
string ,
userAssigned:
{
Description: User assigned identity properties. ,
Required: False ,
}
{
resourceId:
{
Description: Arm resource id for user assigned identity to be used to fetch MSI token. ,
Required: False ,
}
string ,
}
,
}
,
kekUrl:
{
Description: Key encryption key. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Kek vault resource id. It is required in case of Customer managed KekType. ,
Required: False ,
}
string ,
}
,
expectedDataSizeInTeraBytes:
{
Description: The expected size of the data, which needs to be transferred in this job, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Available actions on the job. ,
Required: False ,
}
[
string ,
]
,
lastMitigationActionOnJob:
{
Description: Last mitigation action performed on the job. ,
Required: False ,
}
{
actionDateTimeInUtc:
{
Description: Action performed date time ,
Format: date-time ,
Required: False ,
}
string ,
isPerformedByCustomer:
{
Description: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops ,
Required: False ,
}
boolean ,
customerResolution:
{
Description: Resolution code provided by customer ,
Enum:
{
None: No Resolution Yet ,
MoveToCleanUpDevice: Clean the device ,
Resume: Resume the job to same stage ,
Restart: Restart whole action. ,
ReachOutToOperation: Reach out to operation for further action. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddress:
{
Description: Datacenter address to ship to, for the given sku and storage location. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
dataCenterCode:
{
Description: DataCenter code. ,
Enum:
{
Invalid: No description available. ,
BY2: No description available. ,
BY1: No description available. ,
ORK70: No description available. ,
AM2: No description available. ,
AMS20: No description available. ,
BY21: No description available. ,
BY24: No description available. ,
MWH01: No description available. ,
AMS06: No description available. ,
SSE90: No description available. ,
SYD03: No description available. ,
SYD23: No description available. ,
CBR20: No description available. ,
YTO20: No description available. ,
CWL20: No description available. ,
LON24: No description available. ,
BOM01: No description available. ,
BL20: No description available. ,
BL7: No description available. ,
SEL20: No description available. ,
TYO01: No description available. ,
BN1: No description available. ,
SN5: No description available. ,
CYS04: No description available. ,
TYO22: No description available. ,
YTO21: No description available. ,
YQB20: No description available. ,
FRA22: No description available. ,
MAA01: No description available. ,
CPQ02: No description available. ,
CPQ20: No description available. ,
SIN20: No description available. ,
HKG20: No description available. ,
SG2: No description available. ,
MEL23: No description available. ,
SEL21: No description available. ,
OSA20: No description available. ,
SHA03: No description available. ,
BJB: No description available. ,
JNB22: No description available. ,
JNB21: No description available. ,
MNZ21: No description available. ,
SN8: No description available. ,
AUH20: No description available. ,
ZRH20: No description available. ,
PUS20: No description available. ,
AdHoc: No description available. ,
CH1: No description available. ,
DSM05: No description available. ,
DUB07: No description available. ,
PNQ01: No description available. ,
SVG20: No description available. ,
OSA02: No description available. ,
OSA22: No description available. ,
PAR22: No description available. ,
BN7: No description available. ,
SN6: No description available. ,
BJS20: No description available. ,
BL24: No description available. ,
IDC5: No description available. ,
TYO23: No description available. ,
NTG20: No description available. ,
DXB23: No description available. ,
DSM11: No description available. ,
AMS25: No description available. ,
CPQ21: No description available. ,
OSA23: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: False ,
}
string ,
deliveryType:
{
Description: Delivery type of Job. ,
Enum:
{
NonScheduled: Non Scheduled job. ,
Scheduled: Scheduled job. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Delivery Info of Job. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: Scheduled date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isCancellableWithoutFee:
{
Description: Flag to indicate cancellation of scheduled job. ,
Required: False ,
}
boolean ,
allDevicesLost:
{
Description: Flag to indicate if all devices associated with the job are lost. ,
Required: False ,
}
boolean ,
}
,
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
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 ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
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)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
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: Data Box orders. ,
DataBoxDisk: Data Box Disk orders. ,
DataBoxHeavy: Data Box Heavy orders. ,
DataBoxCustomerDisk: Data Box Customer Disk orders. ,
}
,
Required: True ,
}
enum ,
dcAccessSecurityCode:
{
Description: Dc Access Security Code for Customer Managed Shipping ,
Required: False ,
}
{
reverseDCAccessCode:
{
Description: Reverse Dc access security code. ,
Required: False ,
}
string ,
forwardDCAccessCode:
{
Description: Forward Dc access security code. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Error while fetching the secrets. ,
Required: False ,
}
{
additionalInfo:
{
Description: Gets or sets additional error info. ,
Required: False ,
}
[
{
info:
{
Description: Additional information of the type of error. ,
Required: False ,
}
object ,
type:
{
Description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: Error code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets details for the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message parsed from the body of the http error response. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target of the error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of unencrypted credentials. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_RegionConfiguration (new)
Description :  This API provides configuration details specific to given region/location at Subscription level.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration
{
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 ,
regionConfigurationRequest:
{
Description: Request body to get the configuration for the region. ,
Required: True ,
}
{
scheduleAvailabilityRequest:
{
Description: Request body to get the availability for scheduling orders. ,
Required: False ,
}
{
storageLocation:
{
Description: Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuName:
{
Description: Sku Name for which the order is to be scheduled. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
country:
{
Description: Country in which storage location should be supported. ,
Required: False ,
}
string ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
transportAvailabilityRequest:
{
Description: Request body to get the transport availability for given sku. ,
Required: False ,
}
{
skuName:
{
Description: Type of the device. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddressRequest:
{
Description: Request body to get the datacenter address for given sku. ,
Required: False ,
}
{
storageLocation:
{
Description: Storage location. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuName:
{
Description: Sku Name for which the data center address requested. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
deviceCapabilityRequest:
{
Description: Request body to get the device capabilities for a given sku. ,
Required: False ,
}
{
skuName:
{
Description: Type of the device. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
scheduleAvailabilityResponse:
{
Description: Schedule availability for given sku in a region. ,
Required: False ,
}
{
availableDates:
{
Description: List of dates available to schedule ,
Required: False ,
}
[
string ,
]
,
}
,
transportAvailabilityResponse:
{
Description: Transport options available for given sku in a region. ,
Required: False ,
}
{
transportAvailabilityDetails:
{
Description: List of transport availability details for given region ,
Required: False ,
}
[
{
shipmentType:
{
Description: Transport Shipment Type supported for given region. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
datacenterAddressResponse:
{
Description: Datacenter address for given sku in a region. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
deviceCapabilityResponse:
{
Description: Device capabilities available for a given sku in a region. ,
Required: False ,
}
{
deviceCapabilityDetails:
{
Description: List of device capabilities available for a given region and a given sku ,
Required: False ,
}
[
{
hardwareEncryption:
{
Description: Hardware encryption support for a given sku for a given region. ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}
Service_RegionConfigurationByResourceGroup (new)
Description :  This API provides configuration details specific to given region/location at Resource group level.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
regionConfigurationRequest:
{
Description: Request body to get the configuration for the region at resource group level. ,
Required: True ,
}
{
scheduleAvailabilityRequest:
{
Description: Request body to get the availability for scheduling orders. ,
Required: False ,
}
{
storageLocation:
{
Description: Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuName:
{
Description: Sku Name for which the order is to be scheduled. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
country:
{
Description: Country in which storage location should be supported. ,
Required: False ,
}
string ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
transportAvailabilityRequest:
{
Description: Request body to get the transport availability for given sku. ,
Required: False ,
}
{
skuName:
{
Description: Type of the device. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
datacenterAddressRequest:
{
Description: Request body to get the datacenter address for given sku. ,
Required: False ,
}
{
storageLocation:
{
Description: Storage location. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01 ,
Required: True ,
}
string ,
skuName:
{
Description: Sku Name for which the data center address requested. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: True ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
deviceCapabilityRequest:
{
Description: Request body to get the device capabilities for a given sku. ,
Required: False ,
}
{
skuName:
{
Description: Type of the device. ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025 ,
Enum:
{
DataBox: Data Box. ,
DataBoxDisk: Data Box Disk. ,
DataBoxHeavy: Data Box Heavy. ,
DataBoxCustomerDisk: Data Box Customer Disk ,
AzureDataBox120: Data Box V2 with 125TB usable capacity. ,
AzureDataBox525: Data Box V2 with 500TB usable capacity. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
scheduleAvailabilityResponse:
{
Description: Schedule availability for given sku in a region. ,
Required: False ,
}
{
availableDates:
{
Description: List of dates available to schedule ,
Required: False ,
}
[
string ,
]
,
}
,
transportAvailabilityResponse:
{
Description: Transport options available for given sku in a region. ,
Required: False ,
}
{
transportAvailabilityDetails:
{
Description: List of transport availability details for given region ,
Required: False ,
}
[
{
shipmentType:
{
Description: Transport Shipment Type supported for given region. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
datacenterAddressResponse:
{
Description: Datacenter address for given sku in a region. ,
Required: False ,
}
{
datacenterAddressType:
{
Description: Data center address type ,
Enum:
{
DatacenterAddressLocation: Data center address location. ,
DatacenterAddressInstruction: Data center address instruction. ,
}
,
Required: True ,
}
enum ,
supportedCarriersForReturnShipment:
{
Description: List of supported carriers for return shipment. ,
Required: False ,
}
[
string ,
]
,
dataCenterAzureLocation:
{
Description: Azure Location where the Data Center serves primarily. ,
Required: False ,
}
string ,
}
,
deviceCapabilityResponse:
{
Description: Device capabilities available for a given sku in a region. ,
Required: False ,
}
{
deviceCapabilityDetails:
{
Description: List of device capabilities available for a given region and a given sku ,
Required: False ,
}
[
{
hardwareEncryption:
{
Description: Hardware encryption support for a given sku for a given region. ,
Enum:
{
Enabled: Hardware-based encryption is enabled. ,
Disabled: Hardware-based encryption is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
string ,
}
,
]
,
target:
{
Required: False ,
}
string ,
}
,
}