Skip to content

Commit

Permalink
[stg] update links > new REST API ref
Browse files Browse the repository at this point in the history
  • Loading branch information
mmacy committed Dec 16, 2016
1 parent 86ae4b6 commit 22e37e2
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ 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 `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`.
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/storageservices/importexport/Get-Job3) operation. The blob URI is returned in the `ManifestUri` property for each drive.
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
Expand Up @@ -19,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.
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/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 portal.
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)
10 changes: 5 additions & 5 deletions articles/storage/storage-import-export-creating-an-export-job.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ Creating an export job for the Microsoft Azure Import/Export service using the R

- 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.
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/storageservices/importexport/List-Locations2) 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.
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:

Expand All @@ -62,7 +62,7 @@ Follow the steps below to obtain the shipping location:
- 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/storageservices/importexport/Put-Job) operation. You will need to provide the following information:
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.

Expand All @@ -85,10 +85,10 @@ Follow the steps below to obtain the shipping location:
> 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.
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/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.
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)
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Preparing your drive involves:

## Obtaining Your Shipping Location

Before creating an import 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. 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.
Before creating an import job, you need to obtain a shipping location name and address by calling the [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:

Expand All @@ -70,7 +70,7 @@ Before creating an import job, you need to obtain a shipping location name and a
- 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 Import Job
To create the import job, call the [Put Job](/rest/api/storageservices/importexport/Put-Job) operation. You will need to provide the following information:
To create the import 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.

Expand Down Expand Up @@ -99,7 +99,7 @@ You must ship your drives to the address that you obtained from the previous ste
> You must ship your drives via a supported carrier service, which will provide a tracking number for your package.
## Updating the Import Job with Your Shipping Information
After you have your tracking number, call the [Update Job Properties](/rest/api/storageservices/importexport/Update-Job-Properties) operation to update the shipping carrier name, the tracking number for the job, and the carrier account number for return shipping. You can optionally specify the number of drives and the shipping date as well.
After you have your tracking number, call the [Update Job Properties](/api/storageimportexport/jobs#Jobs_Update) operation to update the shipping carrier name, the tracking number for the job, and the carrier account number for return shipping. You can optionally specify the number of drives and the shipping date as well.

## 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
Expand Up @@ -19,11 +19,11 @@ ms.author: renash
---

# Diagnostics and Error Recovery for Import-Export Jobs
For each drive processed, the Azure Import/Export service creates an error log in the associated storage account. You can also enable verbose logging by setting the `LogLevel` property to `Verbose` when calling the [Put Job](/rest/api/storageservices/importexport/Put-Job) or [Update Job Properties](/rest/api/storageservices/importexport/Update-Job-Properties) operations.
For each drive processed, the Azure Import/Export service creates an error log in the associated storage account. You can also enable verbose logging by setting the `LogLevel` property to `Verbose` when calling the [Put Job](/rest/api/storageimportexport/jobs#Jobs_CreateOrUpdate) or [Update Job Properties](/rest/api/storageimportexport/jobs#Jobs_Update) operations.

By default, logs are written to a container named `waimportexport`. You can specify a different name by setting the `DiagnosticsPath` property when calling the `Put Job` or `Update Job Properties` operations. The logs are stored as block blobs with the following naming convention: `waies/jobname_driveid_timestamp_logtype.xml`.

You can retrieve the URI of the logs for a job by calling the [Get Job](/rest/api/storageservices/importexport/Get-Job3) operation. The URI for the verbose log is returned in the `VerboseLogUri` property for each drive, while the URI for the error log is returned in the `ErrorLogUri` property.
You can retrieve the URI of the logs for a job by calling the [Get Job](/rest/api/storageimportexport/jobs#Jobs_Get) operation. The URI for the verbose log is returned in the `VerboseLogUri` property for each drive, while the URI for the error log is returned in the `ErrorLogUri` property.

You can use the logging data to identify the following issues:

Expand Down
2 changes: 1 addition & 1 deletion articles/storage/storage-import-export-enumerating-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ms.author: renash
---

# Enumerating Jobs
To enumerate all jobs in a subscription, call the [List Jobs](/rest/api/storageservices/importexport/List-Jobs3) operation. `List Jobs` returns a list of jobs as well as the following attributes:
To enumerate all jobs in a subscription, call the [List Jobs](/rest/api/storageimportexport/jobs#Jobs_List) operation. `List Jobs` returns a list of jobs as well as the following attributes:

- The type of job (Import or Export)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ms.author: renash
---

# Retrieving State Information for a Job
You can call the [Get Job](/rest/api/storageservices/importexport/Get-Job3) operation to retrieve information about both import and export jobs. The information returned includes:
You can call the [Get Job](/rest/api/storageimportexport/jobs#Jobs_Get) operation to retrieve information about both import and export jobs. The information returned includes:

- The current status of the job.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Requests to the Import/Export service must specify the `api-version` parameter a
[Diagnostics and Error Recovery for Import-Export Jobs](storage-import-export-diagnostics-and-error-recovery.md)

## See Also
[Storage Import/Export REST](/rest/api/storageservices/importexport/Storage-Import-Export-Service-REST-API-Reference)
[Storage Import/Export REST](/rest/api/storageimportexport)

0 comments on commit 22e37e2

Please sign in to comment.