@azure/arm-databox 3.0.0 → 5.0.0-beta.1

package/review/arm-databox.api.md

@@ -0,0 +1,1376 @@
+## API Report File for "@azure/arm-databox"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type AccessProtocol = "SMB" | "NFS";
+
+// @public
+export interface AccountCredentialDetails {
+    readonly accountConnectionString?: string;
+    readonly accountName?: string;
+    readonly dataAccountType?: DataAccountType;
+    readonly shareCredentialDetails?: ShareCredentialDetails[];
+}
+
+// @public
+export interface AdditionalErrorInfo {
+    info?: Record<string, unknown>;
+    type?: string;
+}
+
+// @public
+export type AddressType = "None" | "Residential" | "Commercial";
+
+// @public
+export interface AddressValidationOutput {
+    readonly alternateAddresses?: ShippingAddress[];
+    readonly error?: CloudError;
+    readonly validationStatus?: AddressValidationStatus;
+    validationType?: ValidationInputDiscriminator;
+}
+
+// @public
+export type AddressValidationProperties = ValidationInputResponse & {
+    validationType: "ValidateAddress";
+    readonly validationStatus?: AddressValidationStatus;
+    readonly alternateAddresses?: ShippingAddress[];
+};
+
+// @public
+export type AddressValidationStatus = "Valid" | "Invalid" | "Ambiguous";
+
+// @public (undocumented)
+export interface ApiError {
+    // (undocumented)
+    error: ErrorDetail;
+}
+
+// @public
+export interface ApplianceNetworkConfiguration {
+    readonly macAddress?: string;
+    readonly name?: string;
+}
+
+// @public
+export interface ArmBaseObject {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface AvailableSkuRequest {
+    country: string;
+    location: string;
+    skuNames?: SkuName[];
+    transferType: TransferType;
+}
+
+// @public
+export interface AvailableSkusResult {
+    nextLink?: string;
+    readonly value?: SkuInformation[];
+}
+
+// @public
+export interface AzureFileFilterDetails {
+    filePathList?: string[];
+    filePrefixList?: string[];
+    fileShareList?: string[];
+}
+
+// @public
+export interface BlobFilterDetails {
+    blobPathList?: string[];
+    blobPrefixList?: string[];
+    containerList?: string[];
+}
+
+// @public
+export interface CancellationReason {
+    reason: string;
+}
+
+// @public
+export type ClassDiscriminator = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
+
+// @public
+export interface CloudError {
+    readonly additionalInfo?: AdditionalErrorInfo[];
+    code?: string;
+    readonly details?: CloudError[];
+    message?: string;
+    target?: string;
+}
+
+// @public
+export interface ContactDetails {
+    contactName: string;
+    emailList: string[];
+    mobile?: string;
+    notificationPreference?: NotificationPreference[];
+    phone: string;
+    phoneExtension?: string;
+}
+
+// @public
+export interface CopyLogDetails {
+    copyLogDetailsType: "DataBox" | "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy";
+}
+
+// @public (undocumented)
+export type CopyLogDetailsUnion = CopyLogDetails | DataBoxAccountCopyLogDetails | DataBoxCustomerDiskCopyLogDetails | DataBoxDiskCopyLogDetails | DataBoxHeavyAccountCopyLogDetails;
+
+// @public
+export interface CopyProgress {
+    readonly accountId?: string;
+    readonly bytesProcessed?: number;
+    readonly dataAccountType?: DataAccountType;
+    readonly directoriesErroredOut?: number;
+    readonly filesErroredOut?: number;
+    readonly filesProcessed?: number;
+    readonly invalidDirectoriesProcessed?: number;
+    readonly invalidFileBytesUploaded?: number;
+    readonly invalidFilesProcessed?: number;
+    readonly isEnumerationInProgress?: boolean;
+    readonly renamedContainerCount?: number;
+    readonly storageAccountName?: string;
+    readonly totalBytesToProcess?: number;
+    readonly totalFilesToProcess?: number;
+    readonly transferType?: TransferType;
+}
+
+// @public
+export type CopyStatus = string;
+
+// @public
+export type CreateJobValidations = ValidationRequest & {
+    validationCategory: "JobCreationValidation";
+};
+
+// @public
+export type CreateOrderLimitForSubscriptionValidationRequest = ValidationInputRequest & {
+    validationType: "ValidateCreateOrderLimit";
+    deviceType: SkuName;
+};
+
+// @public
+export type CreateOrderLimitForSubscriptionValidationResponseProperties = ValidationInputResponse & {
+    validationType: "ValidateCreateOrderLimit";
+    readonly status?: ValidationStatus;
+};
+
+// @public
+export type CustomerDiskJobSecrets = JobSecrets & {
+    jobSecretsType: "DataBoxCustomerDisk";
+    readonly diskSecrets?: DiskSecret[];
+    readonly carrierAccountNumber?: string;
+};
+
+// @public
+export type CustomerResolutionCode = "None" | "MoveToCleanUpDevice" | "Resume";
+
+// @public
+export interface DataAccountDetails {
+    dataAccountType: "ManagedDisk" | "StorageAccount";
+    sharePassword?: string;
+}
+
+// @public (undocumented)
+export type DataAccountDetailsUnion = DataAccountDetails | ManagedDiskDetails | StorageAccountDetails;
+
+// @public
+export type DataAccountType = "StorageAccount" | "ManagedDisk";
+
+// @public
+export type DataBoxAccountCopyLogDetails = CopyLogDetails & {
+    copyLogDetailsType: "DataBox";
+    readonly accountName?: string;
+    readonly copyLogLink?: string;
+    readonly copyVerboseLogLink?: string;
+};
+
+// @public
+export type DataBoxCustomerDiskCopyLogDetails = CopyLogDetails & {
+    copyLogDetailsType: "DataBoxCustomerDisk";
+    readonly serialNumber?: string;
+    readonly errorLogLink?: string;
+    readonly verboseLogLink?: string;
+};
+
+// @public
+export type DataBoxCustomerDiskCopyProgress = CopyProgress & {
+    readonly serialNumber?: string;
+    readonly copyStatus?: CopyStatus;
+};
+
+// @public
+export type DataBoxCustomerDiskJobDetails = JobDetails & {
+    jobDetailsType: "DataBoxCustomerDisk";
+    importDiskDetailsCollection?: {
+        [propertyName: string]: ImportDiskDetails;
+    };
+    readonly exportDiskDetailsCollection?: {
+        [propertyName: string]: ExportDiskDetails;
+    };
+    readonly copyProgress?: DataBoxCustomerDiskCopyProgress[];
+    readonly deliverToDcPackageDetails?: PackageCarrierInfo;
+    returnToCustomerPackageDetails: PackageCarrierDetails;
+    enableManifestBackup?: boolean;
+};
+
+// @public
+export type DataBoxDiskCopyLogDetails = CopyLogDetails & {
+    copyLogDetailsType: "DataBoxDisk";
+    readonly diskSerialNumber?: string;
+    readonly errorLogLink?: string;
+    readonly verboseLogLink?: string;
+};
+
+// @public
+export interface DataBoxDiskCopyProgress {
+    readonly bytesCopied?: number;
+    readonly percentComplete?: number;
+    readonly serialNumber?: string;
+    readonly status?: CopyStatus;
+}
+
+// @public
+export type DataBoxDiskJobDetails = JobDetails & {
+    jobDetailsType: "DataBoxDisk";
+    preferredDisks?: {
+        [propertyName: string]: number;
+    };
+    readonly copyProgress?: DataBoxDiskCopyProgress[];
+    readonly disksAndSizeDetails?: {
+        [propertyName: string]: number;
+    };
+    passkey?: string;
+};
+
+// @public
+export type DataBoxDiskJobSecrets = JobSecrets & {
+    jobSecretsType: "DataBoxDisk";
+    readonly diskSecrets?: DiskSecret[];
+    readonly passKey?: string;
+    readonly isPasskeyUserDefined?: boolean;
+};
+
+// @public
+export type DataBoxHeavyAccountCopyLogDetails = CopyLogDetails & {
+    copyLogDetailsType: "DataBoxHeavy";
+    readonly accountName?: string;
+    readonly copyLogLink?: string[];
+    readonly copyVerboseLogLink?: string[];
+};
+
+// @public
+export type DataBoxHeavyJobDetails = JobDetails & {
+    jobDetailsType: "DataBoxHeavy";
+    readonly copyProgress?: CopyProgress[];
+    devicePassword?: string;
+};
+
+// @public
+export type DataBoxHeavyJobSecrets = JobSecrets & {
+    jobSecretsType: "DataBoxHeavy";
+    readonly cabinetPodSecrets?: DataBoxHeavySecret[];
+};
+
+// @public
+export interface DataBoxHeavySecret {
+    readonly accountCredentialDetails?: AccountCredentialDetails[];
+    readonly devicePassword?: string;
+    readonly deviceSerialNumber?: string;
+    readonly encodedValidationCertPubKey?: string;
+    readonly networkConfigurations?: ApplianceNetworkConfiguration[];
+}
+
+// @public
+export type DataBoxJobDetails = JobDetails & {
+    jobDetailsType: "DataBox";
+    readonly copyProgress?: CopyProgress[];
+    devicePassword?: string;
+};
+
+// @public
+export type DataboxJobSecrets = JobSecrets & {
+    jobSecretsType: "DataBox";
+    podSecrets?: DataBoxSecret[];
+};
+
+// @public (undocumented)
+export class DataBoxManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DataBoxManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    jobs: Jobs;
+    mitigate(jobName: string, resourceGroupName: string, mitigateJobRequest: MitigateJobRequest, options?: MitigateOptionalParams): Promise<void>;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    service: Service;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface DataBoxManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type DataBoxScheduleAvailabilityRequest = ScheduleAvailabilityRequest & {
+    skuName: "DataBox";
+};
+
+// @public
+export interface DataBoxSecret {
+    readonly accountCredentialDetails?: AccountCredentialDetails[];
+    readonly devicePassword?: string;
+    readonly deviceSerialNumber?: string;
+    readonly encodedValidationCertPubKey?: string;
+    readonly networkConfigurations?: ApplianceNetworkConfiguration[];
+}
+
+// @public
+export type DatacenterAddressInstructionResponse = DatacenterAddressResponse & {
+    datacenterAddressType: "DatacenterAddressInstruction";
+    readonly communicationInstruction?: string;
+};
+
+// @public
+export type DatacenterAddressLocationResponse = DatacenterAddressResponse & {
+    datacenterAddressType: "DatacenterAddressLocation";
+    readonly contactPersonName?: string;
+    readonly company?: string;
+    readonly street1?: string;
+    readonly street2?: string;
+    readonly street3?: string;
+    readonly city?: string;
+    readonly state?: string;
+    readonly zip?: string;
+    readonly country?: string;
+    readonly phone?: string;
+    readonly phoneExtension?: string;
+    readonly addressType?: string;
+    readonly additionalShippingInformation?: string;
+};
+
+// @public
+export interface DatacenterAddressRequest {
+    skuName: SkuName;
+    storageLocation: string;
+}
+
+// @public
+export interface DatacenterAddressResponse {
+    datacenterAddressType: "DatacenterAddressInstruction" | "DatacenterAddressLocation";
+    readonly dataCenterAzureLocation?: string;
+    readonly supportedCarriersForReturnShipment?: string[];
+}
+
+// @public (undocumented)
+export type DatacenterAddressResponseUnion = DatacenterAddressResponse | DatacenterAddressInstructionResponse | DatacenterAddressLocationResponse;
+
+// @public
+export type DatacenterAddressType = "DatacenterAddressLocation" | "DatacenterAddressInstruction";
+
+// @public
+export type DataCenterCode = string;
+
+// @public
+export interface DataExportDetails {
+    accountDetails: DataAccountDetailsUnion;
+    logCollectionLevel?: LogCollectionLevel;
+    transferConfiguration: TransferConfiguration;
+}
+
+// @public
+export interface DataImportDetails {
+    accountDetails: DataAccountDetailsUnion;
+    logCollectionLevel?: LogCollectionLevel;
+}
+
+// @public
+export interface DataLocationToServiceLocationMap {
+    readonly dataLocation?: string;
+    readonly serviceLocation?: string;
+}
+
+// @public
+export type DataTransferDetailsValidationRequest = ValidationInputRequest & {
+    validationType: "ValidateDataTransferDetails";
+    dataExportDetails?: DataExportDetails[];
+    dataImportDetails?: DataImportDetails[];
+    deviceType: SkuName;
+    transferType: TransferType;
+};
+
+// @public
+export type DataTransferDetailsValidationResponseProperties = ValidationInputResponse & {
+    validationType: "ValidateDataTransferDetails";
+    readonly status?: ValidationStatus;
+};
+
+// @public
+export interface DcAccessSecurityCode {
+    forwardDCAccessCode?: string;
+    reverseDCAccessCode?: string;
+}
+
+// @public (undocumented)
+export interface Details {
+    // (undocumented)
+    code: string;
+    // (undocumented)
+    message: string;
+}
+
+// @public
+export type DiskScheduleAvailabilityRequest = ScheduleAvailabilityRequest & {
+    skuName: "DataBoxDisk";
+    expectedDataSizeInTeraBytes: number;
+};
+
+// @public
+export interface DiskSecret {
+    readonly bitLockerKey?: string;
+    readonly diskSerialNumber?: string;
+}
+
+// @public
+export type DoubleEncryption = "Enabled" | "Disabled";
+
+// @public
+export interface EncryptionPreferences {
+    doubleEncryption?: DoubleEncryption;
+}
+
+// @public (undocumented)
+export interface ErrorDetail {
+    // (undocumented)
+    code: string;
+    // (undocumented)
+    details?: Details[];
+    // (undocumented)
+    message: string;
+    // (undocumented)
+    target?: string;
+}
+
+// @public
+export interface ExportDiskDetails {
+    readonly backupManifestCloudPath?: string;
+    readonly manifestFile?: string;
+    readonly manifestHash?: string;
+}
+
+// @public
+export interface FilterFileDetails {
+    filterFilePath: string;
+    filterFileType: FilterFileType;
+}
+
+// @public
+export type FilterFileType = "AzureBlob" | "AzureFile";
+
+// @public
+export type HeavyScheduleAvailabilityRequest = ScheduleAvailabilityRequest & {
+    skuName: "DataBoxHeavy";
+};
+
+// @public
+export interface IdentityProperties {
+    type?: string;
+    userAssigned?: UserAssignedProperties;
+}
+
+// @public
+export interface ImportDiskDetails {
+    readonly backupManifestCloudPath?: string;
+    bitLockerKey: string;
+    manifestFile: string;
+    manifestHash: string;
+}
+
+// @public
+export interface JobDeliveryInfo {
+    scheduledDateTime?: Date;
+}
+
+// @public
+export type JobDeliveryType = "NonScheduled" | "Scheduled";
+
+// @public
+export interface JobDetails {
+    readonly actions?: CustomerResolutionCode[];
+    readonly chainOfCustodySasKey?: string;
+    contactDetails: ContactDetails;
+    readonly copyLogDetails?: CopyLogDetailsUnion[];
+    readonly datacenterAddress?: DatacenterAddressResponseUnion;
+    readonly dataCenterCode?: DataCenterCode;
+    dataExportDetails?: DataExportDetails[];
+    dataImportDetails?: DataImportDetails[];
+    readonly deliveryPackage?: PackageShippingDetails;
+    expectedDataSizeInTeraBytes?: number;
+    jobDetailsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
+    readonly jobStages?: JobStages[];
+    keyEncryptionKey?: KeyEncryptionKey;
+    readonly lastMitigationActionOnJob?: LastMitigationActionOnJob;
+    preferences?: Preferences;
+    readonly returnPackage?: PackageShippingDetails;
+    readonly reverseShipmentLabelSasKey?: string;
+    shippingAddress?: ShippingAddress;
+}
+
+// @public (undocumented)
+export type JobDetailsUnion = JobDetails | DataBoxCustomerDiskJobDetails | DataBoxDiskJobDetails | DataBoxHeavyJobDetails | DataBoxJobDetails;
+
+// @public
+export type JobResource = Resource & {
+    readonly name?: string;
+    readonly id?: string;
+    readonly type?: string;
+    readonly systemData?: SystemData;
+    transferType: TransferType;
+    readonly isCancellable?: boolean;
+    readonly isDeletable?: boolean;
+    readonly isShippingAddressEditable?: boolean;
+    readonly isPrepareToShipEnabled?: boolean;
+    readonly status?: StageName;
+    readonly startTime?: Date;
+    readonly error?: CloudError;
+    details?: JobDetailsUnion;
+    readonly cancellationReason?: string;
+    deliveryType?: JobDeliveryType;
+    deliveryInfo?: JobDeliveryInfo;
+    readonly isCancellableWithoutFee?: boolean;
+};
+
+// @public
+export interface JobResourceList {
+    nextLink?: string;
+    value?: JobResource[];
+}
+
+// @public
+export interface JobResourceUpdateParameter {
+    details?: UpdateJobDetails;
+    identity?: ResourceIdentity;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface Jobs {
+    beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<PollerLike<PollOperationState<JobsCreateResponse>, JobsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobsCreateResponse>;
+    beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<PollerLike<PollOperationState<JobsUpdateResponse>, JobsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobsUpdateResponse>;
+    bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<JobsBookShipmentPickUpResponse>;
+    cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>;
+    get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobsGetResponse>;
+    list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource>;
+    listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource>;
+    listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials>;
+    markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>;
+}
+
+// @public
+export interface JobsBookShipmentPickUpOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type JobsBookShipmentPickUpResponse = ShipmentPickUpResponse;
+
+// @public
+export interface JobsCancelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface JobsCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type JobsCreateResponse = JobResource;
+
+// @public
+export interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface JobSecrets {
+    readonly dcAccessSecurityCode?: DcAccessSecurityCode;
+    readonly error?: CloudError;
+    jobSecretsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
+}
+
+// @public (undocumented)
+export type JobSecretsUnion = JobSecrets | CustomerDiskJobSecrets | DataBoxDiskJobSecrets | DataBoxHeavyJobSecrets | DataboxJobSecrets;
+
+// @public
+export interface JobsGetOptionalParams extends coreClient.OperationOptions {
+    expand?: string;
+}
+
+// @public
+export type JobsGetResponse = JobResource;
+
+// @public
+export interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type JobsListByResourceGroupNextResponse = JobResourceList;
+
+// @public
+export interface JobsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type JobsListByResourceGroupResponse = JobResourceList;
+
+// @public
+export interface JobsListCredentialsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type JobsListCredentialsResponse = UnencryptedCredentialsList;
+
+// @public
+export interface JobsListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type JobsListNextResponse = JobResourceList;
+
+// @public
+export interface JobsListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type JobsListResponse = JobResourceList;
+
+// @public
+export interface JobsMarkDevicesShippedOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface JobStages {
+    readonly displayName?: string;
+    readonly jobStageDetails?: Record<string, unknown>;
+    readonly stageName?: StageName;
+    readonly stageStatus?: StageStatus;
+    readonly stageTime?: Date;
+}
+
+// @public
+export interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type JobsUpdateResponse = JobResource;
+
+// @public
+export type KekType = "MicrosoftManaged" | "CustomerManaged";
+
+// @public
+export interface KeyEncryptionKey {
+    identityProperties?: IdentityProperties;
+    kekType: KekType;
+    kekUrl?: string;
+    kekVaultResourceID?: string;
+}
+
+// @public
+export enum KnownCopyStatus {
+    Completed = "Completed",
+    CompletedWithErrors = "CompletedWithErrors",
+    DeviceFormatted = "DeviceFormatted",
+    DeviceMetadataModified = "DeviceMetadataModified",
+    DriveCorrupted = "DriveCorrupted",
+    DriveNotDetected = "DriveNotDetected",
+    DriveNotReceived = "DriveNotReceived",
+    Failed = "Failed",
+    HardwareError = "HardwareError",
+    InProgress = "InProgress",
+    MetadataFilesModifiedOrRemoved = "MetadataFilesModifiedOrRemoved",
+    NotReturned = "NotReturned",
+    NotStarted = "NotStarted",
+    OtherServiceError = "OtherServiceError",
+    OtherUserError = "OtherUserError",
+    StorageAccountNotAccessible = "StorageAccountNotAccessible",
+    UnsupportedData = "UnsupportedData",
+    UnsupportedDrive = "UnsupportedDrive"
+}
+
+// @public
+export enum KnownDataCenterCode {
+    // (undocumented)
+    AdHoc = "AdHoc",
+    // (undocumented)
+    AM2 = "AM2",
+    // (undocumented)
+    AMS06 = "AMS06",
+    // (undocumented)
+    AMS20 = "AMS20",
+    // (undocumented)
+    AUH20 = "AUH20",
+    // (undocumented)
+    BJB = "BJB",
+    // (undocumented)
+    BL20 = "BL20",
+    // (undocumented)
+    BL7 = "BL7",
+    // (undocumented)
+    BN1 = "BN1",
+    // (undocumented)
+    BOM01 = "BOM01",
+    // (undocumented)
+    BY1 = "BY1",
+    // (undocumented)
+    BY2 = "BY2",
+    // (undocumented)
+    BY21 = "BY21",
+    // (undocumented)
+    BY24 = "BY24",
+    // (undocumented)
+    CBR20 = "CBR20",
+    // (undocumented)
+    CH1 = "CH1",
+    // (undocumented)
+    CPQ02 = "CPQ02",
+    // (undocumented)
+    CPQ20 = "CPQ20",
+    // (undocumented)
+    CWL20 = "CWL20",
+    // (undocumented)
+    CYS04 = "CYS04",
+    // (undocumented)
+    DSM05 = "DSM05",
+    // (undocumented)
+    FRA22 = "FRA22",
+    // (undocumented)
+    HKG20 = "HKG20",
+    // (undocumented)
+    Invalid = "Invalid",
+    // (undocumented)
+    JNB21 = "JNB21",
+    // (undocumented)
+    JNB22 = "JNB22",
+    // (undocumented)
+    LON24 = "LON24",
+    // (undocumented)
+    MAA01 = "MAA01",
+    // (undocumented)
+    MEL23 = "MEL23",
+    // (undocumented)
+    MNZ21 = "MNZ21",
+    // (undocumented)
+    MWH01 = "MWH01",
+    // (undocumented)
+    ORK70 = "ORK70",
+    // (undocumented)
+    OSA20 = "OSA20",
+    // (undocumented)
+    PUS20 = "PUS20",
+    // (undocumented)
+    SEL20 = "SEL20",
+    // (undocumented)
+    SEL21 = "SEL21",
+    // (undocumented)
+    SG2 = "SG2",
+    // (undocumented)
+    SHA03 = "SHA03",
+    // (undocumented)
+    SIN20 = "SIN20",
+    // (undocumented)
+    SN5 = "SN5",
+    // (undocumented)
+    SN8 = "SN8",
+    // (undocumented)
+    SSE90 = "SSE90",
+    // (undocumented)
+    SYD03 = "SYD03",
+    // (undocumented)
+    SYD23 = "SYD23",
+    // (undocumented)
+    TYO01 = "TYO01",
+    // (undocumented)
+    TYO22 = "TYO22",
+    // (undocumented)
+    YQB20 = "YQB20",
+    // (undocumented)
+    YTO20 = "YTO20",
+    // (undocumented)
+    YTO21 = "YTO21",
+    // (undocumented)
+    ZRH20 = "ZRH20"
+}
+
+// @public
+export enum KnownNotificationStageName {
+    AtAzureDC = "AtAzureDC",
+    Created = "Created",
+    DataCopy = "DataCopy",
+    Delivered = "Delivered",
+    DevicePrepared = "DevicePrepared",
+    Dispatched = "Dispatched",
+    PickedUp = "PickedUp",
+    ShippedToCustomer = "ShippedToCustomer"
+}
+
+// @public
+export enum KnownStageName {
+    Aborted = "Aborted",
+    AtAzureDC = "AtAzureDC",
+    AwaitingShipmentDetails = "AwaitingShipmentDetails",
+    Cancelled = "Cancelled",
+    Completed = "Completed",
+    CompletedWithErrors = "CompletedWithErrors",
+    CompletedWithWarnings = "CompletedWithWarnings",
+    Created = "Created",
+    DataCopy = "DataCopy",
+    Delivered = "Delivered",
+    DeviceOrdered = "DeviceOrdered",
+    DevicePrepared = "DevicePrepared",
+    Dispatched = "Dispatched",
+    FailedIssueDetectedAtAzureDC = "Failed_IssueDetectedAtAzureDC",
+    FailedIssueReportedAtCustomer = "Failed_IssueReportedAtCustomer",
+    PickedUp = "PickedUp",
+    PreparingToShipFromAzureDC = "PreparingToShipFromAzureDC",
+    ReadyToDispatchFromAzureDC = "ReadyToDispatchFromAzureDC",
+    ReadyToReceiveAtAzureDC = "ReadyToReceiveAtAzureDC",
+    ShippedToAzureDC = "ShippedToAzureDC",
+    ShippedToCustomer = "ShippedToCustomer"
+}
+
+// @public
+export interface LastMitigationActionOnJob {
+    actionDateTimeInUtc?: Date;
+    customerResolution?: CustomerResolutionCode;
+    isPerformedByCustomer?: boolean;
+}
+
+// @public
+export type LogCollectionLevel = "Error" | "Verbose";
+
+// @public
+export type ManagedDiskDetails = DataAccountDetails & {
+    dataAccountType: "ManagedDisk";
+    resourceGroupId: string;
+    stagingStorageAccountId: string;
+};
+
+// @public
+export interface MarkDevicesShippedRequest {
+    deliverToDcPackageDetails: PackageCarrierInfo;
+}
+
+// @public
+export interface MitigateJobRequest {
+    customerResolutionCode: CustomerResolutionCode;
+}
+
+// @public
+export interface MitigateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface NotificationPreference {
+    sendNotification: boolean;
+    stageName: NotificationStageName;
+}
+
+// @public
+export type NotificationStageName = string;
+
+// @public
+export interface Operation {
+    readonly display?: OperationDisplay;
+    isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: string;
+    readonly properties?: Record<string, unknown>;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationList {
+    nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationList;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationList;
+
+// @public
+export type OverallValidationStatus = "AllValidToProceed" | "InputsRevisitRequired" | "CertainInputValidationsSkipped";
+
+// @public
+export interface PackageCarrierDetails {
+    carrierAccountNumber?: string;
+    carrierName?: string;
+    trackingId?: string;
+}
+
+// @public
+export interface PackageCarrierInfo {
+    carrierName?: string;
+    trackingId?: string;
+}
+
+// @public
+export interface PackageShippingDetails {
+    readonly carrierName?: string;
+    readonly trackingId?: string;
+    readonly trackingUrl?: string;
+}
+
+// @public
+export interface Preferences {
+    encryptionPreferences?: EncryptionPreferences;
+    preferredDataCenterRegion?: string[];
+    transportPreferences?: TransportPreferences;
+}
+
+// @public
+export type PreferencesValidationRequest = ValidationInputRequest & {
+    validationType: "ValidatePreferences";
+    preference?: Preferences;
+    deviceType: SkuName;
+};
+
+// @public
+export type PreferencesValidationResponseProperties = ValidationInputResponse & {
+    validationType: "ValidatePreferences";
+    readonly status?: ValidationStatus;
+};
+
+// @public
+export interface RegionConfigurationRequest {
+    datacenterAddressRequest?: DatacenterAddressRequest;
+    scheduleAvailabilityRequest?: ScheduleAvailabilityRequestUnion;
+    transportAvailabilityRequest?: TransportAvailabilityRequest;
+}
+
+// @public
+export interface RegionConfigurationResponse {
+    readonly datacenterAddressResponse?: DatacenterAddressResponseUnion;
+    readonly scheduleAvailabilityResponse?: ScheduleAvailabilityResponse;
+    readonly transportAvailabilityResponse?: TransportAvailabilityResponse;
+}
+
+// @public
+export interface Resource {
+    identity?: ResourceIdentity;
+    location: string;
+    sku: Sku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface ResourceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: string;
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity;
+    };
+}
+
+// @public
+export interface ScheduleAvailabilityRequest {
+    country?: string;
+    skuName: "DataBox" | "DataBoxDisk" | "DataBoxHeavy";
+    storageLocation: string;
+}
+
+// @public (undocumented)
+export type ScheduleAvailabilityRequestUnion = ScheduleAvailabilityRequest | DataBoxScheduleAvailabilityRequest | DiskScheduleAvailabilityRequest | HeavyScheduleAvailabilityRequest;
+
+// @public
+export interface ScheduleAvailabilityResponse {
+    readonly availableDates?: Date[];
+}
+
+// @public
+export interface Service {
+    listAvailableSkusByResourceGroup(resourceGroupName: string, location: string, availableSkuRequest: AvailableSkuRequest, options?: ServiceListAvailableSkusByResourceGroupOptionalParams): PagedAsyncIterableIterator<SkuInformation>;
+    regionConfiguration(location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationOptionalParams): Promise<ServiceRegionConfigurationResponse>;
+    regionConfigurationByResourceGroup(resourceGroupName: string, location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationByResourceGroupOptionalParams): Promise<ServiceRegionConfigurationByResourceGroupResponse>;
+    validateAddress(location: string, validateAddress: ValidateAddress, options?: ServiceValidateAddressOptionalParams): Promise<ServiceValidateAddressResponse>;
+    validateInputs(location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsOptionalParams): Promise<ServiceValidateInputsResponse>;
+    validateInputsByResourceGroup(resourceGroupName: string, location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsByResourceGroupOptionalParams): Promise<ServiceValidateInputsByResourceGroupResponse>;
+}
+
+// @public
+export interface ServiceListAvailableSkusByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceListAvailableSkusByResourceGroupNextResponse = AvailableSkusResult;
+
+// @public
+export interface ServiceListAvailableSkusByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceListAvailableSkusByResourceGroupResponse = AvailableSkusResult;
+
+// @public
+export interface ServiceRegionConfigurationByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceRegionConfigurationByResourceGroupResponse = RegionConfigurationResponse;
+
+// @public
+export interface ServiceRegionConfigurationOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceRegionConfigurationResponse = RegionConfigurationResponse;
+
+// @public
+export interface ServiceValidateAddressOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceValidateAddressResponse = AddressValidationOutput;
+
+// @public
+export interface ServiceValidateInputsByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceValidateInputsByResourceGroupResponse = ValidationResponse;
+
+// @public
+export interface ServiceValidateInputsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceValidateInputsResponse = ValidationResponse;
+
+// @public
+export interface ShareCredentialDetails {
+    readonly password?: string;
+    readonly shareName?: string;
+    readonly shareType?: ShareDestinationFormatType;
+    readonly supportedAccessProtocols?: AccessProtocol[];
+    readonly userName?: string;
+}
+
+// @public
+export type ShareDestinationFormatType = "UnknownType" | "HCS" | "BlockBlob" | "PageBlob" | "AzureFile" | "ManagedDisk";
+
+// @public
+export interface ShipmentPickUpRequest {
+    endTime: Date;
+    shipmentLocation: string;
+    startTime: Date;
+}
+
+// @public
+export interface ShipmentPickUpResponse {
+    readonly confirmationNumber?: string;
+    readonly readyByTime?: Date;
+}
+
+// @public
+export interface ShippingAddress {
+    addressType?: AddressType;
+    city?: string;
+    companyName?: string;
+    country: string;
+    postalCode?: string;
+    stateOrProvince?: string;
+    streetAddress1: string;
+    streetAddress2?: string;
+    streetAddress3?: string;
+    zipExtendedCode?: string;
+}
+
+// @public
+export interface Sku {
+    displayName?: string;
+    family?: string;
+    name: SkuName;
+}
+
+// @public
+export type SkuAvailabilityValidationRequest = ValidationInputRequest & {
+    validationType: "ValidateSkuAvailability";
+    deviceType: SkuName;
+    transferType: TransferType;
+    country: string;
+    location: string;
+};
+
+// @public
+export type SkuAvailabilityValidationResponseProperties = ValidationInputResponse & {
+    validationType: "ValidateSkuAvailability";
+    readonly status?: ValidationStatus;
+};
+
+// @public
+export interface SkuCapacity {
+    readonly maximum?: string;
+    readonly usable?: string;
+}
+
+// @public
+export interface SkuCost {
+    readonly meterId?: string;
+    readonly meterType?: string;
+    readonly multiplier?: number;
+}
+
+// @public
+export type SkuDisabledReason = "None" | "Country" | "Region" | "Feature" | "OfferType" | "NoSubscriptionInfo";
+
+// @public
+export interface SkuInformation {
+    readonly apiVersions?: string[];
+    readonly capacity?: SkuCapacity;
+    readonly costs?: SkuCost[];
+    readonly dataLocationToServiceLocationMap?: DataLocationToServiceLocationMap[];
+    readonly disabledReason?: SkuDisabledReason;
+    readonly disabledReasonMessage?: string;
+    readonly enabled?: boolean;
+    readonly requiredFeature?: string;
+    readonly sku?: Sku;
+}
+
+// @public
+export type SkuName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
+
+// @public
+export type StageName = string;
+
+// @public
+export type StageStatus = "None" | "InProgress" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "SucceededWithErrors" | "WaitingForCustomerAction" | "SucceededWithWarnings" | "WaitingForCustomerActionForKek" | "WaitingForCustomerActionForCleanUp" | "CustomerActionPerformedForCleanUp";
+
+// @public
+export type StorageAccountDetails = DataAccountDetails & {
+    dataAccountType: "StorageAccount";
+    storageAccountId: string;
+};
+
+// @public
+export type SubscriptionIsAllowedToCreateJobValidationRequest = ValidationInputRequest & {
+    validationType: "ValidateSubscriptionIsAllowedToCreateJob";
+};
+
+// @public
+export type SubscriptionIsAllowedToCreateJobValidationResponseProperties = ValidationInputResponse & {
+    validationType: "ValidateSubscriptionIsAllowedToCreateJob";
+    readonly status?: ValidationStatus;
+};
+
+// @public
+export interface SystemData {
+    readonly createdAt?: Date;
+    readonly createdBy?: string;
+    readonly createdByType?: string;
+    readonly lastModifiedAt?: Date;
+    readonly lastModifiedBy?: string;
+    readonly lastModifiedByType?: string;
+}
+
+// @public
+export interface TransferAllDetails {
+    dataAccountType: DataAccountType;
+    transferAllBlobs?: boolean;
+    transferAllFiles?: boolean;
+}
+
+// @public
+export interface TransferConfiguration {
+    transferAllDetails?: TransferConfigurationTransferAllDetails;
+    transferConfigurationType: TransferConfigurationType;
+    transferFilterDetails?: TransferConfigurationTransferFilterDetails;
+}
+
+// @public
+export interface TransferConfigurationTransferAllDetails {
+    include?: TransferAllDetails;
+}
+
+// @public
+export interface TransferConfigurationTransferFilterDetails {
+    include?: TransferFilterDetails;
+}
+
+// @public
+export type TransferConfigurationType = "TransferAll" | "TransferUsingFilter";
+
+// @public
+export interface TransferFilterDetails {
+    azureFileFilterDetails?: AzureFileFilterDetails;
+    blobFilterDetails?: BlobFilterDetails;
+    dataAccountType: DataAccountType;
+    filterFileDetails?: FilterFileDetails[];
+}
+
+// @public
+export type TransferType = "ImportToAzure" | "ExportFromAzure";
+
+// @public
+export interface TransportAvailabilityDetails {
+    readonly shipmentType?: TransportShipmentTypes;
+}
+
+// @public
+export interface TransportAvailabilityRequest {
+    skuName?: SkuName;
+}
+
+// @public
+export interface TransportAvailabilityResponse {
+    readonly transportAvailabilityDetails?: TransportAvailabilityDetails[];
+}
+
+// @public
+export interface TransportPreferences {
+    preferredShipmentType: TransportShipmentTypes;
+}
+
+// @public
+export type TransportShipmentTypes = "CustomerManaged" | "MicrosoftManaged";
+
+// @public
+export interface UnencryptedCredentials {
+    readonly jobName?: string;
+    readonly jobSecrets?: JobSecretsUnion;
+}
+
+// @public
+export interface UnencryptedCredentialsList {
+    nextLink?: string;
+    value?: UnencryptedCredentials[];
+}
+
+// @public
+export interface UpdateJobDetails {
+    contactDetails?: ContactDetails;
+    keyEncryptionKey?: KeyEncryptionKey;
+    returnToCustomerPackageDetails?: PackageCarrierDetails;
+    shippingAddress?: ShippingAddress;
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// @public
+export interface UserAssignedProperties {
+    resourceId?: string;
+}
+
+// @public
+export type ValidateAddress = ValidationInputRequest & {
+    validationType: "ValidateAddress";
+    shippingAddress: ShippingAddress;
+    deviceType: SkuName;
+    transportPreferences?: TransportPreferences;
+};
+
+// @public
+export type ValidationInputDiscriminator = "ValidateAddress" | "ValidateSubscriptionIsAllowedToCreateJob" | "ValidatePreferences" | "ValidateCreateOrderLimit" | "ValidateSkuAvailability" | "ValidateDataTransferDetails";
+
+// @public
+export interface ValidationInputRequest {
+    validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
+}
+
+// @public (undocumented)
+export type ValidationInputRequestUnion = ValidationInputRequest | ValidateAddress | CreateOrderLimitForSubscriptionValidationRequest | DataTransferDetailsValidationRequest | PreferencesValidationRequest | SkuAvailabilityValidationRequest | SubscriptionIsAllowedToCreateJobValidationRequest;
+
+// @public
+export interface ValidationInputResponse {
+    readonly error?: CloudError;
+    validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
+}
+
+// @public (undocumented)
+export type ValidationInputResponseUnion = ValidationInputResponse | AddressValidationProperties | CreateOrderLimitForSubscriptionValidationResponseProperties | DataTransferDetailsValidationResponseProperties | PreferencesValidationResponseProperties | SkuAvailabilityValidationResponseProperties | SubscriptionIsAllowedToCreateJobValidationResponseProperties;
+
+// @public
+export interface ValidationRequest {
+    individualRequestDetails: ValidationInputRequestUnion[];
+    validationCategory: "JobCreationValidation";
+}
+
+// @public (undocumented)
+export type ValidationRequestUnion = ValidationRequest | CreateJobValidations;
+
+// @public
+export interface ValidationResponse {
+    readonly individualResponseDetails?: ValidationInputResponseUnion[];
+    readonly status?: OverallValidationStatus;
+}
+
+// @public
+export type ValidationStatus = "Valid" | "Invalid" | "Skipped";
+
+// (No @packageDocumentation comment for this package)
+
+```