Jobs - Get

Gets information about an existing job.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}?api-version=2020-08-01

URI Parameters

Name In Required Type Description
jobName
path True
  • string

The name of the import/export job.

resourceGroupName
path True
  • string

The resource group name uniquely identifies the resource group within the user subscription.

subscriptionId
path True
  • string

The subscription ID for the Azure user.

api-version
query True
  • string

Specifies the API version to use for this request.

Request Header

Name Required Type Description
Accept-Language
  • string

Specifies the preferred language for the response.

Responses

Name Type Description
200 OK

OK

Other Status Codes

An error occurs.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get export job
Get import job

Get export job

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myJob?api-version=2020-08-01

Sample Response

{
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "properties": {
    "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test",
    "jobType": "Export",
    "returnAddress": {
      "recipientName": "Test",
      "streetAddress1": "Street1",
      "streetAddress2": "street2",
      "city": "Redmond",
      "stateOrProvince": "wa",
      "postalCode": "98007",
      "countryOrRegion": "USA",
      "phone": "4250000000",
      "email": "Test@contoso.com"
    },
    "returnShipping": {
      "carrierName": "FedEx",
      "carrierAccountNumber": "989ffff"
    },
    "shippingInformation": {
      "recipientName": "Microsoft Azure Import/Export Service",
      "streetAddress1": "2045 Lafayette Street",
      "streetAddress2": "",
      "city": "Santa Clara",
      "stateOrProvince": "CA",
      "postalCode": "95050",
      "countryOrRegion": "USA",
      "phone": "408 0000 0000",
      "additionalInformation": ""
    },
    "diagnosticsPath": "waimportexport",
    "logLevel": "Verbose",
    "backupDriveManifest": true,
    "cancelRequested": false,
    "state": "Creating",
    "driveList": [],
    "export": {
      "blobList": {
        "blobPathPrefix": [
          "/"
        ]
      }
    },
    "provisioningState": "Succeeded",
    "encryptionKey": {
      "kekType": "MicrosoftManaged"
    }
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/test",
  "name": "myJob",
  "type": "Microsoft.ImportExport/jobs",
  "location": "West US"
}

Get import job

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myJob?api-version=2020-08-01

Sample Response

{
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "properties": {
    "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test",
    "jobType": "Import",
    "returnAddress": {
      "recipientName": "Test",
      "streetAddress1": "Street1",
      "streetAddress2": "street2",
      "city": "Redmond",
      "stateOrProvince": "wa",
      "postalCode": "98007",
      "countryOrRegion": "USA",
      "phone": "4250000000",
      "email": "Test@contoso.com"
    },
    "returnShipping": {
      "carrierName": "FedEx",
      "carrierAccountNumber": "989ffff"
    },
    "shippingInformation": {
      "recipientName": "Microsoft Azure Import/Export Service",
      "streetAddress1": "2045 Lafayette Street",
      "streetAddress2": "",
      "city": "Santa Clara",
      "stateOrProvince": "CA",
      "postalCode": "95050",
      "countryOrRegion": "USA",
      "phone": "408 0000 0000",
      "additionalInformation": ""
    },
    "diagnosticsPath": "waimportexport",
    "logLevel": "Verbose",
    "backupDriveManifest": true,
    "cancelRequested": false,
    "state": "Creating",
    "driveList": [
      {
        "driveId": "9CA995BB",
        "manifestFile": "\\DriveManifest.xml",
        "manifestHash": "109B21108597EF36D5785F08303F3638",
        "driveHeaderHash": "",
        "state": "Specified"
      }
    ],
    "provisioningState": "Succeeded",
    "encryptionKey": {
      "kekType": "MicrosoftManaged"
    }
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/test",
  "name": "myJob",
  "type": "Microsoft.ImportExport/jobs",
  "location": "West US"
}

Definitions

createdByType

The type of identity that created the resource.

DeliveryPackageInformation

Contains information about the delivery package being shipped by the customer to the Microsoft data center.

Details

Describes the error details if present.

DriveState

The drive's current state.

DriveStatus

Provides information about the drive's status

EncryptionKekType

The type of kek encryption key

EncryptionKeyDetails

Specifies the encryption key properties

ErrorResponse

Response when errors occurred

Export

A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.

IdentityDetails

Specifies the identity properties.

IdentityType

The type of identity

JobDetails

Specifies the job properties

JobResponse

Contains the job information.

PackageInformation

Contains information about the package being shipped by the customer to the Microsoft data center.

ReturnAddress

Specifies the return address information for the job.

ReturnShipping

Specifies the return carrier and customer's account with the carrier.

ShippingInformation

Contains information about the Microsoft datacenter to which the drives should be shipped.

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DeliveryPackageInformation

Contains information about the delivery package being shipped by the customer to the Microsoft data center.

Name Type Description
carrierName
  • string

The name of the carrier that is used to ship the import or export drives.

driveCount
  • integer

The number of drives included in the package.

shipDate
  • string

The date when the package is shipped.

trackingNumber
  • string

The tracking number of the package.

Details

Describes the error details if present.

Name Type Description
code
  • string

Provides information about the error code.

message
  • string

Provides information about the error message.

target
  • string

Provides information about the error target.

DriveState

The drive's current state.

Name Type Description
Completed
  • string
CompletedMoreInfo
  • string
NeverReceived
  • string
Received
  • string
ShippedBack
  • string
Specified
  • string
Transferring
  • string

DriveStatus

Provides information about the drive's status

Name Type Description
bitLockerKey
  • string

The BitLocker key used to encrypt the drive.

bytesSucceeded
  • integer

Bytes successfully transferred for the drive.

copyStatus
  • string

Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.

driveHeaderHash
  • string

The drive header hash value.

driveId
  • string

The drive's hardware serial number, without spaces.

errorLogUri
  • string

A URI that points to the blob containing the error log for the data transfer operation.

manifestFile
  • string

The relative path of the manifest file on the drive.

manifestHash
  • string

The Base16-encoded MD5 hash of the manifest file on the drive.

manifestUri
  • string

A URI that points to the blob containing the drive manifest file.

percentComplete
  • integer

Percentage completed for the drive.

state

The drive's current state.

verboseLogUri
  • string

A URI that points to the blob containing the verbose log for the data transfer operation.

EncryptionKekType

The type of kek encryption key

Name Type Description
CustomerManaged
  • string
MicrosoftManaged
  • string

EncryptionKeyDetails

Specifies the encryption key properties

Name Type Description
kekType

The type of kek encryption key

kekUrl
  • string

Specifies the url for kek encryption key.

kekVaultResourceID
  • string

Specifies the keyvault resource id for kek encryption key.

ErrorResponse

Response when errors occurred

Name Type Description
error.code
  • string

Provides information about the error code.

error.details

Describes the error details if present.

error.innererror
  • object

Inner error object if present.

error.message
  • string

Provides information about the error message.

error.target
  • string

Provides information about the error target.

Export

A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.

Name Type Description
blobList.blobPath
  • string[]

A collection of blob-path strings.

blobList.blobPathPrefix
  • string[]

A collection of blob-prefix strings.

blobListBlobPath
  • string

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.

IdentityDetails

Specifies the identity properties.

Name Type Description
principalId
  • string

Specifies the principal id for the identity for the job.

tenantId
  • string

Specifies the tenant id for the identity for the job.

type

The type of identity

IdentityType

The type of identity

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

JobDetails

Specifies the job properties

Name Type Description
backupDriveManifest
  • boolean

Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.

cancelRequested
  • boolean

Indicates whether a request has been submitted to cancel the job.

deliveryPackage

Contains information about the package being shipped by the customer to the Microsoft data center.

diagnosticsPath
  • string

The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.

driveList

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.

encryptionKey

Contains information about the encryption key.

export

A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.

incompleteBlobListUri
  • string

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.

jobType
  • string

The type of job

logLevel
  • string

Default value is Error. Indicates whether error logging or verbose logging will be enabled.

percentComplete
  • integer

Overall percentage completed for the job.

provisioningState
  • string

Specifies the provisioning state of the job.

returnAddress

Specifies the return address information for the job.

returnPackage

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.

returnShipping

Specifies the return carrier and customer's account with the carrier.

shippingInformation

Contains information about the Microsoft datacenter to which the drives should be shipped.

state
  • string

Current state of the job.

storageAccountId
  • string

The resource identifier of the storage account where data will be imported to or exported from.

JobResponse

Contains the job information.

Name Type Description
id
  • string

Specifies the resource identifier of the job.

identity

Specifies the job identity details

location
  • string

Specifies the Azure location where the job is created.

name
  • string

Specifies the name of the job.

properties

Specifies the job properties

systemData

SystemData of ImportExport Jobs.

tags
  • object

Specifies the tags that are assigned to the job.

type
  • string

Specifies the type of the job resource.

PackageInformation

Contains information about the package being shipped by the customer to the Microsoft data center.

Name Type Description
carrierName
  • string

The name of the carrier that is used to ship the import or export drives.

driveCount
  • integer

The number of drives included in the package.

shipDate
  • string

The date when the package is shipped.

trackingNumber
  • string

The tracking number of the package.

ReturnAddress

Specifies the return address information for the job.

Name Type Description
city
  • string

The city name to use when returning the drives.

countryOrRegion
  • string

The country or region to use when returning the drives.

email
  • string

Email address of the recipient of the returned drives.

phone
  • string

Phone number of the recipient of the returned drives.

postalCode
  • string

The postal code to use when returning the drives.

recipientName
  • string

The name of the recipient who will receive the hard drives when they are returned.

stateOrProvince
  • string

The state or province to use when returning the drives.

streetAddress1
  • string

The first line of the street address to use when returning the drives.

streetAddress2
  • string

The second line of the street address to use when returning the drives.

ReturnShipping

Specifies the return carrier and customer's account with the carrier.

Name Type Description
carrierAccountNumber
  • string

The customer's account number with the carrier.

carrierName
  • string

The carrier's name.

ShippingInformation

Contains information about the Microsoft datacenter to which the drives should be shipped.

Name Type Description
additionalInformation
  • string

Additional shipping information for customer, specific to datacenter to which customer should send their disks.

city
  • string

The city name to use when returning the drives.

countryOrRegion
  • string

The country or region to use when returning the drives.

phone
  • string

Phone number of the recipient of the returned drives.

postalCode
  • string

The postal code to use when returning the drives.

recipientName
  • string

The name of the recipient who will receive the hard drives when they are returned.

stateOrProvince
  • string

The state or province to use when returning the drives.

streetAddress1
  • string

The first line of the street address to use when returning the drives.

streetAddress2
  • string

The second line of the street address to use when returning the drives.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC).

createdBy
  • string

The identity that created the resource.

createdByType

The type of identity that created the resource.

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

The identity that last modified the resource.

lastModifiedByType

The type of identity that last modified the resource.