Microsoft.ImportExport (preview:2021-01-01)

2025/09/19 • 10 new, 10 deleted methods

Locations_List (new)
Description :  Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/locations
{
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: locations ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource identifier of the location. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the location. Use List Locations to get all supported locations. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the location. ,
Required: False ,
}
string ,
properties:
{
Description: location properties ,
Required: False ,
}
{
recipientName:
{
Description: The recipient name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number for the Azure data center. ,
Required: False ,
}
string ,
additionalShippingInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
supportedCarriers:
{
Description: A list of carriers that are supported at this location. ,
Required: False ,
}
[
string ,
]
,
alternateLocations:
{
Description: A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Locations_Get (new)
Description :  Returns the details about a location to which you can ship the disks associated with an import or export job. A location is an Azure region.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/locations/{locationName}
{
locationName:
{
Description: The name of the location. For example, West US or westus. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Specifies the resource identifier of the location. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the location. Use List Locations to get all supported locations. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the location. ,
Required: False ,
}
string ,
properties:
{
Description: location properties ,
Required: False ,
}
{
recipientName:
{
Description: The recipient name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number for the Azure data center. ,
Required: False ,
}
string ,
additionalShippingInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
supportedCarriers:
{
Description: A list of carriers that are supported at this location. ,
Required: False ,
}
[
string ,
]
,
alternateLocations:
{
Description: A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_ListBySubscription (new)
Description :  Returns all active and completed jobs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs
{
$top:
{
Description: An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: Can be used to restrict the results to certain conditions. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: link to next batch of jobs ,
Required: False ,
}
string ,
value:
{
Description: Job list ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_ListByResourceGroup (new)
Description :  Returns all active and completed jobs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs
{
$top:
{
Description: An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: Can be used to restrict the results to certain conditions. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: link to next batch of jobs ,
Required: False ,
}
string ,
value:
{
Description: Job list ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Get (new)
Description :  Gets information about an existing job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Update (new)
Description :  Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
body:
{
Description: The parameters to update in the job ,
Required: True ,
}
{
tags:
{
Description: Specifies the tags that will be assigned to the job ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the properties of a UpdateJob. ,
Required: False ,
}
{
cancelRequested:
{
Description: If specified, the value must be true. The service will attempt to cancel the job. ,
Required: False ,
}
boolean ,
state:
{
Description: If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
logLevel:
{
Description: Indicates whether error logging or verbose logging is enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
driveList:
{
Description: List of drives that comprise the job. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Create (new)
Description :  Creates a new job or updates an existing job in the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
x-ms-client-tenant-id:
{
Description: The tenant ID of the client making the request. ,
Required: False ,
}
string ,
body:
{
Description: The parameters used for creating the job ,
Required: True ,
}
{
location:
{
Description: Specifies the supported Azure location where the job should be created ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that will be assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Delete (new)
Description :  Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
BitLockerKeys_List (new)
Description :  Returns the BitLocker Keys for all drives in the specified job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: drive status ,
Required: False ,
}
[
{
bitLockerKey:
{
Description: BitLocker recovery key or password ,
Required: False ,
}
string ,
driveId:
{
Description: Drive ID ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Operations_List (new)
Description :  Returns the list of operations supported by the import/export resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/operations
{
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: operations ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: True ,
}
string ,
display:
{
Description: operation display properties ,
Required: True ,
}
{
provider:
{
Description: The resource provider name to which the operation belongs. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource to which the operation belongs. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Locations_List (removed)
Description :  Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/locations
{
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: locations ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource identifier of the location. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the location. Use List Locations to get all supported locations. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the location. ,
Required: False ,
}
string ,
properties:
{
Description: location properties ,
Required: False ,
}
{
recipientName:
{
Description: The recipient name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number for the Azure data center. ,
Required: False ,
}
string ,
additionalShippingInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
supportedCarriers:
{
Description: A list of carriers that are supported at this location. ,
Required: False ,
}
[
string ,
]
,
alternateLocations:
{
Description: A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Locations_Get (removed)
Description :  Returns the details about a location to which you can ship the disks associated with an import or export job. A location is an Azure region.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/locations/{locationName}
{
locationName:
{
Description: The name of the location. For example, West US or westus. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Specifies the resource identifier of the location. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the location. Use List Locations to get all supported locations. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the location. ,
Required: False ,
}
string ,
properties:
{
Description: location properties ,
Required: False ,
}
{
recipientName:
{
Description: The recipient name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when shipping the drives to the Azure data center. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number for the Azure data center. ,
Required: False ,
}
string ,
additionalShippingInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
supportedCarriers:
{
Description: A list of carriers that are supported at this location. ,
Required: False ,
}
[
string ,
]
,
alternateLocations:
{
Description: A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_ListBySubscription (removed)
Description :  Returns all active and completed jobs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs
{
$top:
{
Description: An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: Can be used to restrict the results to certain conditions. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: link to next batch of jobs ,
Required: False ,
}
string ,
value:
{
Description: Job list ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_ListByResourceGroup (removed)
Description :  Returns all active and completed jobs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs
{
$top:
{
Description: An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: Can be used to restrict the results to certain conditions. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: link to next batch of jobs ,
Required: False ,
}
string ,
value:
{
Description: Job list ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Get (removed)
Description :  Gets information about an existing job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Update (removed)
Description :  Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
body:
{
Description: The parameters to update in the job ,
Required: True ,
}
{
tags:
{
Description: Specifies the tags that will be assigned to the job ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the properties of a UpdateJob. ,
Required: False ,
}
{
cancelRequested:
{
Description: If specified, the value must be true. The service will attempt to cancel the job. ,
Required: False ,
}
boolean ,
state:
{
Description: If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
logLevel:
{
Description: Indicates whether error logging or verbose logging is enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
driveList:
{
Description: List of drives that comprise the job. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Create (removed)
Description :  Creates a new job or updates an existing job in the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
x-ms-client-tenant-id:
{
Description: The tenant ID of the client making the request. ,
Required: False ,
}
string ,
body:
{
Description: The parameters used for creating the job ,
Required: True ,
}
{
location:
{
Description: Specifies the supported Azure location where the job should be created ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that will be assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of ImportExport Jobs. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: Specifies the resource identifier of the job. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the job. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the job resource. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the Azure location where the job is created. ,
Required: False ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the job. ,
Required: False ,
}
object ,
properties:
{
Description: Specifies the job properties ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource identifier of the storage account where data will be imported to or exported from. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of job ,
Required: False ,
}
string ,
returnAddress:
{
Description: Specifies the return address information for the job. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: True ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: True ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: True ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: True ,
}
string ,
email:
{
Description: Email address of the recipient of the returned drives. ,
Required: True ,
}
string ,
}
,
returnShipping:
{
Description: Specifies the return carrier and customer's account with the carrier. ,
Required: False ,
}
{
carrierName:
{
Description: The carrier's name. ,
Required: True ,
}
string ,
carrierAccountNumber:
{
Description: The customer's account number with the carrier. ,
Required: True ,
}
string ,
}
,
shippingInformation:
{
Description: Contains information about the Microsoft datacenter to which the drives should be shipped. ,
Required: False ,
}
{
recipientName:
{
Description: The name of the recipient who will receive the hard drives when they are returned. ,
Required: False ,
}
string ,
streetAddress1:
{
Description: The first line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
streetAddress2:
{
Description: The second line of the street address to use when returning the drives. ,
Required: False ,
}
string ,
city:
{
Description: The city name to use when returning the drives. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: The state or province to use when returning the drives. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code to use when returning the drives. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region to use when returning the drives. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number of the recipient of the returned drives. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional shipping information for customer, specific to datacenter to which customer should send their disks. ,
Required: False ,
}
string ,
}
,
deliveryPackage:
{
Description: Contains information about the package being shipped by the customer to the Microsoft data center. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: False ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: False ,
}
string ,
}
,
returnPackage:
{
Description: 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. ,
Required: False ,
}
{
carrierName:
{
Description: The name of the carrier that is used to ship the import or export drives. ,
Required: True ,
}
string ,
trackingNumber:
{
Description: The tracking number of the package. ,
Required: True ,
}
string ,
driveCount:
{
Description: The number of drives included in the package. ,
Format: int64 ,
Required: True ,
}
integer ,
shipDate:
{
Description: The date when the package is shipped. ,
Required: True ,
}
string ,
}
,
diagnosticsPath:
{
Description: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. ,
Required: False ,
}
string ,
logLevel:
{
Description: Default value is Error. Indicates whether error logging or verbose logging will be enabled. ,
Required: False ,
}
string ,
backupDriveManifest:
{
Description: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. ,
Required: False ,
}
boolean ,
state:
{
Description: Current state of the job. ,
Required: False ,
}
string ,
cancelRequested:
{
Description: Indicates whether a request has been submitted to cancel the job. ,
Required: False ,
}
boolean ,
percentComplete:
{
Description: Overall percentage completed for the job. ,
Format: int64 ,
Required: False ,
}
integer ,
incompleteBlobListUri:
{
Description: 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. ,
Required: False ,
}
string ,
driveList:
{
Description: 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. ,
Required: False ,
}
[
{
driveId:
{
Description: The drive's hardware serial number, without spaces. ,
Required: False ,
}
string ,
bitLockerKey:
{
Description: The BitLocker key used to encrypt the drive. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The relative path of the manifest file on the drive. ,
Required: False ,
}
string ,
manifestHash:
{
Description: The Base16-encoded MD5 hash of the manifest file on the drive. ,
Required: False ,
}
string ,
driveHeaderHash:
{
Description: The drive header hash value. ,
Required: False ,
}
string ,
state:
{
Description: The drive's current state. ,
Enum:
{
Specified: No description available. ,
Received: No description available. ,
NeverReceived: No description available. ,
Transferring: No description available. ,
Completed: No description available. ,
CompletedMoreInfo: No description available. ,
ShippedBack: No description available. ,
}
,
Required: False ,
}
enum ,
copyStatus:
{
Description: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage completed for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
verboseLogUri:
{
Description: A URI that points to the blob containing the verbose log for the data transfer operation. ,
Required: False ,
}
string ,
errorLogUri:
{
Description: A URI that points to the blob containing the error log for the data transfer operation. ,
Required: False ,
}
string ,
manifestUri:
{
Description: A URI that points to the blob containing the drive manifest file. ,
Required: False ,
}
string ,
bytesSucceeded:
{
Description: Bytes successfully transferred for the drive. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
export:
{
Description: A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. ,
Required: False ,
}
{
blobList:
{
Description: A list of the blobs to be exported. ,
Required: False ,
}
{
blobPath:
{
Description: A collection of blob-path strings. ,
Required: False ,
}
[
string ,
]
,
blobPathPrefix:
{
Description: A collection of blob-prefix strings. ,
Required: False ,
}
[
string ,
]
,
}
,
blobListBlobPath:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Specifies the provisioning state of the job. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Contains information about the encryption key. ,
Required: False ,
}
{
kekType:
{
Description: The type of kek encryption key ,
Enum:
{
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
kekUrl:
{
Description: Specifies the url for kek encryption key. ,
Required: False ,
}
string ,
kekVaultResourceID:
{
Description: Specifies the keyvault resource id for kek encryption key. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: Specifies the job identity details ,
Required: False ,
}
{
type:
{
Description: The type of identity ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Specifies the principal id for the identity for the job. ,
Required: False ,
}
string ,
tenantId:
{
Description: Specifies the tenant id for the identity for the job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Jobs_Delete (removed)
Description :  Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
BitLockerKeys_List (removed)
Description :  Returns the BitLocker Keys for all drives in the specified job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys
{
jobName:
{
Description: The name of the import/export job. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID for the Azure user. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name uniquely identifies the resource group within the user subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: drive status ,
Required: False ,
}
[
{
bitLockerKey:
{
Description: BitLocker recovery key or password ,
Required: False ,
}
string ,
driveId:
{
Description: Drive ID ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}
Operations_List (removed)
Description :  Returns the list of operations supported by the import/export resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ImportExport/operations
{
api-version:
{
Description: Specifies the API version to use for this request. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the preferred language for the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: operations ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: True ,
}
string ,
display:
{
Description: operation display properties ,
Required: True ,
}
{
provider:
{
Description: The resource provider name to which the operation belongs. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource to which the operation belongs. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes the error information. ,
Required: False ,
}
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
details:
{
Description: Describes the error details if present. ,
Required: False ,
}
[
{
code:
{
Description: Provides information about the error code. ,
Required: False ,
}
string ,
target:
{
Description: Provides information about the error target. ,
Required: False ,
}
string ,
message:
{
Description: Provides information about the error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error object if present. ,
Required: False ,
}
object ,
}
,
}