Package-level declarations

Types

Link copied to clipboard
data class AccountCredentialDetailsResponse(val accountConnectionString: String, val accountName: String, val dataAccountType: String, val shareCredentialDetails: List<ShareCredentialDetailsResponse>)

Credential details of the account.

Link copied to clipboard
data class AdditionalErrorInfoResponse(val info: Any? = null, val type: String? = null)

This class represents additional info which Resource Providers pass when an error occurs.

Link copied to clipboard
data class ApplianceNetworkConfigurationResponse(val macAddress: String, val name: String)

The Network Adapter configuration of a DataBox.

Link copied to clipboard
data class AzureFileFilterDetailsResponse(val filePathList: List<String>? = null, val filePrefixList: List<String>? = null, val fileShareList: List<String>? = null)

Filter details to transfer Azure files

Link copied to clipboard
data class BlobFilterDetailsResponse(val blobPathList: List<String>? = null, val blobPrefixList: List<String>? = null, val containerList: List<String>? = null)

Filter details to transfer Azure Blobs

Link copied to clipboard
data class CloudErrorResponse(val additionalInfo: List<AdditionalErrorInfoResponse>, val code: String? = null, val details: List<CloudErrorResponse>, val message: String? = null, val target: String? = null)

Provides additional information about an http error response.

Link copied to clipboard
data class ContactDetailsResponse(val contactName: String, val emailList: List<String>, val mobile: String? = null, val notificationPreference: List<NotificationPreferenceResponse>? = null, val phone: String, val phoneExtension: String? = null)

Contact Details.

Link copied to clipboard
data class ContactInfoResponse(val contactName: String, val mobile: String? = null, val phone: String, val phoneExtension: String? = null)

Contact Info.

Link copied to clipboard
data class CopyProgressResponse(val accountId: String, val actions: List<String>, val bytesProcessed: Double, val dataAccountType: String, val directoriesErroredOut: Double, val error: CloudErrorResponse, val filesErroredOut: Double, val filesProcessed: Double, val invalidDirectoriesProcessed: Double, val invalidFileBytesUploaded: Double, val invalidFilesProcessed: Double, val isEnumerationInProgress: Boolean, val renamedContainerCount: Double, val storageAccountName: String, val totalBytesToProcess: Double, val totalFilesToProcess: Double, val transferType: String)

Copy progress.

Link copied to clipboard
data class CustomerDiskJobSecretsResponse(val carrierAccountNumber: String, val dcAccessSecurityCode: DcAccessSecurityCodeResponse, val diskSecrets: List<DiskSecretResponse>, val error: CloudErrorResponse, val jobSecretsType: String)

The secrets related to customer disk job.

Link copied to clipboard
data class DataBoxAccountCopyLogDetailsResponse(val accountName: String, val copyLogDetailsType: String, val copyLogLink: String, val copyVerboseLogLink: String)

Copy log details for a storage account of a DataBox job

data class DataBoxCustomerDiskCopyLogDetailsResponse(val copyLogDetailsType: String, val errorLogLink: String, val serialNumber: String, val verboseLogLink: String)

Copy Log Details for customer disk

Link copied to clipboard
data class DataBoxCustomerDiskCopyProgressResponse(val accountId: String, val actions: List<String>, val bytesProcessed: Double, val copyStatus: String, val dataAccountType: String, val directoriesErroredOut: Double, val error: CloudErrorResponse, val filesErroredOut: Double, val filesProcessed: Double, val invalidDirectoriesProcessed: Double, val invalidFileBytesUploaded: Double, val invalidFilesProcessed: Double, val isEnumerationInProgress: Boolean, val renamedContainerCount: Double, val serialNumber: String, val storageAccountName: String, val totalBytesToProcess: Double, val totalFilesToProcess: Double, val transferType: String)

DataBox CustomerDisk Copy Progress

