Import/Export Service Log File Format

When the Microsoft Azure Import/Export service performs an action on a drive as part of an import job or an export job, logs are written to block blobs in the storage account associated with that job.

There are two logs that may be written by the Import/Export service:

• The error log is always generated in the event of an error.

• The verbose log is not enabled by default, but may be enabled by setting the EnableVerboseLog property on a Put Job or Update Job Properties operation.

Log File Location

The logs are written to block blobs in the container or virtual directory specified by the ImportExportStatesPath setting, which you can set on a Put Job operation. The location to which the logs are written depends on how authentication is specified for the job, together with the value specified for ImportExportStatesPath. Authentication for the job may be specified via a storage account key, or a container SAS (shared access signature).

The name of the container or virtual directory may either be the default name of waimportexport, or another container or virtual directory name that you specify.

The table below shows the possible options:

You can retrieve the URl for the error and verbose logs by calling the Get Job operation. The logs are available after processing of the drive is complete.

Log File Format

The format for both logs is the same: a blob containing XML descriptions of the events that occurred while copying blobs between the hard drive and the customer's account.

The verbose log contains complete information about the status of the copy operation for every blob (for an import job) or file (for an export job), whereas the error log contains only the information for blobs or files that encountered errors during the import or export job.

The verbose log format is shown below. The error log has the same structure, but filters out successful operations.

<DriveLog Version="2014-11-01">
    <DriveId>drive-id</DriveId>
    [<Blob Status="blob-status">
       <BlobPath>blob-path</BlobPath>
       <FilePath>file-path</FilePath>
       [<Snapshot>snapshot</Snapshot>]
       <Length>length</Length>
       [<LastModified>last-modified</LastModified>]
       [<ImportDisposition Status="import-disposition-status">import-disposition</ImportDisposition>]
       [page-range-list-or-block-list]
       [metadata-status]
       [properties-status]
    </Blob>]
    [<Blob>
    . . .
    </Blob>]
    <Status>drive-status</Status>
</DriveLog>

page-range-list-or-block-list ::= 
  page-range-list | block-list

page-range-list ::= 
<PageRangeList>
      [<PageRange Offset="page-range-offset" Length="page-range-length" 
       [Hash="md5-hash"] Status="page-range-status"/>]
      [<PageRange Offset="page-range-offset" Length="page-range-length" 
       [Hash="md5-hash"] Status="page-range-status"/>]
</PageRangeList>

block-list ::=
<BlockList>
      [<Block Offset="block-offset" Length="block-length" [Id="block-id"]
       [Hash="md5-hash"] Status="block-status"/>]
      [<Block Offset="block-offset" Length="block-length" [Id="block-id"] 
       [Hash="md5-hash"] Status="block-status"/>]
</BlockList>

metadata-status ::=
<Metadata Status="metadata-status">
   [<GlobalPath Hash="md5-hash">global-metadata-file-path</GlobalPath>]
   [<Path Hash="md5-hash">metadata-file-path</Path>]
</Metadata>

properties-status ::=
<Properties Status="properties-status">
   [<GlobalPath Hash="md5-hash">global-properties-file-path</GlobalPath>]
   [<Path Hash="md5-hash">properties-file-path</Path>]
</Properties>

The following table describes the elements of the log file.

Drive Status Codes

The following table lists the status codes for processing a drive.

Blob Status Codes

The following table lists the status codes for processing a blob.

Import Disposition Status Codes

The following table lists the status codes for resolving an import disposition.

Page Range/Block Status Codes

The following table lists the status codes for processing a page range or a block.

Metadata Status Codes

The following table lists the status codes for processing blob metadata.

Properties Status Codes

The following table lists the status codes for processing blob properties.

Sample Logs

The following is an example of verbose log.

