@azure/arm-databox package

Credential details of the account.

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

Output of the address validation api.

The address validation output.

model interface ApiError

The Network Adapter configuration of a DataBox.

The filters for showing the available skus.

Filter details to transfer Azure files

Filter details to transfer Azure Blobs

Reason for cancellation.

Provides additional information about an http error response.

Contact Details.

Contact Info.

Details for log generated during copy.

Copy progress.

It does all pre-job creation validations.

Request to validate create order limit for current subscription.

Properties of create order limit for subscription validation response.

The secrets related to customer disk job.

Account details of the data to be transferred

Copy log details for a storage account of a DataBox job

Copy Log Details for customer disk

DataBox CustomerDisk Copy Progress

Customer disk job details.

Copy Log Details for a disk

DataBox Disk Copy Progress

Granular Copy Log Details for customer disk

DataBox Disk Granular Copy Progress

DataBox Disk Job Details.

The secrets related to disk job.

Copy log details for a storage account for Databox heavy

Databox Heavy Device Job Details

The secrets related to a databox heavy job.

The secrets related to a databox heavy.

Databox Job Details

Optional parameters for the client.

Request body to get the availability for scheduling data box orders orders.

The secrets related to a DataBox.

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

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

Map of data location to service location

Request to validate export and import data details.

Properties of data transfer details validation response.

The secrets related to a databox job.

Datacenter instruction for given storage location.

Datacenter address for given storage location.

Request body to get the datacenter address.

Datacenter address for given storage location.

Dc access security code

model interface Details

Device capability details for a given sku for a given region.

Request body to get the device capabilities for given sku.

Device capabilities for given sku in a region

Device erasure details with erasure completion status, secure erasure sas key and erasureordestructionlog sas key

Request body to get the availability for scheduling disk orders.

Contains all the secrets of a Disk.

Preferences related to the Encryption.

model interface ErrorDetail

Export disk details

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

Granular Details for log generated during copy.

Granular Copy progress.

Request body to get the availability for scheduling heavy orders.

Managed identity properties.

Import disk details

Job Delay Notification details

Additional delivery info.

Job details.

Job Properties

Job Resource.

The JobResourceUpdateParameter.

The base class for the secrets

Job stages.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Jobs operations.

Optional parameters.

Encryption key containing details about key to encrypt different keys.

Last Mitigation Action Performed On Job

Details of the managed disks.

The request body to provide the delivery package details of job

The Mitigate Job captured from request body for Mitigate API

Optional parameters.

Notification preference for a job stage.

Operation entity.

Operation display

Optional parameters.

Interface representing a Operations operations.

Package carrier details.

package carrier info

package shipping details

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

Preferences related to the order

Request to validate preference of transport and data center.

Properties of data center and transport preference validation response.

Request body to get the configuration for the region.

Configuration response specific to a region.

Common fields that are returned in the response for all Azure Resource Manager resources

Msi identity details of the resource

Reverse Shipping Address and contact details for a job.

Request body to get the availability for scheduling orders.

Schedule availability for given sku in a region.

Optional parameters.

Interface representing a Service operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Credential details of the shares in account.

Shipment pick up request details.

Shipment pick up response.

Shipping address where customer wishes to receive the device.

A simple poller that can be used to poll a long running operation.

The Sku.

Request to validate sku availability.

Properties of sku availability validation response.

Capacity of the sku.

Describes metadata for retrieving price info.

Information of the sku.

Properties of the sku.

Details for the storage account.

Request to validate subscription permission to create jobs.

Properties of subscription permission to create job validation response.

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Details to transfer all data.

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.

Details of the filtering the transfer of data.

Transport options availability details for given region.

Request body to get the transport availability for given sku.

Transport options available for given sku in a region.

Preferences related to the shipment logistics of the sku

Unencrypted credentials for accessing device.

Job details for update.

Job Properties for update

User assigned identity properties

User assigned identity properties.

The requirements to validate customer address where the device needs to be shipped.

Minimum fields that must be present in any type of validation request.

Minimum properties that should be present in each individual validation response.

Minimum request requirement of any validation category.

Response of pre job creation validations.

Properties of pre job creation validation response.

Access protocols supported on the device.

Type of address.

The address validation status.

The supported values for cloud setting as a string literal type

Indicates the type of job details.

An interface that describes a page of results.

Alias for CopyLogDetailsUnion

The Status of the copy
KnownCopyStatus can be used interchangeably with CopyStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: Data copy hasn't started yet.
InProgress: Data copy is in progress.
Completed: Data copy completed.
CompletedWithErrors: Data copy completed with errors.
Failed: Data copy failed. No data was copied.
NotReturned: No copy triggered as device was not returned.
HardwareError: The Device has hit hardware issues.
DeviceFormatted: Data copy failed. The Device was formatted by user.
DeviceMetadataModified: Data copy failed. Device metadata was modified by user.
StorageAccountNotAccessible: Data copy failed. Storage Account was not accessible during copy.
UnsupportedData: Data copy failed. The Device data content is not supported.
DriveNotReceived: No copy triggered as device was not received.
UnsupportedDrive: No copy triggered as device type is not supported.
OtherServiceError: Copy failed due to service error.
OtherUserError: Copy failed due to user error.
DriveNotDetected: Copy failed due to disk detection error.
DriveCorrupted: Copy failed due to corrupted drive.
MetadataFilesModifiedOrRemoved: Copy failed due to modified or removed metadata files.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Resolution code provided by customer.