Link copied to clipboard
data class DataBoxCustomerDiskJobDetailsResponse(val actions: List<String>, val chainOfCustodySasKey: String, val contactDetails: ContactDetailsResponse, val copyLogDetails: List<Any>, val copyProgress: List<DataBoxCustomerDiskCopyProgressResponse>, val dataCenterCode: String, val dataExportDetails: List<DataExportDetailsResponse>? = null, val dataImportDetails: List<DataImportDetailsResponse>? = null, val datacenterAddress: Either<DatacenterAddressInstructionResponseResponse, DatacenterAddressLocationResponseResponse>, val deliverToDcPackageDetails: PackageCarrierInfoResponse, val deliveryPackage: PackageShippingDetailsResponse, val deviceErasureDetails: DeviceErasureDetailsResponse, val enableManifestBackup: Boolean? = null, val expectedDataSizeInTeraBytes: Int? = null, val exportDiskDetailsCollection: Map<String, ExportDiskDetailsResponse>, val importDiskDetailsCollection: Map<String, ImportDiskDetailsResponse>? = null, val jobDetailsType: String, val jobStages: List<JobStagesResponse>, val keyEncryptionKey: KeyEncryptionKeyResponse? = null, val lastMitigationActionOnJob: LastMitigationActionOnJobResponse, val preferences: PreferencesResponse? = null, val returnPackage: PackageShippingDetailsResponse, val returnToCustomerPackageDetails: PackageCarrierDetailsResponse, val reverseShipmentLabelSasKey: String, val reverseShippingDetails: ReverseShippingDetailsResponse? = null, val shippingAddress: ShippingAddressResponse? = null)

Customer disk job details.

Link copied to clipboard
data class DataBoxDiskCopyLogDetailsResponse(val copyLogDetailsType: String, val diskSerialNumber: String, val errorLogLink: String, val verboseLogLink: String)

Copy Log Details for a disk

Link copied to clipboard
data class DataBoxDiskCopyProgressResponse(val actions: List<String>, val bytesCopied: Double, val error: CloudErrorResponse, val percentComplete: Int, val serialNumber: String, val status: String)

DataBox Disk Copy Progress

data class DataBoxDiskGranularCopyLogDetailsResponse(val accountId: String, val copyLogDetailsType: String, val errorLogLink: String, val serialNumber: String, val verboseLogLink: String)

Granular Copy Log Details for customer disk

Link copied to clipboard
data class DataBoxDiskGranularCopyProgressResponse(val accountId: String, val actions: List<String>, val bytesProcessed: Double, val copyStatus: String, val dataAccountType: String, val directoriesErroredOut: Double, val error: CloudErrorResponse, val filesErroredOut: Double, val filesProcessed: Double, val invalidDirectoriesProcessed: Double, val invalidFileBytesUploaded: Double, val invalidFilesProcessed: Double, val isEnumerationInProgress: Boolean, val renamedContainerCount: Double, val serialNumber: String, val storageAccountName: String, val totalBytesToProcess: Double, val totalFilesToProcess: Double, val transferType: String)

DataBox Disk Granular Copy Progress

Link copied to clipboard
data class DataBoxDiskJobDetailsResponse(val actions: List<String>, val chainOfCustodySasKey: String, val contactDetails: ContactDetailsResponse, val copyLogDetails: List<Any>, val copyProgress: List<DataBoxDiskCopyProgressResponse>, val dataCenterCode: String, val dataExportDetails: List<DataExportDetailsResponse>? = null, val dataImportDetails: List<DataImportDetailsResponse>? = null, val datacenterAddress: Either<DatacenterAddressInstructionResponseResponse, DatacenterAddressLocationResponseResponse>, val deliveryPackage: PackageShippingDetailsResponse, val deviceErasureDetails: DeviceErasureDetailsResponse, val disksAndSizeDetails: Map<String, Int>, val expectedDataSizeInTeraBytes: Int? = null, val granularCopyLogDetails: List<DataBoxDiskGranularCopyLogDetailsResponse>, val granularCopyProgress: List<DataBoxDiskGranularCopyProgressResponse>, val jobDetailsType: String, val jobStages: List<JobStagesResponse>, val keyEncryptionKey: KeyEncryptionKeyResponse? = null, val lastMitigationActionOnJob: LastMitigationActionOnJobResponse, val passkey: String? = null, val preferences: PreferencesResponse? = null, val preferredDisks: Map<String, Int>? = null, val returnPackage: PackageShippingDetailsResponse, val reverseShipmentLabelSasKey: String, val reverseShippingDetails: ReverseShippingDetailsResponse? = null, val shippingAddress: ShippingAddressResponse? = null)

