Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2020-04-01' = {
identity: {
type: 'string'
}
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
}
}
]
expectedDataSizeInTeraBytes: int
preferences: {
preferredDataCenterRegion: [
'string'
]
transportPreferences: {
preferredShipmentType: 'string'
}
}
shippingAddress: {
addressType: 'string'
city: 'string'
companyName: 'string'
country: 'string'
postalCode: 'string'
stateOrProvince: 'string'
streetAddress1: 'string'
streetAddress2: 'string'
streetAddress3: 'string'
zipExtendedCode: 'string'
}
jobDetailsType: 'string'
// For remaining properties, see JobDetails objects
}
transferType: 'string'
}
sku: {
displayName: 'string'
family: '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 DataBoxDisk, use:
{
jobDetailsType: 'DataBoxDisk'
passkey: 'string'
preferredDisks: {
{customized property}: int
}
}
For DataBoxHeavy, use:
{
devicePassword: 'string'
jobDetailsType: 'DataBoxHeavy'
}
Property Values
Microsoft.DataBox/jobs
| Name | Description | Value |
|---|---|---|
| identity | Msi identity of the resource | ResourceIdentity |
| location | The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[-\w\.]+$ (required) |
| properties | Properties of a job. | JobProperties (required) |
| sku | The sku type. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
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. |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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) |
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) |
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 'DataBoxDisk' for type DataBoxDiskJobDetails. Set to 'DataBoxHeavy' for type DataBoxHeavyJobDetails. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
| preferences | Preferences for the order. | Preferences |
| 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) |
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) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | 'AtAzureDC' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | Preferred data center region. | string[] |
| transportPreferences | Preferences related to the shipment logistics of the sku. | TransportPreferences |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | string |
ResourceTags
| Name | Description | Value |
|---|
ShippingAddress
| Name | Description | Value |
|---|---|---|
| addressType | Type of address. | 'Commercial' 'None' 'Residential' |
| city | Name of the City. | string |
| companyName | Name of the company. | string |
| country | Name of the Country. | string (required) |
| postalCode | Postal code. | string (required) |
| stateOrProvince | Name of the State or Province. | string |
| streetAddress1 | Street Address line 1. | string (required) |
| streetAddress2 | Street Address line 2. | string |
| streetAddress3 | Street Address line 3. | string |
| zipExtendedCode | Extended Zip Code. | string |
Sku
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the sku. | string |
| family | The sku family. | string |
| name | The sku name. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
StorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Account Type of the data to be transferred. | 'StorageAccount' (required) |
| storageAccountId | Storage Account Resource Id. | string (required) |
TransferAllDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Type of the account of data | 'ManagedDisk' 'StorageAccount' (required) |
| transferAllBlobs | To indicate if all Azure blobs have to be transferred | bool |
| transferAllFiles | To indicate if all Azure Files have to be transferred | bool |
TransferConfiguration
| Name | Description | Value |
|---|---|---|
| transferAllDetails | Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll | TransferConfigurationTransferAllDetails |
| transferConfigurationType | Type of the configuration for transfer. | 'TransferAll' 'TransferUsingFilter' (required) |
| transferFilterDetails | Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| Name | Description | Value |
|---|---|---|
| include | Details to transfer all data. | TransferAllDetails |
TransferConfigurationTransferFilterDetails
| Name | Description | Value |
|---|---|---|
| include | Details of the filtering the transfer of data. | TransferFilterDetails |
TransferFilterDetails
| Name | Description | Value |
|---|---|---|
| azureFileFilterDetails | Filter details to transfer Azure files. | AzureFileFilterDetails |
| blobFilterDetails | Filter details to transfer blobs. | BlobFilterDetails |
| dataAccountType | Type of the account of data. | 'ManagedDisk' 'StorageAccount' (required) |
| filterFileDetails | Details of the filter files to be used for data transfer. | FilterFileDetails[] |
TransportPreferences
| Name | Description | Value |
|---|---|---|
| preferredShipmentType | Indicates Shipment Logistics type that the customer preferred. | 'CustomerManaged' 'MicrosoftManaged' (required) |
ARM template 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 JSON to your template.
{
"type": "Microsoft.DataBox/jobs",
"apiVersion": "2020-04-01",
"name": "string",
"identity": {
"type": "string"
},
"location": "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
}
}
],
"expectedDataSizeInTeraBytes": "int",
"preferences": {
"preferredDataCenterRegion": [ "string" ],
"transportPreferences": {
"preferredShipmentType": "string"
}
},
"shippingAddress": {
"addressType": "string",
"city": "string",
"companyName": "string",
"country": "string",
"postalCode": "string",
"stateOrProvince": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"streetAddress3": "string",
"zipExtendedCode": "string"
},
"jobDetailsType": "string"
// For remaining properties, see JobDetails objects
},
"transferType": "string"
},
"sku": {
"displayName": "string",
"family": "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 DataBoxDisk, use:
{
"jobDetailsType": "DataBoxDisk",
"passkey": "string",
"preferredDisks": {
"{customized property}": "int"
}
}
For DataBoxHeavy, use:
{
"devicePassword": "string",
"jobDetailsType": "DataBoxHeavy"
}
Property Values
Microsoft.DataBox/jobs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-04-01' |
| identity | Msi identity of the resource | ResourceIdentity |
| location | The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[-\w\.]+$ (required) |
| properties | Properties of a job. | JobProperties (required) |
| sku | The sku type. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DataBox/jobs' |
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 |
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. |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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) |
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) |
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 'DataBoxDisk' for type DataBoxDiskJobDetails. Set to 'DataBoxHeavy' for type DataBoxHeavyJobDetails. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
| preferences | Preferences for the order. | Preferences |
| 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) |
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) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | 'AtAzureDC' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | Preferred data center region. | string[] |
| transportPreferences | Preferences related to the shipment logistics of the sku. | TransportPreferences |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | string |
ResourceTags
| Name | Description | Value |
|---|
ShippingAddress
| Name | Description | Value |
|---|---|---|
| addressType | Type of address. | 'Commercial' 'None' 'Residential' |
| city | Name of the City. | string |
| companyName | Name of the company. | string |
| country | Name of the Country. | string (required) |
| postalCode | Postal code. | string (required) |
| stateOrProvince | Name of the State or Province. | string |
| streetAddress1 | Street Address line 1. | string (required) |
| streetAddress2 | Street Address line 2. | string |
| streetAddress3 | Street Address line 3. | string |
| zipExtendedCode | Extended Zip Code. | string |
Sku
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the sku. | string |
| family | The sku family. | string |
| name | The sku name. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
StorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Account Type of the data to be transferred. | 'StorageAccount' (required) |
| storageAccountId | Storage Account Resource Id. | string (required) |
TransferAllDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Type of the account of data | 'ManagedDisk' 'StorageAccount' (required) |
| transferAllBlobs | To indicate if all Azure blobs have to be transferred | bool |
| transferAllFiles | To indicate if all Azure Files have to be transferred | bool |
TransferConfiguration
| Name | Description | Value |
|---|---|---|
| transferAllDetails | Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll | TransferConfigurationTransferAllDetails |
| transferConfigurationType | Type of the configuration for transfer. | 'TransferAll' 'TransferUsingFilter' (required) |
| transferFilterDetails | Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| Name | Description | Value |
|---|---|---|
| include | Details to transfer all data. | TransferAllDetails |
TransferConfigurationTransferFilterDetails
| Name | Description | Value |
|---|---|---|
| include | Details of the filtering the transfer of data. | TransferFilterDetails |
TransferFilterDetails
| Name | Description | Value |
|---|---|---|
| azureFileFilterDetails | Filter details to transfer Azure files. | AzureFileFilterDetails |
| blobFilterDetails | Filter details to transfer blobs. | BlobFilterDetails |
| dataAccountType | Type of the account of data. | 'ManagedDisk' 'StorageAccount' (required) |
| filterFileDetails | Details of the filter files to be used for data transfer. | FilterFileDetails[] |
TransportPreferences
| Name | Description | Value |
|---|---|---|
| preferredShipmentType | Indicates Shipment Logistics type that the customer preferred. | 'CustomerManaged' 'MicrosoftManaged' (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The jobs resource type can be deployed with operations that target:
- Resource groups
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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataBox/jobs@2020-04-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
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
}
}
]
expectedDataSizeInTeraBytes = int
preferences = {
preferredDataCenterRegion = [
"string"
]
transportPreferences = {
preferredShipmentType = "string"
}
}
shippingAddress = {
addressType = "string"
city = "string"
companyName = "string"
country = "string"
postalCode = "string"
stateOrProvince = "string"
streetAddress1 = "string"
streetAddress2 = "string"
streetAddress3 = "string"
zipExtendedCode = "string"
}
jobDetailsType = "string"
// For remaining properties, see JobDetails objects
}
transferType = "string"
}
sku = {
displayName = "string"
family = "string"
name = "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 DataBoxDisk, use:
{
jobDetailsType = "DataBoxDisk"
passkey = "string"
preferredDisks = {
{customized property} = int
}
}
For DataBoxHeavy, use:
{
devicePassword = "string"
jobDetailsType = "DataBoxHeavy"
}
Property Values
Microsoft.DataBox/jobs
| Name | Description | Value |
|---|---|---|
| identity | Msi identity of the resource | ResourceIdentity |
| location | The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[-\w\.]+$ (required) |
| properties | Properties of a job. | JobProperties (required) |
| sku | The sku type. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DataBox/jobs@2020-04-01" |
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 |
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. |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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) |
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) |
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 'DataBoxDisk' for type DataBoxDiskJobDetails. Set to 'DataBoxHeavy' for type DataBoxHeavyJobDetails. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
| preferences | Preferences for the order. | Preferences |
| 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) |
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) |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | 'AtAzureDC' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | Preferred data center region. | string[] |
| transportPreferences | Preferences related to the shipment logistics of the sku. | TransportPreferences |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | string |
ResourceTags
| Name | Description | Value |
|---|
ShippingAddress
| Name | Description | Value |
|---|---|---|
| addressType | Type of address. | 'Commercial' 'None' 'Residential' |
| city | Name of the City. | string |
| companyName | Name of the company. | string |
| country | Name of the Country. | string (required) |
| postalCode | Postal code. | string (required) |
| stateOrProvince | Name of the State or Province. | string |
| streetAddress1 | Street Address line 1. | string (required) |
| streetAddress2 | Street Address line 2. | string |
| streetAddress3 | Street Address line 3. | string |
| zipExtendedCode | Extended Zip Code. | string |
Sku
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the sku. | string |
| family | The sku family. | string |
| name | The sku name. | 'DataBox' 'DataBoxDisk' 'DataBoxHeavy' (required) |
StorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Account Type of the data to be transferred. | 'StorageAccount' (required) |
| storageAccountId | Storage Account Resource Id. | string (required) |
TransferAllDetails
| Name | Description | Value |
|---|---|---|
| dataAccountType | Type of the account of data | 'ManagedDisk' 'StorageAccount' (required) |
| transferAllBlobs | To indicate if all Azure blobs have to be transferred | bool |
| transferAllFiles | To indicate if all Azure Files have to be transferred | bool |
TransferConfiguration
| Name | Description | Value |
|---|---|---|
| transferAllDetails | Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll | TransferConfigurationTransferAllDetails |
| transferConfigurationType | Type of the configuration for transfer. | 'TransferAll' 'TransferUsingFilter' (required) |
| transferFilterDetails | Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. | TransferConfigurationTransferFilterDetails |
TransferConfigurationTransferAllDetails
| Name | Description | Value |
|---|---|---|
| include | Details to transfer all data. | TransferAllDetails |
TransferConfigurationTransferFilterDetails
| Name | Description | Value |
|---|---|---|
| include | Details of the filtering the transfer of data. | TransferFilterDetails |
TransferFilterDetails
| Name | Description | Value |
|---|---|---|
| azureFileFilterDetails | Filter details to transfer Azure files. | AzureFileFilterDetails |
| blobFilterDetails | Filter details to transfer blobs. | BlobFilterDetails |
| dataAccountType | Type of the account of data. | 'ManagedDisk' 'StorageAccount' (required) |
| filterFileDetails | Details of the filter files to be used for data transfer. | FilterFileDetails[] |
TransportPreferences
| Name | Description | Value |
|---|---|---|
| preferredShipmentType | Indicates Shipment Logistics type that the customer preferred. | 'CustomerManaged' 'MicrosoftManaged' (required) |