<?xml version="1.0" encoding="UTF-8"?>
<DriveLog Version="2014-11-01">
    <DriveId>WD-WMATV123456</DriveId>
    <Blob Status="Completed">
       <BlobPath>pictures/bob/wild/desert.jpg</BlobPath>
       <FilePath>\Users\bob\Pictures\wild\desert.jpg</FilePath>
       <Length>98304</Length>
       <ImportDisposition Status="Created">overwrite</ImportDisposition>
       <BlockList>
          <Block Offset="0" Length="65536" Id="AAAAAA==" Hash=" 9C8AE14A55241F98533C4D80D85CDC68" Status="Completed"/>
          <Block Offset="65536" Length="32768" Id="AQAAAA==" Hash=" DF54C531C9B3CA2570FDDDB3BCD0E27D" Status="Completed"/>
       </BlockList>
       <Metadata Status="Completed">
          <GlobalPath Hash=" E34F54B7086BCF4EC1601D056F4C7E37">\Users\bob\Pictures\wild\metadata.xml</GlobalPath>
       </Metadata>
    </Blob>
    <Blob Status="CompletedWithErrors">
       <BlobPath>pictures/bob/animals/koala.jpg</BlobPath>
       <FilePath>\Users\bob\Pictures\animals\koala.jpg</FilePath>
       <Length>163840</Length>
       <ImportDisposition Status="Overwritten">overwrite</ImportDisposition>
       <PageRangeList>
          <PageRange Offset="0" Length="65536" Hash="19701B8877418393CB3CB567F53EE225" Status="Completed"/>
          <PageRange Offset="65536" Length="65536" Hash="AA2585F6F6FD01C4AD4256E018240CD4" Status="Corrupted"/>
          <PageRange Offset="131072" Length="4096" Hash="9BA552E1C3EEAFFC91B42B979900A996" Status="Completed"/>
       </PageRangeList>
       <Properties Status="Completed">
          <Path Hash="38D7AE80653F47F63C0222FEE90EC4E7">\Users\bob\Pictures\animals\koala.jpg.properties</Path>
       </Properties>
    </Blob>
    <Status>CompletedWithErrors</Status>
</DriveLog>

The corresponding error log is shown below.

<?xml version="1.0" encoding="UTF-8"?>
<DriveLog Version="2014-11-01">
    <DriveId>WD-WMATV6965824</DriveId>
    <Blob Status="CompletedWithErrors">
       <BlobPath>pictures/bob/animals/koala.jpg</BlobPath>
       <FilePath>\Users\bob\Pictures\animals\koala.jpg</FilePath>
       <Length>163840</Length>
       <ImportDisposition Status="Overwritten">overwrite</ImportDisposition>
       <PageRangeList>
          <PageRange Offset="65536" Length="65536" Hash="AA2585F6F6FD01C4AD4256E018240CD4" Status="Corrupted"/>
       </PageRangeList>
    </Blob>
    <Status>CompletedWithErrors</Status>
</DriveLog>

The follow error log for an import job contains an error about a file not found on the import drive. Note that the status of subsequent components is Cancelled.

<?xml version="1.0" encoding="utf-8"?>
<DriveLog Version="2014-11-01">
  <DriveId>9WM35C2V</DriveId>
  <Blob Status="FileNotFound">
    <BlobPath>pictures/animals/koala.jpg</BlobPath>
    <FilePath>\animals\koala.jpg</FilePath>
    <Length>30310</Length>
    <ImportDisposition Status="Cancelled">rename</ImportDisposition>
    <BlockList>
      <Block Offset="0" Length="6062" Id="MD5/cAzn4h7VVSWXf696qp5Uaw==" Hash="700CE7E21ED55525977FAF7AAA9E546B" Status="Cancelled" />
      <Block Offset="6062" Length="6062" Id="MD5/PEnGwYOI8LPLNYdfKr7kAg==" Hash="3C49C6C18388F0B3CB35875F2ABEE402" Status="Cancelled" />
      <Block Offset="12124" Length="6062" Id="MD5/FG4WxqfZKuUWZ2nGTU2qVA==" Hash="146E16C6A7D92AE5166769C64D4DAA54" Status="Cancelled" />
      <Block Offset="18186" Length="6062" Id="MD5/ZzibNDzr3IRBQENRyegeXQ==" Hash="67389B343CEBDC8441404351C9E81E5D" Status="Cancelled" />
      <Block Offset="24248" Length="6062" Id="MD5/ZzibNDzr3IRBQENRyegeXQ==" Hash="67389B343CEBDC8441404351C9E81E5D" Status="Cancelled" />
    </BlockList>
  </Blob>
  <Status>CompletedWithErrors</Status>
</DriveLog>

The following error log for an export job indicates that the blob content has been successfully written to the drive, but that an error occurred while exporting the blob's properties.

<?xml version="1.0" encoding="utf-8"?>
<DriveLog Version="2014-11-01">
  <DriveId>9WM35C3U</DriveId>
  <Blob Status="CompletedWithErrors">
    <BlobPath>pictures/wild/canyon.jpg</BlobPath>
    <FilePath>\pictures\wild\canyon.jpg</FilePath>
    <LastModified>2012-09-18T23:47:08Z</LastModified>
    <Length>163840</Length>
    <BlockList />
    <Properties Status="Failed" />
  </Blob>
  <Status>CompletedWithErrors</Status>
</DriveLog>

See Also

Storage Import/Export Service REST API Reference