DataBox Disk Job Details.

Link copied to clipboard
data class DataBoxDiskJobSecretsResponse(val dcAccessSecurityCode: DcAccessSecurityCodeResponse, val diskSecrets: List<DiskSecretResponse>, val error: CloudErrorResponse, val isPasskeyUserDefined: Boolean, val jobSecretsType: String, val passKey: String)

The secrets related to disk job.

data class DataBoxHeavyAccountCopyLogDetailsResponse(val accountName: String, val copyLogDetailsType: String, val copyLogLink: List<String>, val copyVerboseLogLink: List<String>)

Copy log details for a storage account for Databox heavy

Link copied to clipboard
data class DataBoxHeavyJobDetailsResponse(val actions: List<String>, val chainOfCustodySasKey: String, val contactDetails: ContactDetailsResponse, val copyLogDetails: List<Any>, val copyProgress: List<CopyProgressResponse>, val dataCenterCode: String, val dataExportDetails: List<DataExportDetailsResponse>? = null, val dataImportDetails: List<DataImportDetailsResponse>? = null, val datacenterAddress: Either<DatacenterAddressInstructionResponseResponse, DatacenterAddressLocationResponseResponse>, val deliveryPackage: PackageShippingDetailsResponse, val deviceErasureDetails: DeviceErasureDetailsResponse, val devicePassword: String? = null, val expectedDataSizeInTeraBytes: Int? = null, val jobDetailsType: String, val jobStages: List<JobStagesResponse>, val keyEncryptionKey: KeyEncryptionKeyResponse? = null, val lastMitigationActionOnJob: LastMitigationActionOnJobResponse, val preferences: PreferencesResponse? = null, val returnPackage: PackageShippingDetailsResponse, val reverseShipmentLabelSasKey: String, val reverseShippingDetails: ReverseShippingDetailsResponse? = null, val shippingAddress: ShippingAddressResponse? = null)

Databox Heavy Device Job Details

Link copied to clipboard
data class DataBoxHeavyJobSecretsResponse(val cabinetPodSecrets: List<DataBoxHeavySecretResponse>, val dcAccessSecurityCode: DcAccessSecurityCodeResponse, val error: CloudErrorResponse, val jobSecretsType: String)

The secrets related to a databox heavy job.

Link copied to clipboard
data class DataBoxHeavySecretResponse(val accountCredentialDetails: List<AccountCredentialDetailsResponse>, val devicePassword: String, val deviceSerialNumber: String, val encodedValidationCertPubKey: String, val networkConfigurations: List<ApplianceNetworkConfigurationResponse>)

The secrets related to a databox heavy.

Link copied to clipboard
data class DataBoxJobDetailsResponse(val actions: List<String>, val chainOfCustodySasKey: String, val contactDetails: ContactDetailsResponse, val copyLogDetails: List<Any>, val copyProgress: List<CopyProgressResponse>, val dataCenterCode: String, val dataExportDetails: List<DataExportDetailsResponse>? = null, val dataImportDetails: List<DataImportDetailsResponse>? = null, val datacenterAddress: Either<DatacenterAddressInstructionResponseResponse, DatacenterAddressLocationResponseResponse>, val deliveryPackage: PackageShippingDetailsResponse, val deviceErasureDetails: DeviceErasureDetailsResponse, val devicePassword: String? = null, val expectedDataSizeInTeraBytes: Int? = null, val jobDetailsType: String, val jobStages: List<JobStagesResponse>, val keyEncryptionKey: KeyEncryptionKeyResponse? = null, val lastMitigationActionOnJob: LastMitigationActionOnJobResponse, val preferences: PreferencesResponse? = null, val returnPackage: PackageShippingDetailsResponse, val reverseShipmentLabelSasKey: String, val reverseShippingDetails: ReverseShippingDetailsResponse? = null, val shippingAddress: ShippingAddressResponse? = null)

Databox Job Details

Link copied to clipboard
data class DataboxJobSecretsResponse(val dcAccessSecurityCode: DcAccessSecurityCodeResponse, val error: CloudErrorResponse, val jobSecretsType: String, val podSecrets: List<DataBoxSecretResponse>? = null)

