Package-level declarations

Types

Link copied to clipboard
data class DeliveryPackageInformationResponse(val carrierName: String, val driveCount: Double? = null, val shipDate: String? = null, val trackingNumber: String)

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

Link copied to clipboard
data class DriveBitLockerKeyResponse(val bitLockerKey: String? = null, val driveId: String? = null)

BitLocker recovery key or password to the specified drive

Link copied to clipboard
data class DriveStatusResponse(val bitLockerKey: String? = null, val bytesSucceeded: Double? = null, val copyStatus: String? = null, val driveHeaderHash: String? = null, val driveId: String? = null, val errorLogUri: String? = null, val manifestFile: String? = null, val manifestHash: String? = null, val manifestUri: String? = null, val percentComplete: Double? = null, val state: String? = null, val verboseLogUri: String? = null)

Provides information about the drive's status

Link copied to clipboard
data class EncryptionKeyDetailsResponse(val kekType: String? = null, val kekUrl: String? = null, val kekVaultResourceID: String? = null)

Specifies the encryption key properties

Link copied to clipboard
data class ExportResponse(val blobListBlobPath: String? = null, val blobPath: List<String>? = null, val blobPathPrefix: List<String>? = null)

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

Link copied to clipboard
data class GetJobResult(val id: String, val identity: IdentityDetailsResponse? = null, val location: String? = null, val name: String, val properties: JobDetailsResponse, val systemData: SystemDataResponse, val tags: Any? = null, val type: String)

Contains the job information.

Link copied to clipboard
data class IdentityDetailsResponse(val principalId: String, val tenantId: String, val type: String? = null)

Specifies the identity properties.

Link copied to clipboard
data class JobDetailsResponse(val backupDriveManifest: Boolean? = null, val cancelRequested: Boolean? = null, val deliveryPackage: DeliveryPackageInformationResponse? = null, val diagnosticsPath: String? = null, val driveList: List<DriveStatusResponse>? = null, val encryptionKey: EncryptionKeyDetailsResponse? = null, val export: ExportResponse? = null, val incompleteBlobListUri: String? = null, val jobType: String? = null, val logLevel: String? = null, val percentComplete: Double? = null, val provisioningState: String? = null, val returnAddress: ReturnAddressResponse? = null, val returnPackage: PackageInformationResponse? = null, val returnShipping: ReturnShippingResponse? = null, val shippingInformation: ShippingInformationResponse? = null, val state: String? = null, val storageAccountId: String? = null)

Specifies the job properties

Link copied to clipboard
data class ListBitLockerKeyResult(val value: List<DriveBitLockerKeyResponse>? = null)

GetBitLockerKeys response

Link copied to clipboard
data class PackageInformationResponse(val carrierName: String, val driveCount: Double, val shipDate: String, val trackingNumber: String)

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

Link copied to clipboard
data class ReturnAddressResponse(val city: String, val countryOrRegion: String, val email: String, val phone: String, val postalCode: String, val recipientName: String, val stateOrProvince: String? = null, val streetAddress1: String, val streetAddress2: String? = null)

Specifies the return address information for the job.

Link copied to clipboard
data class ReturnShippingResponse(val carrierAccountNumber: String, val carrierName: String)

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

Link copied to clipboard
data class ShippingInformationResponse(val additionalInformation: String, val city: String? = null, val countryOrRegion: String? = null, val phone: String? = null, val postalCode: String? = null, val recipientName: String? = null, val stateOrProvince: String? = null, val streetAddress1: String? = null, val streetAddress2: String? = null)

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

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.