@azure/arm-databox package

Classes

DataBoxManagementClient

Interfaces

AccountCredentialDetails	Credential details of the account.
AdditionalErrorInfo	This class represents additional info which Resource Providers pass when an error occurs.
AddressValidationOutput	Output of the address validation api.
AddressValidationProperties	The address validation output.
ApiError
ApplianceNetworkConfiguration	The Network Adapter configuration of a DataBox.
ArmBaseObject	Base class for all objects under resource.
AvailableSkuRequest	The filters for showing the available skus.
AvailableSkusResult	The available skus operation response.
AzureFileFilterDetails	Filter details to transfer Azure files
BlobFilterDetails	Filter details to transfer Azure Blobs
CancellationReason	Reason for cancellation.
CloudError	Provides additional information about an http error response.
ContactDetails	Contact Details.
ContactInfo	Contact Info.
CopyLogDetails	Details for log generated during copy.
CopyProgress	Copy progress.
CreateJobValidations	It does all pre-job creation validations.
CreateOrderLimitForSubscriptionValidationRequest	Request to validate create order limit for current subscription.
CreateOrderLimitForSubscriptionValidationResponseProperties	Properties of create order limit for subscription validation response.
CustomerDiskJobSecrets	The secrets related to customer disk job.
DataAccountDetails	Account details of the data to be transferred
DataBoxAccountCopyLogDetails	Copy log details for a storage account of a DataBox job
DataBoxCustomerDiskCopyLogDetails	Copy Log Details for customer disk
DataBoxCustomerDiskCopyProgress	DataBox CustomerDisk Copy Progress
DataBoxCustomerDiskJobDetails	Customer disk job details.
DataBoxDiskCopyLogDetails	Copy Log Details for a disk
DataBoxDiskCopyProgress	DataBox Disk Copy Progress
DataBoxDiskGranularCopyLogDetails	Granular Copy Log Details for customer disk
DataBoxDiskGranularCopyProgress	DataBox Disk Granular Copy Progress
DataBoxDiskJobDetails	DataBox Disk Job Details.
DataBoxDiskJobSecrets	The secrets related to disk job.
DataBoxHeavyAccountCopyLogDetails	Copy log details for a storage account for Databox heavy
DataBoxHeavyJobDetails	Databox Heavy Device Job Details
DataBoxHeavyJobSecrets	The secrets related to a databox heavy job.
DataBoxHeavySecret	The secrets related to a databox heavy.
DataBoxJobDetails	Databox Job Details
DataBoxManagementClientOptionalParams	Optional parameters.
DataBoxScheduleAvailabilityRequest	Request body to get the availability for scheduling data box orders orders.
DataBoxSecret	The secrets related to a DataBox.
DataExportDetails	Details of the data to be used for exporting data from azure.
DataImportDetails	Details of the data to be used for importing data to azure.
DataLocationToServiceLocationMap	Map of data location to service location
DataTransferDetailsValidationRequest	Request to validate export and import data details.
DataTransferDetailsValidationResponseProperties	Properties of data transfer details validation response.
DataboxJobSecrets	The secrets related to a databox job.
DatacenterAddressInstructionResponse	Datacenter instruction for given storage location.
DatacenterAddressLocationResponse	Datacenter address for given storage location.
DatacenterAddressRequest	Request body to get the datacenter address.
DatacenterAddressResponse	Datacenter address for given storage location.
DcAccessSecurityCode	Dc access security code
Details
DeviceErasureDetails	Device erasure details with erasure completion status and erasureordestructionlog sas key
DiskScheduleAvailabilityRequest	Request body to get the availability for scheduling disk orders.
DiskSecret	Contains all the secrets of a Disk.
EncryptionPreferences	Preferences related to the Encryption.
ErrorDetail
ExportDiskDetails	Export disk details
FilterFileDetails	Details of the filter files to be used for data transfer.
GranularCopyLogDetails	Granular Details for log generated during copy.
GranularCopyProgress	Granular Copy progress.
HeavyScheduleAvailabilityRequest	Request body to get the availability for scheduling heavy orders.
IdentityProperties	Managed identity properties.
ImportDiskDetails	Import disk details
JobDeliveryInfo	Additional delivery info.
JobDetails	Job details.
JobResource	Job Resource.
JobResourceList	Job Resource Collection
JobResourceUpdateParameter	The JobResourceUpdateParameter.
JobSecrets	The base class for the secrets
JobStages	Job stages.
Jobs	Interface representing a Jobs.
JobsBookShipmentPickUpOptionalParams	Optional parameters.
JobsCancelOptionalParams	Optional parameters.
JobsCreateOptionalParams	Optional parameters.
JobsDeleteHeaders	Defines headers for Jobs_delete operation.
JobsDeleteOptionalParams	Optional parameters.
JobsGetOptionalParams	Optional parameters.
JobsListByResourceGroupNextOptionalParams	Optional parameters.
JobsListByResourceGroupOptionalParams	Optional parameters.
JobsListCredentialsOptionalParams	Optional parameters.
JobsListNextOptionalParams	Optional parameters.
JobsListOptionalParams	Optional parameters.
JobsMarkDevicesShippedOptionalParams	Optional parameters.
JobsUpdateHeaders	Defines headers for Jobs_update operation.
JobsUpdateOptionalParams	Optional parameters.
KeyEncryptionKey	Encryption key containing details about key to encrypt different keys.
LastMitigationActionOnJob	Last Mitigation Action Performed On Job
ManagedDiskDetails	Details of the managed disks.
MarkDevicesShippedRequest	The request body to provide the delivery package details of job
MitigateJobRequest	The Mitigate Job captured from request body for Mitigate API
MitigateOptionalParams	Optional parameters.
NotificationPreference	Notification preference for a job stage.
Operation	Operation entity.
OperationDisplay	Operation display
OperationList	Operation Collection.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PackageCarrierDetails	Package carrier details.
PackageCarrierInfo	package carrier info
PackageShippingDetails	package shipping details
Preferences	Preferences related to the order
PreferencesValidationRequest	Request to validate preference of transport and data center.
PreferencesValidationResponseProperties	Properties of data center and transport preference validation response.
RegionConfigurationRequest	Request body to get the configuration for the region.
RegionConfigurationResponse	Configuration response specific to a region.
Resource	Model of the Resource.
ResourceIdentity	Msi identity details of the resource
ReverseShippingDetails	Reverse Shipping Address and contact details for a job.
ScheduleAvailabilityRequest	Request body to get the availability for scheduling orders.
ScheduleAvailabilityResponse	Schedule availability for given sku in a region.
Service	Interface representing a Service.
ServiceListAvailableSkusByResourceGroupNextOptionalParams	Optional parameters.
ServiceListAvailableSkusByResourceGroupOptionalParams	Optional parameters.
ServiceRegionConfigurationByResourceGroupOptionalParams	Optional parameters.
ServiceRegionConfigurationOptionalParams	Optional parameters.
ServiceValidateAddressOptionalParams	Optional parameters.
ServiceValidateInputsByResourceGroupOptionalParams	Optional parameters.
ServiceValidateInputsOptionalParams	Optional parameters.
ShareCredentialDetails	Credential details of the shares in account.
ShipmentPickUpRequest	Shipment pick up request details.
ShipmentPickUpResponse	Shipment pick up response.
ShippingAddress	Shipping address where customer wishes to receive the device.
Sku	The Sku.
SkuAvailabilityValidationRequest	Request to validate sku availability.
SkuAvailabilityValidationResponseProperties	Properties of sku availability validation response.
SkuCapacity	Capacity of the sku.
SkuCost	Describes metadata for retrieving price info.
SkuInformation	Information of the sku.
StorageAccountDetails	Details for the storage account.
SubscriptionIsAllowedToCreateJobValidationRequest	Request to validate subscription permission to create jobs.
SubscriptionIsAllowedToCreateJobValidationResponseProperties	Properties of subscription permission to create job validation response.
SystemData	Provides details about resource creation and update time
TransferAllDetails	Details to transfer all data.
TransferConfiguration	Configuration for defining the transfer of data.
TransferConfigurationTransferAllDetails	Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll
TransferConfigurationTransferFilterDetails	Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter.
TransferFilterDetails	Details of the filtering the transfer of data.
TransportAvailabilityDetails	Transport options availability details for given region.
TransportAvailabilityRequest	Request body to get the transport availability for given sku.
TransportAvailabilityResponse	Transport options available for given sku in a region.
TransportPreferences	Preferences related to the shipment logistics of the sku
UnencryptedCredentials	Unencrypted credentials for accessing device.
UnencryptedCredentialsList	List of unencrypted credentials for accessing device.
UpdateJobDetails	Job details for update.
UserAssignedIdentity	Class defining User assigned identity details.
UserAssignedProperties	User assigned identity properties.
ValidateAddress	The requirements to validate customer address where the device needs to be shipped.
ValidationInputRequest	Minimum fields that must be present in any type of validation request.
ValidationInputResponse	Minimum properties that should be present in each individual validation response.
ValidationRequest	Minimum request requirement of any validation category.
ValidationResponse	Response of pre job creation validations.