The secrets related to a databox job.

Link copied to clipboard
data class DataBoxSecretResponse(val accountCredentialDetails: List<AccountCredentialDetailsResponse>, val devicePassword: String, val deviceSerialNumber: String, val encodedValidationCertPubKey: String, val networkConfigurations: List<ApplianceNetworkConfigurationResponse>)

The secrets related to a DataBox.

data class DatacenterAddressInstructionResponseResponse(val communicationInstruction: String, val dataCenterAzureLocation: String, val datacenterAddressType: String, val supportedCarriersForReturnShipment: List<String>)

Datacenter instruction for given storage location.

data class DatacenterAddressLocationResponseResponse(val additionalShippingInformation: String, val addressType: String, val city: String, val company: String, val contactPersonName: String, val country: String, val dataCenterAzureLocation: String, val datacenterAddressType: String, val phone: String, val phoneExtension: String, val state: String, val street1: String, val street2: String, val street3: String, val supportedCarriersForReturnShipment: List<String>, val zip: String)

Datacenter address for given storage location.

Link copied to clipboard
data class DataExportDetailsResponse(val accountDetails: Either<ManagedDiskDetailsResponse, StorageAccountDetailsResponse>, val logCollectionLevel: String? = null, val transferConfiguration: TransferConfigurationResponse)

Details of the data to be used for exporting data from azure.

Link copied to clipboard
data class DataImportDetailsResponse(val accountDetails: Either<ManagedDiskDetailsResponse, StorageAccountDetailsResponse>, val logCollectionLevel: String? = null)

Details of the data to be used for importing data to azure.

Link copied to clipboard
data class DcAccessSecurityCodeResponse(val forwardDCAccessCode: String? = null, val reverseDCAccessCode: String? = null)

Dc access security code

Link copied to clipboard
data class DeviceErasureDetailsResponse(val deviceErasureStatus: String, val erasureOrDestructionCertificateSasKey: String)

Device erasure details with erasure completion status and erasureordestructionlog sas key

Link copied to clipboard
data class DiskSecretResponse(val bitLockerKey: String, val diskSerialNumber: String)

Contains all the secrets of a Disk.

Link copied to clipboard
data class EncryptionPreferencesResponse(val doubleEncryption: String? = null, val hardwareEncryption: String? = null)

Preferences related to the Encryption.

Link copied to clipboard
data class ExportDiskDetailsResponse(val backupManifestCloudPath: String, val manifestFile: String, val manifestHash: String)

Export disk details

Link copied to clipboard
data class FilterFileDetailsResponse(val filterFilePath: String, val filterFileType: String)

Details of the filter files to be used for data transfer.

Link copied to clipboard
data class GetJobResult(val cancellationReason: String, val deliveryInfo: JobDeliveryInfoResponse? = null, val deliveryType: String? = null, val details: Any? = null, val error: CloudErrorResponse, val id: String, val identity: ResourceIdentityResponse? = null, val isCancellable: Boolean, val isCancellableWithoutFee: Boolean, val isDeletable: Boolean, val isPrepareToShipEnabled: Boolean, val isShippingAddressEditable: Boolean, val location: String, val name: String, val reverseShippingDetailsUpdate: String, val reverseTransportPreferenceUpdate: String, val sku: SkuResponse, val startTime: String, val status: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val transferType: String, val type: String)

Job Resource.

Link copied to clipboard
data class IdentityPropertiesResponse(val type: String? = null, val userAssigned: UserAssignedPropertiesResponse? = null)

Managed identity properties.

Link copied to clipboard
data class ImportDiskDetailsResponse(val backupManifestCloudPath: String, val bitLockerKey: String, val manifestFile: String, val manifestHash: String)

Import disk details

Link copied to clipboard
data class JobDeliveryInfoResponse(val scheduledDateTime: String? = null)

Additional delivery info.

Link copied to clipboard
data class JobStagesResponse(val displayName: String, val jobStageDetails: Any, val stageName: String, val stageStatus: String, val stageTime: String)

Job stages.

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

Encryption key containing details about key to encrypt different keys.

