Skip to content

Commit

Permalink
Merge pull request MicrosoftDocs#2988 from mmacy/stg-using-impexp-res…
Browse files Browse the repository at this point in the history
…tapi

[stg] using import/export rest api updates
  • Loading branch information
v-thepet authored Dec 19, 2016
2 parents 6be3323 + 22e37e2 commit 9921a84
Show file tree
Hide file tree
Showing 9 changed files with 353 additions and 361 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Backing up drive manifests | MicrosoftDocs
description: Learn how to automatically have your drive manifests for the Microsoft Azure Import-Export Service backed up.
title: Backing up Azure Import/Export drive manifests | MicrosoftDocs
description: Learn how to have your drive manifests for the Microsoft Azure Import/Export service backed-up automatically.
author: renashahmsft
manager: aungoo
editor: tysonn
Expand All @@ -9,19 +9,19 @@ documentationcenter: ''

ms.assetid: 594abd80-b834-4077-a474-d8a0f4b7928a
ms.service: storage
ms.workload: storage
ms.workload: storage
ms.tgt_pltfrm: na
ms.devlang: na
ms.topic: article
ms.date: 05/25/2015
ms.date: 12/16/2016
ms.author: renash

---

# Backing Up Drive Manifests
Drive manifests can be automatically backed up to blobs by setting the `BackupDriveManifest` property to `true` in the [Put Job](/rest/api/storageservices/importexport/Put-Job) or [Update Job Properties](/rest/api/storageservices/importexport/Update-Job-Properties) operations. By default the drive manifests are not backed up. The drive manifest backups are stored as block blobs in a container within the storage account associated with the job. By default, the container name is `waimportexport`, but you can specify a different name in the `ImportExportStatesPath` property when calling the `Put Job` or `Update Job Properties` operations. The backup manifest blob are named in the following format: `waies/jobname_driveid_timestamp_manifest.xml`.
You can retrieve the URI of the backup drive manifests for a job by calling the [Get Job](/rest/api/storageservices/importexport/Get-Job3) operation. The blob URI is returned in the `ManifestUri` property for each drive.
## See Also
[Using the Import/Export Service REST API](storage-import-export-using-the-rest-api.md)
Drive manifests can be automatically backed-up to blobs by setting the `BackupDriveManifest` property to `true` in the [Put Job](/rest/api/storageimportexport/jobs#Jobs_CreateOrUpdate) or [Update Job Properties](/rest/api/storageimportexport/jobs#Jobs_Update) operations. By default the drive manifests are not backed up. The drive manifest backups are stored as block blobs in a container within the storage account associated with the job. By default, the container name is `waimportexport`, but you can specify a different name in the `DiagnosticsPath` property when calling the `Put Job` or `Update Job Properties` operations. The backup manifest blob are named in the following format: `waies/jobname_driveid_timestamp_manifest.xml`.

You can retrieve the URI of the backup drive manifests for a job by calling the [Get Job](/rest/api/storageimportexport/jobs#Jobs_Get) operation. The blob URI is returned in the `ManifestUri` property for each drive.

## See Also
[Using the Import/Export service REST API](storage-import-export-using-the-rest-api.md)
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---


title: Cancelling and Deleting Jobs | Microsoft Docs
description: Learn how to cancel and delete jobs for the Microsoft Azure Import-Export Service
title: Canceling and deleting Azure Import/Export service jobs | Microsoft Docs
description: Learn how to cancel and delete jobs for the Microsoft Azure Import/Export service
author: renashahmsft
manager: aungoo
editor: tysonn
Expand All @@ -11,7 +9,7 @@ documentationcenter: ''

ms.assetid: fd3d66f0-1dbb-4c75-9223-307d5abaeefc
ms.service: storage
ms.workload: storage
ms.workload: storage
ms.tgt_pltfrm: na
ms.devlang: na
ms.topic: article
Expand All @@ -21,11 +19,11 @@ ms.author: renash
---

# Cancelling and Deleting Jobs
You can request that a job be cancelled before it is in the `Packaging` state by calling the [Update Job Properties](/rest/api/storageservices/importexport/Update-Job-Properties) operation and setting the `CancelRequested` element to `true`. The job will be cancelled on a best-effort basis. If drives are in the process of transferring data, data may continue to be transferred even after cancellation has been requested.
A cancelled job will move to the `Completed` state and be kept for 90 days, at which point it will be deleted.
To delete a job, call the [Delete Job](/rest/api/storageservices/importexport/Delete-Job1) operation before the job has shipped (*i.e.*, while the job is in the `Creating` state). You can also delete a job when it is in the `Completed` state. After a job has been deleted, its information and status are no longer accessible via the REST API or the Azure Management Portal.
## See Also
[Using the Import/Export Service REST API](storage-import-export-using-the-rest-api.md)
You can request that a job be cancelled before it is in the `Packaging` state by calling the [Update Job Properties](/rest/api/storageimportexport/jobs#Jobs_Update) operation and setting the `CancelRequested` element to `true`. The job will be cancelled on a best-effort basis. If drives are in the process of transferring data, data may continue to be transferred even after cancellation has been requested.

A cancelled job will move to the `Completed` state and be kept for 90 days, at which point it will be deleted.

To delete a job, call the [Delete Job](/rest/api/storageimportexport/jobs#Jobs_Delete) operation before the job has shipped (*i.e.*, while the job is in the `Creating` state). You can also delete a job when it is in the `Completed` state. After a job has been deleted, its information and status are no longer accessible via the REST API or the Azure portal.

## See Also
[Using the Import/Export service REST API](storage-import-export-using-the-rest-api.md)
157 changes: 76 additions & 81 deletions articles/storage/storage-import-export-creating-an-export-job.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating an Export Job | Microsoft Docs
description: Learn how to create an export job for the Microsoft Azure Import-Export Service
title: Creating an Export Job for the Azure Import/Export service | Microsoft Docs
description: Learn how to create an export job for the Microsoft Azure Import/Export service
author: renashahmsft
manager: aungoo
editor: tysonn
Expand All @@ -9,91 +9,86 @@ documentationcenter: ''

ms.assetid: 613d480b-a8ef-4b28-8f54-54174d59b3f4
ms.service: storage
ms.workload: storage
ms.workload: storage
ms.tgt_pltfrm: na
ms.devlang: na
ms.topic: article
ms.date: 05/25/2015
ms.date: 12/16/2016
ms.author: renash

---

# Creating an Export Job
Creating an export job for the Microsoft Azure Import/Export service using the REST API involves the following steps:

- Selecting the blobs to export.

- Obtaining a shipping location.

- Creating the export job.

- Shipping your empty drives to Microsoft via a supported carrier service.

- Updating the export job with the package information.

- Receiving the drives back from Microsoft.

See [Using the Windows Azure Import/Export Service to Transfer Data to Blob Storage](storage-import-export-service.md) for an overview of the Import/Export service and a tutorial that demonstrates how to use the [Microsoft Azure classic portal](http://manage.windowsazure.com/) to create and manage import and export jobs.

## Selecting Blobs to Export
To create an export job, you will need to provide a list of blobs that you want to export from your storage account. There are a few ways to select blobs to be exported:

- You can use a relative blob path to select a single blob and all of its snapshots.

- You can use a relative blob path to select a single blob excluding its snapshots.

- You can use a relative blob path and a snapshot time to select a single snapshot.

- You can use a blob prefix to select all blobs and snapshots with the given prefix.

- You can export all blobs and snapshots in the storage account.

For more information about specifying blobs to export, see the [Put Job](/rest/api/storageservices/importexport/Put-Job) operation.

## Obtaining Your Shipping Location
Before creating an export job, you need to obtain a shipping location name and address by calling the [List Locations](/rest/api/storageservices/importexport/List-Locations2) operation. `List Locations` will return a list of locations and their mailing addresses based on the location of your storage account. You can select a location from the returned list and ship your hard drives to that address. Note that `List Locations` may return only one possible shipping location.

Follow the steps below to obtain the shipping location:

- Identify the name of the location of your storage account. This value can be found under the **Location** field on the storage account’s **Dashboard** in the classic portal or queried for by using the service management API operation [Get Storage Account Properties](/rest/api/storagerp/storageaccounts#StorageAccounts_GetProperties).

- Retrieve a list of locations that are available to process this storage account by calling the `List Locations` operation with the query parameter `originlocation=<location-name>`. The list returned will contain one or more locations to which you can ship your drives.

- Select a location from the returned list and note its name and mailing address.

> [!NOTE]
> For the preview release, `List Locations` will return one location, or none. If no locations are returned, the service is not yet available for your storage account.
## Creating the Export Job
To create the export job, call the [Put Job](/rest/api/storageservices/importexport/Put-Job) operation. You will need to provide the following information:

- A name for the job.

- The storage account name.

- The storage account key.

- The shipping location name, obtained in the previous step.

- A job type (Export).

- The return address where the drives should be sent after the export job has completed.

- The list of blobs (or blob prefixes) to be exported.

## Shipping Your Drives
Next, use the Azure Import/Export tool to determine the number of drives you need to send, based on the blobs you have selected to be exported and the drive size. See the [Azure Import-Export Tool Reference](storage-import-export-tool-how-to-v1.md) for details.

Package the drives in a single package and ship them to the address obtained in the earlier step. Note the tracking number of your package for the next step.

Creating an export job for the Microsoft Azure Import/Export service using the REST API involves the following steps:

- Selecting the blobs to export.

- Obtaining a shipping location.

- Creating the export job.

- Shipping your empty drives to Microsoft via a supported carrier service.

- Updating the export job with the package information.

- Receiving the drives back from Microsoft.

See [Using the Windows Azure Import/Export service to Transfer Data to Blob Storage](storage-import-export-service.md) for an overview of the Import/Export service and a tutorial that demonstrates how to use the [Azure portal](https://portal.azure.com/) to create and manage import and export jobs.

## Selecting Blobs to Export
To create an export job, you will need to provide a list of blobs that you want to export from your storage account. There are a few ways to select blobs to be exported:

- You can use a relative blob path to select a single blob and all of its snapshots.

- You can use a relative blob path to select a single blob excluding its snapshots.

- You can use a relative blob path and a snapshot time to select a single snapshot.

- You can use a blob prefix to select all blobs and snapshots with the given prefix.

- You can export all blobs and snapshots in the storage account.

For more information about specifying blobs to export, see the [Put Job](/rest/api/storageimportexport/jobs#Jobs_CreateOrUpdate) operation.

## Obtaining Your Shipping Location
Before creating an export job, you need to obtain a shipping location name and address by calling the [Get Location](https://portal.azure.com) or [List Locations](/rest/api/storageimportexport/listlocations) operation. `List Locations` will return a list of locations and their mailing addresses. You can select a location from the returned list and ship your hard drives to that address. You can also use the `Get Location` operation to obtain the shipping address for a specific location directly.

Follow the steps below to obtain the shipping location:

- Identify the name of the location of your storage account. This value can be found under the **Location** field on the storage account’s **Dashboard** in the classic portal or queried for by using the service management API operation [Get Storage Account Properties](/rest/api/storagerp/storageaccounts#StorageAccounts_GetProperties).

- Retrieve the location that are available to process this storage account by calling the `Get Location` operation.

- If the `AlternateLocations` property of the location contains the location itself, then it is okay to use this location. Otherwise, call the `Get Location` operation again with one of the alternate locations. The original location might be temporarily closed for maintenance.

## Creating the Export Job
To create the export job, call the [Put Job](/rest/api/storageimportexport/jobs#Jobs_CreateOrUpdate) operation. You will need to provide the following information:

- A name for the job.

- The storage account name.

- The shipping location name, obtained in the previous step.

- A job type (Export).

- The return address where the drives should be sent after the export job has completed.

- The list of blobs (or blob prefixes) to be exported.

## Shipping Your Drives
Next, use the Azure Import/Export tool to determine the number of drives you need to send, based on the blobs you have selected to be exported and the drive size. See the [Azure Import-Export Tool Reference](storage-import-export-tool-how-to-v1.md) for details.

Package the drives in a single package and ship them to the address obtained in the earlier step. Note the tracking number of your package for the next step.

> [!NOTE]
> You must ship your drives via a supported carrier service, which will provide a tracking number for your package.
## Updating the Export Job with Your Package Information
After you have your tracking number, call the [Update Job Properties](/rest/api/storageservices/importexport/Update-Job-Properties) operation to updated the carrier name and tracking number for the job. You can optionally specify the number of drives, the return address, and the shipping date as well.
## Receiving the Package
After your export job has been processed, your drives will be returned to you with your encrypted data. You can retrieve the BitLocker key for each of the drives by calling the [Get Job](/rest/api/storageservices/importexport/Get-Job3) operation. You can then unlock the drive using the key. The drive manifest file on each drive contains the list of files on the drive, as well as the original blob address for each file.
## See Also
[Using the Import/Export Service REST API](storage-import-export-using-the-rest-api.md)
> You must ship your drives via a supported carrier service, which will provide a tracking number for your package.
## Updating the Export Job with Your Package Information
After you have your tracking number, call the [Update Job Properties](/rest/api/storageimportexport/jobs#Jobs_Update) operation to updated the carrier name and tracking number for the job. You can optionally specify the number of drives, the return address, and the shipping date as well.

## Receiving the Package
After your export job has been processed, your drives will be returned to you with your encrypted data. You can retrieve the BitLocker key for each of the drives by calling the [Get Job](/rest/api/storageimportexport/jobs#Jobs_Get) operation. You can then unlock the drive using the key. The drive manifest file on each drive contains the list of files on the drive, as well as the original blob address for each file.

## See Also
[Using the Import/Export service REST API](storage-import-export-using-the-rest-api.md)
Loading

0 comments on commit 9921a84

Please sign in to comment.