Microsoft.DataBox jobs 2018-01-01
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@2018-01-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
displayName: 'string'
family: 'string'
name: 'string'
}
properties: {
details: {
contactDetails: {
contactName: 'string'
emailList: [
'string'
]
mobile: 'string'
notificationPreference: [
{
sendNotification: bool
stageName: 'string'
}
]
phone: 'string'
phoneExtension: 'string'
}
destinationAccountDetails: [
{
accountId: 'string'
dataDestinationType: 'string'
// For remaining properties, see DestinationAccountDetails objects
}
]
expectedDataSizeInTeraBytes: int
preferences: {
preferredDataCenterRegion: [
'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
}
}
}
JobDetails objects
Set the jobDetailsType property to specify the type of object.
For DataBox, use:
jobDetailsType: 'DataBox'
For DataBoxDisk, use:
jobDetailsType: 'DataBoxDisk'
passkey: 'string'
preferredDisks: {
{customized property}: int
}
For DataBoxHeavy, use:
jobDetailsType: 'DataBoxHeavy'
DestinationAccountDetails objects
Set the dataDestinationType property to specify the type of object.
For ManagedDisk, use:
dataDestinationType: 'ManagedDisk'
resourceGroupId: 'string'
stagingStorageAccountId: 'string'
For StorageAccount, use:
dataDestinationType: 'StorageAccount'
storageAccountId: 'string'
Property values
jobs
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 3-24 Valid characters: Alphanumerics, hyphens, underscores and periods. |
| 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) |
| tags | The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). | Dictionary of tag names and values. See Tags in templates |
| sku | The sku type. | Sku (required) |
| properties | Properties of a job. | JobProperties (required) |
JobProperties
| Name | Description | Value |
|---|---|---|
| details | Details of a job run. This field will only be sent for expand details filter. | JobDetails |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | Contact details for notification and shipping. | ContactDetails (required) |
| destinationAccountDetails | Destination account details. | DestinationAccountDetails[] (required) |
| expectedDataSizeInTeraBytes | The expected size of the data, which needs to be transferred in this job, in terabytes. | int |
| preferences | Preferences for the order. | Preferences |
| shippingAddress | Shipping address of the customer. | ShippingAddress (required) |
| jobDetailsType | Set the object type | DataBox DataBoxDisk DataBoxHeavy (required) |
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 |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | 'AtAzureDC' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' (required) |
DestinationAccountDetails
| Name | Description | Value |
|---|---|---|
| accountId | Arm Id of the destination where the data has to be moved. | string |
| dataDestinationType | Set the object type | ManagedDisk StorageAccount (required) |
DestinationManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | 'ManagedDisk' (required) |
| resourceGroupId | Destination Resource Group Id where the Compute disks should be created. | string (required) |
| stagingStorageAccountId | Arm Id of the storage account that can be used to copy the vhd for staging. | string (required) |
DestinationStorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | 'StorageAccount' (required) |
| storageAccountId | Destination Storage Account Arm Id. | string (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | string[] |
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 |
DataBoxJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | 'DataBox' (required) |
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 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | 'DataBoxHeavy' (required) |
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) |
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": "2018-01-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"displayName": "string",
"family": "string",
"name": "string"
},
"properties": {
"details": {
"contactDetails": {
"contactName": "string",
"emailList": [ "string" ],
"mobile": "string",
"notificationPreference": [
{
"sendNotification": "bool",
"stageName": "string"
}
],
"phone": "string",
"phoneExtension": "string"
},
"destinationAccountDetails": [
{
"accountId": "string",
"dataDestinationType": "string"
// For remaining properties, see DestinationAccountDetails objects
}
],
"expectedDataSizeInTeraBytes": "int",
"preferences": {
"preferredDataCenterRegion": [ "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
}
}
}
JobDetails objects
Set the jobDetailsType property to specify the type of object.
For DataBox, use:
"jobDetailsType": "DataBox"
For DataBoxDisk, use:
"jobDetailsType": "DataBoxDisk",
"passkey": "string",
"preferredDisks": {
"{customized property}": "int"
}
For DataBoxHeavy, use:
"jobDetailsType": "DataBoxHeavy"
DestinationAccountDetails objects
Set the dataDestinationType property to specify the type of object.
For ManagedDisk, use:
"dataDestinationType": "ManagedDisk",
"resourceGroupId": "string",
"stagingStorageAccountId": "string"
For StorageAccount, use:
"dataDestinationType": "StorageAccount",
"storageAccountId": "string"
Property values
jobs
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DataBox/jobs' |
| apiVersion | The resource api version | '2018-01-01' |
| name | The resource name | string (required) Character limit: 3-24 Valid characters: Alphanumerics, hyphens, underscores and periods. |
| 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) |
| tags | The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). | Dictionary of tag names and values. See Tags in templates |
| sku | The sku type. | Sku (required) |
| properties | Properties of a job. | JobProperties (required) |
JobProperties
| Name | Description | Value |
|---|---|---|
| details | Details of a job run. This field will only be sent for expand details filter. | JobDetails |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | Contact details for notification and shipping. | ContactDetails (required) |
| destinationAccountDetails | Destination account details. | DestinationAccountDetails[] (required) |
| expectedDataSizeInTeraBytes | The expected size of the data, which needs to be transferred in this job, in terabytes. | int |
| preferences | Preferences for the order. | Preferences |
| shippingAddress | Shipping address of the customer. | ShippingAddress (required) |
| jobDetailsType | Set the object type | DataBox DataBoxDisk DataBoxHeavy (required) |
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 |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | 'AtAzureDC' 'DataCopy' 'Delivered' 'DevicePrepared' 'Dispatched' 'PickedUp' (required) |
DestinationAccountDetails
| Name | Description | Value |
|---|---|---|
| accountId | Arm Id of the destination where the data has to be moved. | string |
| dataDestinationType | Set the object type | ManagedDisk StorageAccount (required) |
DestinationManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | 'ManagedDisk' (required) |
| resourceGroupId | Destination Resource Group Id where the Compute disks should be created. | string (required) |
| stagingStorageAccountId | Arm Id of the storage account that can be used to copy the vhd for staging. | string (required) |
DestinationStorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | 'StorageAccount' (required) |
| storageAccountId | Destination Storage Account Arm Id. | string (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | string[] |
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 |
DataBoxJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | 'DataBox' (required) |
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 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | 'DataBoxHeavy' (required) |
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) |
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@2018-01-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
details = {
contactDetails = {
contactName = "string"
emailList = [
"string"
]
mobile = "string"
notificationPreference = [
{
sendNotification = bool
stageName = "string"
}
]
phone = "string"
phoneExtension = "string"
}
destinationAccountDetails = [
{
accountId = "string"
dataDestinationType = "string"
// For remaining properties, see DestinationAccountDetails objects
}
]
expectedDataSizeInTeraBytes = int
preferences = {
preferredDataCenterRegion = [
"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
}
}
sku = {
displayName = "string"
family = "string"
name = "string"
}
})
}
JobDetails objects
Set the jobDetailsType property to specify the type of object.
For DataBox, use:
jobDetailsType = "DataBox"
For DataBoxDisk, use:
jobDetailsType = "DataBoxDisk"
passkey = "string"
preferredDisks = {
{customized property} = int
}
For DataBoxHeavy, use:
jobDetailsType = "DataBoxHeavy"
DestinationAccountDetails objects
Set the dataDestinationType property to specify the type of object.
For ManagedDisk, use:
dataDestinationType = "ManagedDisk"
resourceGroupId = "string"
stagingStorageAccountId = "string"
For StorageAccount, use:
dataDestinationType = "StorageAccount"
storageAccountId = "string"
Property values
jobs
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DataBox/jobs@2018-01-01" |
| name | The resource name | string (required) Character limit: 3-24 Valid characters: Alphanumerics, hyphens, underscores and periods. |
| 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) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). | Dictionary of tag names and values. |
| sku | The sku type. | Sku (required) |
| properties | Properties of a job. | JobProperties (required) |
JobProperties
| Name | Description | Value |
|---|---|---|
| details | Details of a job run. This field will only be sent for expand details filter. | JobDetails |
JobDetails
| Name | Description | Value |
|---|---|---|
| contactDetails | Contact details for notification and shipping. | ContactDetails (required) |
| destinationAccountDetails | Destination account details. | DestinationAccountDetails[] (required) |
| expectedDataSizeInTeraBytes | The expected size of the data, which needs to be transferred in this job, in terabytes. | int |
| preferences | Preferences for the order. | Preferences |
| shippingAddress | Shipping address of the customer. | ShippingAddress (required) |
| jobDetailsType | Set the object type | DataBox DataBoxDisk DataBoxHeavy (required) |
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 |
NotificationPreference
| Name | Description | Value |
|---|---|---|
| sendNotification | Notification is required or not. | bool (required) |
| stageName | Name of the stage. | "AtAzureDC" "DataCopy" "Delivered" "DevicePrepared" "Dispatched" "PickedUp" (required) |
DestinationAccountDetails
| Name | Description | Value |
|---|---|---|
| accountId | Arm Id of the destination where the data has to be moved. | string |
| dataDestinationType | Set the object type | ManagedDisk StorageAccount (required) |
DestinationManagedDiskDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | "ManagedDisk" (required) |
| resourceGroupId | Destination Resource Group Id where the Compute disks should be created. | string (required) |
| stagingStorageAccountId | Arm Id of the storage account that can be used to copy the vhd for staging. | string (required) |
DestinationStorageAccountDetails
| Name | Description | Value |
|---|---|---|
| dataDestinationType | Data Destination Type. | "StorageAccount" (required) |
| storageAccountId | Destination Storage Account Arm Id. | string (required) |
Preferences
| Name | Description | Value |
|---|---|---|
| preferredDataCenterRegion | string[] |
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 |
DataBoxJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | "DataBox" (required) |
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 |
|---|---|---|
| {customized property} | int |
DataBoxHeavyJobDetails
| Name | Description | Value |
|---|---|---|
| jobDetailsType | Indicates the type of job details. | "DataBoxHeavy" (required) |
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) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for