@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 | |
| DeviceCapabilityDetails |
Device capability details for a given sku for a given region. |
| DeviceCapabilityRequest |
Request body to get the device capabilities for given sku. |
| DeviceCapabilityResponse |
Device capabilities for given sku in a region |
| 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 |
| JobDelayDetails |
Job Delay Notification 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. Known values supported by the serviceNotStarted: Data copy hasn't started yet. |
| CustomerResolutionCode |
Defines values for CustomerResolutionCode. |
| DataAccountDetailsUnion | |
| DataAccountType |
Defines values for DataAccountType. |
| DataCenterCode |
Defines values for DataCenterCode. Known values supported by the serviceInvalid |
| DatacenterAddressResponseUnion | |
| DatacenterAddressType |
Defines values for DatacenterAddressType. |
| DelayNotificationStatus |
Defines values for DelayNotificationStatus. Known values supported by the serviceActive: Delay is still active |
| 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. |
| ModelName |
Defines values for ModelName. |
| NotificationStageName |
Defines values for NotificationStageName. Known values supported by the serviceDevicePrepared: Notification at device prepared stage. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| OverallValidationStatus |
Defines values for OverallValidationStatus. |
| PortalDelayErrorCode |
Defines values for PortalDelayErrorCode. Known values supported by the serviceInternalIssueDelay: Delay due to any internal reasons |
| 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. Known values supported by the serviceDeviceOrdered: An order has been created. |
| 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. |
| KnownDelayNotificationStatus |
Known values of DelayNotificationStatus that the service accepts. |
| KnownNotificationStageName |
Known values of NotificationStageName that the service accepts. |
| KnownPortalDelayErrorCode |
Known values of PortalDelayErrorCode that the service accepts. |
| KnownStageName |
Known values of StageName that the service accepts. |
Functions
| get |
Given the last |
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.