Microsoft.DataBox jobs

Article
2024-12-09

Bicep resource definition

The jobs resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBox/jobs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBox/jobs@2025-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    deliveryInfo: {
      scheduledDateTime: 'string'
    }
    deliveryType: 'string'
    details: {
      contactDetails: {
        contactName: 'string'
        emailList: [
          'string'
        ]
        mobile: 'string'
        notificationPreference: [
          {
            sendNotification: bool
            stageName: 'string'
          }
        ]
        phone: 'string'
        phoneExtension: 'string'
      }
      dataExportDetails: [
        {
          accountDetails: {
            sharePassword: 'string'
            dataAccountType: 'string'
            // For remaining properties, see DataAccountDetails objects
          }
          logCollectionLevel: 'string'
          transferConfiguration: {
            transferAllDetails: {
              include: {
                dataAccountType: 'string'
                transferAllBlobs: bool
                transferAllFiles: bool
              }
            }
            transferConfigurationType: 'string'
            transferFilterDetails: {
              include: {
                azureFileFilterDetails: {
                  filePathList: [
                    'string'
                  ]
                  filePrefixList: [
                    'string'
                  ]
                  fileShareList: [
                    'string'
                  ]
                }
                blobFilterDetails: {
                  blobPathList: [
                    'string'
                  ]
                  blobPrefixList: [
                    'string'
                  ]
                  containerList: [
                    'string'
                  ]
                }
                dataAccountType: 'string'
                filterFileDetails: [
                  {
                    filterFilePath: 'string'
                    filterFileType: 'string'
                  }
                ]
              }
            }
          }
        }
      ]
      dataImportDetails: [
        {
          accountDetails: {
            sharePassword: 'string'
            dataAccountType: 'string'
            // For remaining properties, see DataAccountDetails objects
          }
          logCollectionLevel: 'string'
        }
      ]
      expectedDataSizeInTeraBytes: int
      keyEncryptionKey: {
        identityProperties: {
          type: 'string'
          userAssigned: {
            resourceId: 'string'
          }
        }
        kekType: 'string'
        kekUrl: 'string'
        kekVaultResourceID: 'string'
      }
      preferences: {
        encryptionPreferences: {
          doubleEncryption: 'string'
          hardwareEncryption: 'string'
        }
        preferredDataCenterRegion: [
          'string'
        ]
        reverseTransportPreferences: {
          preferredShipmentType: 'string'
        }
        storageAccountAccessTierPreferences: [
          'Archive'
        ]
        transportPreferences: {
          preferredShipmentType: 'string'
        }
      }
      reverseShippingDetails: {
        contactDetails: {
          contactName: 'string'
          mobile: 'string'
          phone: 'string'
          phoneExtension: 'string'
        }
        shippingAddress: {
          addressType: 'string'
          city: 'string'
          companyName: 'string'
          country: 'string'
          postalCode: 'string'
          skipAddressValidation: bool
          stateOrProvince: 'string'
          streetAddress1: 'string'
          streetAddress2: 'string'
          streetAddress3: 'string'
          taxIdentificationNumber: 'string'
          zipExtendedCode: 'string'
        }
      }
      shippingAddress: {
        addressType: 'string'
        city: 'string'
        companyName: 'string'
        country: 'string'
        postalCode: 'string'
        skipAddressValidation: bool
        stateOrProvince: 'string'
        streetAddress1: 'string'
        streetAddress2: 'string'
        streetAddress3: 'string'
        taxIdentificationNumber: 'string'
        zipExtendedCode: 'string'
      }
      jobDetailsType: 'string'
      // For remaining properties, see JobDetails objects
    }
    transferType: 'string'
  }
  sku: {
    displayName: 'string'
    family: 'string'
    model: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

DataAccountDetails objects

Set the dataAccountType property to specify the type of object.

For ManagedDisk, use:

{
  dataAccountType: 'ManagedDisk'
  resourceGroupId: 'string'
  stagingStorageAccountId: 'string'
}

For StorageAccount, use:

{
  dataAccountType: 'StorageAccount'
  storageAccountId: 'string'
}

JobDetails objects

Set the jobDetailsType property to specify the type of object.

For DataBox, use:

{
  devicePassword: 'string'
  jobDetailsType: 'DataBox'
}

For DataBoxCustomerDisk, use:

{
  enableManifestBackup: bool
  importDiskDetailsCollection: {
    {customized property}: {
      bitLockerKey: 'string'
      manifestFile: 'string'
      manifestHash: 'string'
    }
  }
  jobDetailsType: 'DataBoxCustomerDisk'
  returnToCustomerPackageDetails: {
    carrierAccountNumber: 'string'
    carrierName: 'string'
    trackingId: 'string'
  }
}

For DataBoxDisk, use:

{
  jobDetailsType: 'DataBoxDisk'
  passkey: 'string'
  preferredDisks: {
    {customized property}: int
  }
}

For DataBoxHeavy, use:

{
  devicePassword: 'string'
  jobDetailsType: 'DataBoxHeavy'
}

Property Values

AzureFileFilterDetails

Name	Description	Value
filePathList	List of full path of the files to be transferred.	string[]
filePrefixList	Prefix list of the Azure files to be transferred.	string[]
fileShareList	List of file shares to be transferred.	string[]

BlobFilterDetails

Name	Description	Value
blobPathList	List of full path of the blobs to be transferred.	string[]
blobPrefixList	Prefix list of the Azure blobs to be transferred.	string[]
containerList	List of blob containers to be transferred.	string[]

ContactDetails

Name	Description	Value
contactName	Contact name of the person.	string (required)
emailList	List of Email-ids to be notified about job progress.	string[] (required)
mobile	Mobile number of the contact person.	string
notificationPreference	Notification preference for a job stage.	NotificationPreference[]
phone	Phone number of the contact person.	string (required)
phoneExtension	Phone extension number of the contact person.	string

ContactInfo

Name	Description	Value
contactName	Contact name of the person.	string Constraints: Min length = 1 (required)
mobile	Mobile number of the contact person.	string
phone	Phone number of the contact person.	string Constraints: Min length = 1 (required)
phoneExtension	Phone extension number of the contact person.	string

DataAccountDetails

Name	Description	Value
dataAccountType	Set to 'ManagedDisk' for type ManagedDiskDetails. Set to 'StorageAccount' for type StorageAccountDetails.	'ManagedDisk' 'StorageAccount' (required)
sharePassword	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 : @#-$%^!+=;:_()]+	string Constraints: Sensitive value. Pass in as a secure parameter.

DataBoxCustomerDiskJobDetails

Name	Description	Value
enableManifestBackup	Flag to indicate if disk manifest should be backed-up in the Storage Account.	bool
importDiskDetailsCollection	Contains the map of disk serial number to the disk details for import jobs.	DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection
jobDetailsType	Indicates the type of job details.	'DataBoxCustomerDisk' (required)
returnToCustomerPackageDetails	Return package shipping details.	PackageCarrierDetails (required)

DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection

Name	Description	Value

DataBoxDiskJobDetails

Name	Description	Value
jobDetailsType	Indicates the type of job details.	'DataBoxDisk' (required)
passkey	User entered passkey for DataBox Disk job.	string
preferredDisks	User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.	DataBoxDiskJobDetailsPreferredDisks

DataBoxDiskJobDetailsPreferredDisks

Name	Description	Value

DataBoxHeavyJobDetails

Name	Description	Value
devicePassword	Set Device password for unlocking Databox Heavy. 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 : @#-$%^!+=;:_()]+	string
jobDetailsType	Indicates the type of job details.	'DataBoxHeavy' (required)

DataBoxJobDetails

Name	Description	Value
devicePassword	Set Device password for unlocking Databox. 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 : @#-$%^!+=;:_()]+	string
jobDetailsType	Indicates the type of job details.	'DataBox' (required)

DataExportDetails

Name	Description	Value
accountDetails	Account details of the data to be transferred	DataAccountDetails (required)
logCollectionLevel	Level of the logs to be collected.	'Error' 'Verbose'
transferConfiguration	Configuration for the data transfer.	TransferConfiguration (required)

DataImportDetails

Name	Description	Value
accountDetails	Account details of the data to be transferred	DataAccountDetails (required)
logCollectionLevel	Level of the logs to be collected.	'Error' 'Verbose'

EncryptionPreferences

Name	Description	Value
doubleEncryption	Defines secondary layer of software-based encryption enablement.	'Disabled' 'Enabled'
hardwareEncryption	Defines Hardware level encryption (Only for disk)	'Disabled' 'Enabled'

FilterFileDetails

Name	Description	Value
filterFilePath	Path of the file that contains the details of all items to transfer.	string (required)
filterFileType	Type of the filter file.	'AzureBlob' 'AzureFile' (required)

IdentityProperties

Name	Description	Value
type	Managed service identity type.	string
userAssigned	User assigned identity properties.	UserAssignedProperties

ImportDiskDetails

Name	Description	Value
bitLockerKey	BitLocker key used to encrypt the disk.	string Constraints: Sensitive value. Pass in as a secure parameter. (required)
manifestFile	The relative path of the manifest file on the disk.	string (required)
manifestHash	The Base16-encoded MD5 hash of the manifest file on the disk.	string (required)

JobDeliveryInfo

Name	Description	Value
scheduledDateTime	Scheduled date time.	string

JobDetails

Name	Description	Value
contactDetails	Contact details for notification and shipping.	ContactDetails (required)
dataExportDetails	Details of the data to be exported from azure.	DataExportDetails[]
dataImportDetails	Details of the data to be imported into azure.	DataImportDetails[]
expectedDataSizeInTeraBytes	The expected size of the data, which needs to be transferred in this job, in terabytes.	int
jobDetailsType	Set to 'DataBox' for type DataBoxJobDetails. Set to 'DataBoxCustomerDisk' for type DataBoxCustomerDiskJobDetails. Set to 'DataBoxDisk' for type DataBoxDiskJobDetails. Set to 'DataBoxHeavy' for type DataBoxHeavyJobDetails.	'DataBox' 'DataBoxCustomerDisk' 'DataBoxDisk' 'DataBoxHeavy' (required)
keyEncryptionKey	Details about which key encryption type is being used.	KeyEncryptionKey
preferences	Preferences for the order.	Preferences
reverseShippingDetails	Optional Reverse Shipping details for order.	ReverseShippingDetails
shippingAddress	Shipping address of the customer.	ShippingAddress

JobProperties

Name	Description	Value
deliveryInfo	Delivery Info of Job.	JobDeliveryInfo
deliveryType	Delivery type of Job.	'NonScheduled' 'Scheduled'
details	Details of a job run. This field will only be sent for expand details filter.	JobDetails
transferType	Type of the data transfer.	'ExportFromAzure' 'ImportToAzure' (required)

KeyEncryptionKey

Name	Description	Value
identityProperties	Managed identity properties used for key encryption.	IdentityProperties
kekType	Type of encryption key used for key encryption.	'CustomerManaged' 'MicrosoftManaged' (required)
kekUrl	Key encryption key. It is required in case of Customer managed KekType.	string
kekVaultResourceID	Kek vault resource id. It is required in case of Customer managed KekType.	string

ManagedDiskDetails

Name	Description	Value
dataAccountType	Account Type of the data to be transferred.	'ManagedDisk' (required)
resourceGroupId	Resource Group Id of the compute disks.	string (required)
stagingStorageAccountId	Resource Id of the storage account that can be used to copy the vhd for staging.	string (required)