Microsoft.ImportExport jobs template reference

Template format

To create a Microsoft.ImportExport/jobs resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ImportExport/jobs",
  "apiVersion": "2016-11-01",
  "location": "string",
  "tags": {},
  "properties": {
    "storageAccountId": "string",
    "jobType": "string",
    "returnAddress": {
      "recipientName": "string",
      "streetAddress1": "string",
      "streetAddress2": "string",
      "city": "string",
      "stateOrProvince": "string",
      "postalCode": "string",
      "countryOrRegion": "string",
      "phone": "string",
      "email": "string"
    },
    "returnShipping": {
      "carrierName": "string",
      "carrierAccountNumber": "string"
    },
    "shippingInformation": {
      "recipientName": "string",
      "streetAddress1": "string",
      "streetAddress2": "string",
      "city": "string",
      "stateOrProvince": "string",
      "postalCode": "string",
      "countryOrRegion": "string",
      "phone": "string"
    },
    "deliveryPackage": {
      "carrierName": "string",
      "trackingNumber": "string",
      "driveCount": "integer",
      "shipDate": "string"
    },
    "returnPackage": {
      "carrierName": "string",
      "trackingNumber": "string",
      "driveCount": "integer",
      "shipDate": "string"
    },
    "diagnosticsPath": "string",
    "logLevel": "string",
    "backupDriveManifest": "boolean",
    "state": "string",
    "cancelRequested": "boolean",
    "percentComplete": "integer",
    "incompleteBlobListUri": "string",
    "driveList": [
      {
        "driveId": "string",
        "bitLockerKey": "string",
        "manifestFile": "string",
        "manifestHash": "string",
        "driveHeaderHash": "string",
        "state": "string",
        "copyStatus": "string",
        "percentComplete": "integer",
        "verboseLogUri": "string",
        "errorLogUri": "string",
        "manifestUri": "string",
        "bytesSucceeded": "integer"
      }
    ],
    "export": {
      "blobList": {
        "blobPath": [
          "string"
        ],
        "blobPathPrefix": [
          "string"
        ]
      },
      "blobListblobPath": "string"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ImportExport/jobs object

Name Type Required Value
name string Yes The name of the import/export job.
type enum Yes Microsoft.ImportExport/jobs
apiVersion enum Yes 2016-11-01
location string No Specifies the supported Azure location where the job should be created
tags object No Specifies the tags that will be assigned to the job.
properties object Yes Specifies the job properties - JobDetails object

JobDetails object

Name Type Required Value
storageAccountId string No The resource identifier of the storage account where data will be imported to or exported from.
jobType string No The type of job
returnAddress object No Specifies the return address information for the job. - ReturnAddress object
returnShipping object No Specifies the return carrier and customer's account with the carrier. - ReturnShipping object
shippingInformation object No Contains information about the Microsoft datacenter to which the drives should be shipped. - ShippingInformation object
deliveryPackage object No Contains information about the package being shipped by the customer to the Microsoft data center. - PackageInfomation object
returnPackage object No Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. - PackageInfomation object
diagnosticsPath string No The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
logLevel string No Default value is Error. Indicates whether error logging or verbose logging will be enabled.
backupDriveManifest boolean No Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
state string No Current state of the job.
cancelRequested boolean No Indicates whether a request has been submitted to cancel the job.
percentComplete integer No Overall percentage completed for the job.
incompleteBlobListUri string No A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
driveList array No List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. - DriveStatus object
export object No A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. - Export object

ReturnAddress object

Name Type Required Value
recipientName string Yes The name of the recipient who will receive the hard drives when they are returned.
streetAddress1 string Yes The first line of the street address to use when returning the drives.
streetAddress2 string No The second line of the street address to use when returning the drives.
city string Yes The city name to use when returning the drives.
stateOrProvince string No The state or province to use when returning the drives.
postalCode string Yes The postal code to use when returning the drives.
countryOrRegion string Yes The country or region to use when returning the drives.
phone string Yes Phone number of the recipient of the returned drives.
email string Yes Email address of the recipient of the returned drives.

ReturnShipping object

Name Type Required Value
carrierName string Yes The carrier's name.
carrierAccountNumber string Yes The customer's account number with the carrier.

ShippingInformation object

Name Type Required Value
recipientName string Yes The name of the recipient who will receive the hard drives when they are returned.
streetAddress1 string Yes The first line of the street address to use when returning the drives.
streetAddress2 string No The second line of the street address to use when returning the drives.
city string Yes The city name to use when returning the drives.
stateOrProvince string Yes The state or province to use when returning the drives.
postalCode string Yes The postal code to use when returning the drives.
countryOrRegion string Yes The country or region to use when returning the drives.
phone string No Phone number of the recipient of the returned drives.

PackageInfomation object

Name Type Required Value
carrierName string Yes The name of the carrier that is used to ship the import or export drives.
trackingNumber string Yes The tracking number of the package.
driveCount integer Yes The number of drives included in the package.
shipDate string Yes The date when the package is shipped.

DriveStatus object

Name Type Required Value
driveId string No The drive's hardware serial number, without spaces.
bitLockerKey string No The BitLocker key used to encrypt the drive.
manifestFile string No The relative path of the manifest file on the drive.
manifestHash string No The Base16-encoded MD5 hash of the manifest file on the drive.
driveHeaderHash string No The drive header hash value.
state enum No The drive's current state. - Specified, Received, NeverReceived, Transferring, Completed, CompletedMoreInfo, ShippedBack
copyStatus string No Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.
percentComplete integer No Percentage completed for the drive.
verboseLogUri string No A URI that points to the blob containing the verbose log for the data transfer operation.
errorLogUri string No A URI that points to the blob containing the error log for the data transfer operation.
manifestUri string No A URI that points to the blob containing the drive manifest file.
bytesSucceeded integer No Bytes successfully transferred for the drive.

Export object

Name Type Required Value
blobList object No A list of the blobs to be exported. - ExportBlobList object
blobListblobPath string No The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root.

ExportBlobList object

Name Type Required Value
blobPath array No A collection of blob-path strings. - string
blobPathPrefix array No A collection of blob-prefix strings. - string