Link copied to clipboard
data class LastMitigationActionOnJobResponse(val actionDateTimeInUtc: String? = null, val customerResolution: String? = null, val isPerformedByCustomer: Boolean? = null)

Last Mitigation Action Performed On Job

Link copied to clipboard
data class ListJobCredentialsResult(val nextLink: String? = null, val value: List<UnencryptedCredentialsResponse>? = null)

List of unencrypted credentials for accessing device.

Link copied to clipboard
data class ManagedDiskDetailsResponse(val dataAccountType: String, val resourceGroupId: String, val stagingStorageAccountId: String)

Details of the managed disks.

Link copied to clipboard
data class NotificationPreferenceResponse(val sendNotification: Boolean, val stageName: String)

Notification preference for a job stage.

Link copied to clipboard
data class PackageCarrierDetailsResponse(val carrierAccountNumber: String? = null, val carrierName: String? = null, val trackingId: String? = null)

Package carrier details.

Link copied to clipboard
data class PackageCarrierInfoResponse(val carrierName: String? = null, val trackingId: String? = null)

package carrier info

Link copied to clipboard
data class PackageShippingDetailsResponse(val carrierName: String, val trackingId: String, val trackingUrl: String)

package shipping details

Link copied to clipboard
data class PreferencesResponse(val encryptionPreferences: EncryptionPreferencesResponse? = null, val preferredDataCenterRegion: List<String>? = null, val reverseTransportPreferences: TransportPreferencesResponse? = null, val storageAccountAccessTierPreferences: List<String>? = null, val transportPreferences: TransportPreferencesResponse? = null)

Preferences related to the order

Link copied to clipboard
data class ResourceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Msi identity details of the resource

Link copied to clipboard
data class ReverseShippingDetailsResponse(val contactDetails: ContactInfoResponse? = null, val isUpdated: Boolean, val shippingAddress: ShippingAddressResponse? = null)

Reverse Shipping Address and contact details for a job.

Link copied to clipboard
data class ShareCredentialDetailsResponse(val password: String, val shareName: String, val shareType: String, val supportedAccessProtocols: List<String>, val userName: String)

Credential details of the shares in account.

Link copied to clipboard
data class ShippingAddressResponse(val addressType: String? = null, val city: String? = null, val companyName: String? = null, val country: String, val postalCode: String? = null, val skipAddressValidation: Boolean? = null, val stateOrProvince: String? = null, val streetAddress1: String, val streetAddress2: String? = null, val streetAddress3: String? = null, val taxIdentificationNumber: String? = null, val zipExtendedCode: String? = null)

Shipping address where customer wishes to receive the device.

Link copied to clipboard
data class SkuResponse(val displayName: String? = null, val family: String? = null, val name: String)

The Sku.

Link copied to clipboard
data class StorageAccountDetailsResponse(val dataAccountType: String, val storageAccountId: String)

Details for the storage account.

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

Provides details about resource creation and update time

Link copied to clipboard
data class TransferAllDetailsResponse(val dataAccountType: String, val transferAllBlobs: Boolean? = null, val transferAllFiles: Boolean? = null)

Details to transfer all data.

Link copied to clipboard
data class TransferConfigurationResponse(val transferAllDetails: TransferConfigurationResponseTransferAllDetails? = null, val transferConfigurationType: String, val transferFilterDetails: TransferConfigurationResponseTransferFilterDetails? = null)

Configuration for defining the transfer of data.

Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll

Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter.

Link copied to clipboard
data class TransferFilterDetailsResponse(val azureFileFilterDetails: AzureFileFilterDetailsResponse? = null, val blobFilterDetails: BlobFilterDetailsResponse? = null, val dataAccountType: String, val filterFileDetails: List<FilterFileDetailsResponse>? = null)

Details of the filtering the transfer of data.

Link copied to clipboard
data class TransportPreferencesResponse(val isUpdated: Boolean, val preferredShipmentType: String)

Preferences related to the shipment logistics of the sku

Link copied to clipboard
data class UnencryptedCredentialsResponse(val jobName: String, val jobSecrets: Any)

Unencrypted credentials for accessing device.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

Class defining User assigned identity details.

Link copied to clipboard
data class UserAssignedPropertiesResponse(val resourceId: String? = null)

User assigned identity properties.