Type Aliases

AccessProtocol	Defines values for AccessProtocol.
AddressType	Defines values for AddressType.
AddressValidationStatus	Defines values for AddressValidationStatus.
ClassDiscriminator	Defines values for ClassDiscriminator.
CopyLogDetailsUnion
CopyStatus	Defines values for CopyStatus. 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.
CustomerResolutionCode	Defines values for CustomerResolutionCode.
DataAccountDetailsUnion
DataAccountType	Defines values for DataAccountType.
DataCenterCode	Defines values for DataCenterCode. 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
DatacenterAddressResponseUnion
DatacenterAddressType	Defines values for DatacenterAddressType.
DoubleEncryption	Defines values for DoubleEncryption.
FilterFileType	Defines values for FilterFileType.
GranularCopyLogDetailsUnion
HardwareEncryption	Defines values for HardwareEncryption.
JobDeliveryType	Defines values for JobDeliveryType.
JobDetailsUnion
JobSecretsUnion
JobsBookShipmentPickUpResponse	Contains response data for the bookShipmentPickUp operation.
JobsCreateResponse	Contains response data for the create operation.
JobsGetResponse	Contains response data for the get operation.
JobsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
JobsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
JobsListCredentialsResponse	Contains response data for the listCredentials operation.
JobsListNextResponse	Contains response data for the listNext operation.
JobsListResponse	Contains response data for the list operation.
JobsUpdateResponse	Contains response data for the update operation.
KekType	Defines values for KekType.
LogCollectionLevel	Defines values for LogCollectionLevel.
NotificationStageName	Defines values for NotificationStageName. 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.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
OverallValidationStatus	Defines values for OverallValidationStatus.
ReverseShippingDetailsEditStatus	Defines values for ReverseShippingDetailsEditStatus.
ReverseTransportPreferenceEditStatus	Defines values for ReverseTransportPreferenceEditStatus.
ScheduleAvailabilityRequestUnion
ServiceListAvailableSkusByResourceGroupNextResponse	Contains response data for the listAvailableSkusByResourceGroupNext operation.
ServiceListAvailableSkusByResourceGroupResponse	Contains response data for the listAvailableSkusByResourceGroup operation.
ServiceRegionConfigurationByResourceGroupResponse	Contains response data for the regionConfigurationByResourceGroup operation.
ServiceRegionConfigurationResponse	Contains response data for the regionConfiguration operation.
ServiceValidateAddressResponse	Contains response data for the validateAddress operation.
ServiceValidateInputsByResourceGroupResponse	Contains response data for the validateInputsByResourceGroup operation.
ServiceValidateInputsResponse	Contains response data for the validateInputs operation.
ShareDestinationFormatType	Defines values for ShareDestinationFormatType.
SkuDisabledReason	Defines values for SkuDisabledReason.
SkuName	Defines values for SkuName.
StageName	Defines values for StageName. 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.
StageStatus	Defines values for StageStatus.
TransferConfigurationType	Defines values for TransferConfigurationType.
TransferType	Defines values for TransferType.
TransportShipmentTypes	Defines values for TransportShipmentTypes.
ValidationInputDiscriminator	Defines values for ValidationInputDiscriminator.
ValidationInputRequestUnion
ValidationInputResponseUnion
ValidationRequestUnion
ValidationStatus	Defines values for ValidationStatus.

Enums

KnownCopyStatus	Known values of CopyStatus that the service accepts.
KnownDataCenterCode	Known values of DataCenterCode that the service accepts.
KnownNotificationStageName	Known values of NotificationStageName that the service accepts.
KnownStageName	Known values of StageName that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.