Microsoft.DataBox jobs 2019-09-01

Bicep resource definition

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

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@2019-09-01' = {
  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'
      }
      destinationAccountDetails: [
        {
          accountId: 'string'
          sharePassword: 'string'
          dataDestinationType: 'string'
          // For remaining properties, see DestinationAccountDetails 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
    }
  }
  sku: {
    displayName: 'string'
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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'
}

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

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

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 string
jobDetailsType Indicates the type of job details. 'DataBoxHeavy' (required)

DataBoxJobDetails

Name Description Value
devicePassword Set Device password for unlocking Databox string
jobDetailsType Indicates the type of job details. 'DataBox' (required)

DestinationAccountDetails

Name Description Value
accountId Arm Id of the destination where the data has to be moved. string
dataDestinationType Set to 'ManagedDisk' for type DestinationManagedDiskDetails. Set to 'StorageAccount' for type DestinationStorageAccountDetails. 'ManagedDisk'
'StorageAccount' (required)
sharePassword Share password to be shared by all shares in SA. string

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)

JobDeliveryInfo

Name Description Value
scheduledDateTime Scheduled date time. string

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
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 (required)

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

Microsoft.DataBox/jobs

Name Description Value
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

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

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)

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:

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": "2019-09-01",
  "name": "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"
      },
      "destinationAccountDetails": [ {
        "accountId": "string",
        "sharePassword": "string",
        "dataDestinationType": "string"
        // For remaining properties, see DestinationAccountDetails 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
    }
  },
  "sku": {
    "displayName": "string",
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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"
}

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

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

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 string
jobDetailsType Indicates the type of job details. 'DataBoxHeavy' (required)

DataBoxJobDetails

Name Description Value
devicePassword Set Device password for unlocking Databox string
jobDetailsType Indicates the type of job details. 'DataBox' (required)

DestinationAccountDetails

Name Description Value
accountId Arm Id of the destination where the data has to be moved. string
dataDestinationType Set to 'ManagedDisk' for type DestinationManagedDiskDetails. Set to 'StorageAccount' for type DestinationStorageAccountDetails. 'ManagedDisk'
'StorageAccount' (required)
sharePassword Share password to be shared by all shares in SA. string

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)

JobDeliveryInfo

Name Description Value
scheduledDateTime Scheduled date time. string

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
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 (required)

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

Microsoft.DataBox/jobs

Name Description Value
apiVersion The api version '2019-09-01'
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'

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

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)

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@2019-09-01"
  name = "string"
  location = "string"
  sku = {
    displayName = "string"
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      deliveryInfo = {
        scheduledDateTime = "string"
      }
      deliveryType = "string"
      details = {
        contactDetails = {
          contactName = "string"
          emailList = [
            "string"
          ]
          mobile = "string"
          notificationPreference = [
            {
              sendNotification = bool
              stageName = "string"
            }
          ]
          phone = "string"
          phoneExtension = "string"
        }
        destinationAccountDetails = [
          {
            accountId = "string"
            sharePassword = "string"
            dataDestinationType = "string"
            // For remaining properties, see DestinationAccountDetails 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
      }
    }
  })
}

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"
}

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

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

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 string
jobDetailsType Indicates the type of job details. 'DataBoxHeavy' (required)

DataBoxJobDetails

Name Description Value
devicePassword Set Device password for unlocking Databox string
jobDetailsType Indicates the type of job details. 'DataBox' (required)

DestinationAccountDetails

Name Description Value
accountId Arm Id of the destination where the data has to be moved. string
dataDestinationType Set to 'ManagedDisk' for type DestinationManagedDiskDetails. Set to 'StorageAccount' for type DestinationStorageAccountDetails. 'ManagedDisk'
'StorageAccount' (required)
sharePassword Share password to be shared by all shares in SA. string

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)

JobDeliveryInfo

Name Description Value
scheduledDateTime Scheduled date time. string

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
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 (required)

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

Microsoft.DataBox/jobs

Name Description Value
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@2019-09-01"

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

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)

TransportPreferences

Name Description Value
preferredShipmentType Indicates Shipment Logistics type that the customer preferred. 'CustomerManaged'
'MicrosoftManaged' (required)