Alias for DataAccountDetailsUnion

Type of the account.

DataCenter code.
KnownDataCenterCode can be used interchangeably with DataCenterCode, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
BY2
BY1
ORK70
AM2
AMS20
BY21
BY24
MWH01
AMS06
SSE90
SYD03
SYD23
CBR20
YTO20
CWL20
LON24
BOM01
BL20
BL7
SEL20
TYO01
BN1
SN5
CYS04
TYO22
YTO21
YQB20
FRA22
MAA01
CPQ02
CPQ20
SIN20
HKG20
SG2
MEL23
SEL21
OSA20
SHA03
BJB
JNB22
JNB21
MNZ21
SN8
AUH20
ZRH20
PUS20
AdHoc
CH1
DSM05
DUB07
PNQ01
SVG20
OSA02
OSA22
PAR22
BN7
SN6
BJS20
BL24
IDC5
TYO23
NTG20
DXB23
DSM11
AMS25
CPQ21
OSA23

Alias for DatacenterAddressResponseUnion

Data center address type

Status of notification
KnownDelayNotificationStatus can be used interchangeably with DelayNotificationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: Delay is still active
Resolved: Delay has been resolved

Defines secondary layer of software-based encryption enablement.

Type of the filter file.

Alias for GranularCopyLogDetailsUnion

Hardware encryption support for a given sku for a given region.

Delivery type of Job.

Alias for JobDetailsUnion

Alias for JobSecretsUnion

Type of encryption key used for key encryption.

Level of the logs to be collected.

The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025

Name of the stage.
KnownNotificationStageName can be used interchangeably with NotificationStageName, this enum contains the known values that the service supports.

Known values supported by the service

DevicePrepared: Notification at device prepared stage.
Dispatched: Notification at device dispatched stage.
Delivered: Notification at device delivered stage.
PickedUp: Notification at device picked up from user stage.
AtAzureDC: Notification at device received at Azure datacenter stage.
DataCopy: Notification at data copy started stage.
Created: Notification at job created stage.
ShippedToCustomer: Notification at shipped devices to customer stage.

Overall validation status.

Delay Error code
KnownPortalDelayErrorCode can be used interchangeably with PortalDelayErrorCode, this enum contains the known values that the service supports.

Known values supported by the service

InternalIssueDelay: Delay due to any internal reasons
ActiveOrderLimitBreachedDelay: Active Order limit breached.
HighDemandDelay: High demand
LargeNumberOfFilesDelay: Slow copy due to large number of files

The Editable status for Reverse Shipping Address and Contact Info

The Editable status for Reverse Transport preferences

Alias for ScheduleAvailabilityRequestUnion

Type of the share.

Reason why the Sku is disabled.

SKU names.

Name of the stage which is in progress.
KnownStageName can be used interchangeably with StageName, this enum contains the known values that the service supports.

Known values supported by the service

DeviceOrdered: An order has been created.
DevicePrepared: A device has been prepared for the order.
Dispatched: Device has been dispatched to the user of the order.
Delivered: Device has been delivered to the user of the order.
PickedUp: Device has been picked up from user and in transit to Azure datacenter.
AtAzureDC: Device has been received at Azure datacenter from the user.
DataCopy: Data copy from the device at Azure datacenter.
Completed: Order has completed.
CompletedWithErrors: Order has completed with errors.
Cancelled: Order has been cancelled.
Failed_IssueReportedAtCustomer: Order has failed due to issue reported by user.
Failed_IssueDetectedAtAzureDC: Order has failed due to issue detected at Azure datacenter.
Aborted: Order has been aborted.
CompletedWithWarnings: Order has completed with warnings.
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC.
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC.
Created: Job created by the customer.
ShippedToAzureDC: User shipped the device to AzureDC.
AwaitingShipmentDetails: Awaiting shipment details of device from customer.
PreparingToShipFromAzureDC: Preparing the device to ship to customer.
ShippedToCustomer: Shipped the device to customer.

Holds the device erasure completion status

Type of the configuration for transfer.

Type of the transfer.

Transport Shipment Type supported for given region.

Identifies the type of validation request.

Alias for ValidationInputRequestUnion

Alias for ValidationInputResponseUnion

Alias for ValidationRequestUnion

Create order limit validation status.

An enum to describe Azure Cloud environments.

The Status of the copy

The kind of entity that created the resource.

DataCenter code.

Status of notification

Name of the stage.

Delay Error code

Name of the stage which is in progress.

The available API versions.

Typeguard for RestError

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

A custom error type for failed pipeline requests.