# Packages
No description provided by the author
# Functions
New creates an instance of the BaseClient client.
Creates a new instance of the AvailableSkusResultIterator type.
Creates a new instance of the AvailableSkusResultPage type.
Creates a new instance of the JobResourceListIterator type.
Creates a new instance of the JobResourceListPage type.
NewJobsClient creates an instance of the JobsClient client.
NewJobsClientWithBaseURI creates an instance of the JobsClient client using a custom endpoint.
Creates a new instance of the OperationListIterator type.
Creates a new instance of the OperationListPage type.
NewOperationsClient creates an instance of the OperationsClient client.
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint.
NewServiceClient creates an instance of the ServiceClient client.
NewServiceClientWithBaseURI creates an instance of the ServiceClient client using a custom endpoint.
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint.
PossibleAccessProtocolValues returns an array of possible values for the AccessProtocol const type.
PossibleAddressTypeValues returns an array of possible values for the AddressType const type.
PossibleAddressValidationStatusValues returns an array of possible values for the AddressValidationStatus const type.
PossibleCopyLogDetailsTypeValues returns an array of possible values for the CopyLogDetailsType const type.
PossibleCopyStatusValues returns an array of possible values for the CopyStatus const type.
PossibleDataAccountTypeBasicDataAccountDetailsValues returns an array of possible values for the DataAccountTypeBasicDataAccountDetails const type.
PossibleDataAccountTypeValues returns an array of possible values for the DataAccountType const type.
PossibleDoubleEncryptionValues returns an array of possible values for the DoubleEncryption const type.
PossibleFilterFileTypeValues returns an array of possible values for the FilterFileType const type.
PossibleJobDeliveryTypeValues returns an array of possible values for the JobDeliveryType const type.
PossibleJobDetailsTypeEnumValues returns an array of possible values for the JobDetailsTypeEnum const type.
PossibleJobSecretsTypeEnumValues returns an array of possible values for the JobSecretsTypeEnum const type.
PossibleKekTypeValues returns an array of possible values for the KekType const type.
PossibleLogCollectionLevelValues returns an array of possible values for the LogCollectionLevel const type.
PossibleNotificationStageNameValues returns an array of possible values for the NotificationStageName const type.
PossibleOverallValidationStatusValues returns an array of possible values for the OverallValidationStatus const type.
PossibleShareDestinationFormatTypeValues returns an array of possible values for the ShareDestinationFormatType const type.
PossibleSkuDisabledReasonValues returns an array of possible values for the SkuDisabledReason const type.
PossibleSkuNameBasicScheduleAvailabilityRequestValues returns an array of possible values for the SkuNameBasicScheduleAvailabilityRequest const type.
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
PossibleStageNameValues returns an array of possible values for the StageName const type.
PossibleStageStatusValues returns an array of possible values for the StageStatus const type.
PossibleTransferConfigurationTypeValues returns an array of possible values for the TransferConfigurationType const type.
PossibleTransferTypeValues returns an array of possible values for the TransferType const type.
PossibleTransportShipmentTypesValues returns an array of possible values for the TransportShipmentTypes const type.
PossibleValidationCategoryValues returns an array of possible values for the ValidationCategory const type.
PossibleValidationStatusValues returns an array of possible values for the ValidationStatus const type.
PossibleValidationTypeBasicValidationInputResponseValues returns an array of possible values for the ValidationTypeBasicValidationInputResponse const type.
PossibleValidationTypeValues returns an array of possible values for the ValidationType const type.
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
# Constants
AllValidToProceed Every input request is valid.
Ambiguous Address provided is ambiguous, please choose one of the alternate addresses returned.
AtAzureDC Notification at device received at Azure datacenter stage.
AzureBlob Filter file is of the type AzureBlob.
AzureFile Filter file is of the type AzureFiles.
CertainInputValidationsSkipped Certain input validations skipped.
Commercial Commercial Address.
Completed Data copy completed.
CompletedWithErrors Data copy completed with errors.
CopyLogDetailsTypeCopyLogDetails ...
CopyLogDetailsTypeDataBox ...
CopyLogDetailsTypeDataBoxDisk ...
CopyLogDetailsTypeDataBoxHeavy ...
CustomerManaged Key encryption key is managed by the Customer.
DataAccountTypeDataAccountDetails ...
DataAccountTypeManagedDisk ...
DataAccountTypeStorageAccount ...
DataBox Data Box.
DataBoxDisk Data Box Disk.
DataBoxHeavy Data Box Heavy.
DataCopy Notification at data copy started stage.
DefaultBaseURI is the default URI used for the service Databox.
Delivered Notification at device delivered stage.
DeviceFormatted Data copy failed.
DeviceMetadataModified Data copy failed.
DevicePrepared Notification at device prepared stage.
Disabled Software-based encryption is disabled.
Dispatched Notification at device dispatched stage.
Enabled Software-based encryption is enabled.
Error Only Errors will be collected in the logs.
ExportFromAzure Export data from azure.
Failed Data copy failed.
HardwareError The Device has hit hardware issues.
ImportToAzure Import data to azure.
InProgress Data copy is in progress.
InputsRevisitRequired Some input requests are not valid.
Invalid Address provided is invalid or not supported.
JobDetailsTypeDataBox ...
JobDetailsTypeDataBoxDisk ...
JobDetailsTypeDataBoxHeavy ...
JobDetailsTypeJobDetails ...
JobSecretsTypeDataBox ...
JobSecretsTypeDataBoxDisk ...
JobSecretsTypeDataBoxHeavy ...
JobSecretsTypeJobSecrets ...
ManagedDisk Azure Managed disk storage.
MicrosoftManaged Key encryption key is managed by Microsoft.
NFS Network File System protocol(NFS).
None Address type not known.
NonScheduled Non Scheduled job.
NotReturned No copy triggered as device was not returned.
NotStarted Data copy hasn't started yet.
PickedUp Notification at device picked up from user stage.
Residential Residential Address.
Scheduled Scheduled job.
ShareDestinationFormatTypeAzureFile Azure storage file format.
ShareDestinationFormatTypeAzurePremiumFiles Azure storage Premium Files format.
ShareDestinationFormatTypeBlockBlob Azure storage block blob format.
ShareDestinationFormatTypeHCS Storsimple data format.
ShareDestinationFormatTypeManagedDisk Azure Compute Disk.
ShareDestinationFormatTypePageBlob Azure storage page blob format.
ShareDestinationFormatTypeUnknownType Unknown format.
SkuDisabledReasonCountry SKU is not available in the requested country.
SkuDisabledReasonFeature Required features are not enabled for the SKU.
SkuDisabledReasonNone SKU is not disabled.
SkuDisabledReasonNoSubscriptionInfo Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification.
SkuDisabledReasonOfferType Subscription does not have required offer types for the SKU.
SkuDisabledReasonRegion SKU is not available to push data to the requested Azure region.
SkuNameDataBox ...
SkuNameDataBoxDisk ...
SkuNameDataBoxHeavy ...
SkuNameScheduleAvailabilityRequest ...
SMB Server Message Block protocol(SMB).
StageNameAborted Order has been aborted.
StageNameAtAzureDC Device has been received at Azure datacenter from the user.
StageNameCancelled Order has been cancelled.
StageNameCompleted Order has completed.
StageNameCompletedWithErrors Order has completed with errors.
StageNameCompletedWithWarnings Order has completed with warnings.
StageNameDataCopy Data copy from the device at Azure datacenter.
StageNameDelivered Device has been delivered to the user of the order.
StageNameDeviceOrdered An order has been created.
StageNameDevicePrepared A device has been prepared for the order.
StageNameDispatched Device has been dispatched to the user of the order.
StageNameFailedIssueDetectedAtAzureDC Order has failed due to issue detected at Azure datacenter.
StageNameFailedIssueReportedAtCustomer Order has failed due to issue reported by user.
StageNamePickedUp Device has been picked up from user and in transit to Azure datacenter.
StageNameReadyToDispatchFromAzureDC Device is ready to be handed to customer from Azure DC.
StageNameReadyToReceiveAtAzureDC Device can be dropped off at Azure DC.
StageStatusCancelled Stage has been cancelled.
StageStatusCancelling Stage is cancelling.
StageStatusFailed Stage has failed.
StageStatusInProgress Stage is in progress.
StageStatusNone No status available yet.
StageStatusSucceeded Stage has succeeded.
StageStatusSucceededWithErrors Stage has succeeded with errors.
StageStatusSucceededWithWarnings Stage has succeeded with warnings.
StageStatusWaitingForCustomerAction Stage is stuck until customer takes some action.
StorageAccount Storage Accounts .
StorageAccountNotAccessible Data copy failed.
TransferAll Transfer all the data.
TransferUsingFilter Transfer using filter.
TransportShipmentTypesCustomerManaged Shipment Logistics is handled by the customer.
TransportShipmentTypesMicrosoftManaged Shipment Logistics is handled by Microsoft.
UnsupportedData Data copy failed.
Valid Address provided is valid.
ValidationCategoryJobCreationValidation ...
ValidationCategoryValidationRequest ...
ValidationStatusInvalid Validation is not successful.
ValidationStatusSkipped Validation is skipped.
ValidationStatusValid Validation is successful.
ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress ...
ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit ...
ValidationTypeBasicValidationInputResponseValidationTypeValidateDataTransferDetails ...
ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences ...
ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability ...
ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob ...
ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse ...
ValidationTypeValidateAddress ...
ValidationTypeValidateCreateOrderLimit ...
ValidationTypeValidateDataTransferDetails ...
ValidationTypeValidatePreferences ...
ValidationTypeValidateSkuAvailability ...
ValidationTypeValidateSubscriptionIsAllowedToCreateJob ...
ValidationTypeValidationInputRequest ...
Verbose Verbose logging (includes Errors, CRC, size information and others).
# Structs
AccountCopyLogDetails copy log details for a storage account of a DataBox job.
AccountCredentialDetails credential details of the account.
AdditionalErrorInfo additional error info.
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.
AvailableSkusResultIterator provides access to a complete listing of SkuInformation values.
AvailableSkusResultPage contains a page of SkuInformation values.
AzureFileFilterDetails filter details to transfer Azure files.
BaseClient is the base client for Databox.
BlobFilterDetails filter details to transfer Azure Blobs.
CancellationReason reason for cancellation.
CloudError cloud error.
ContactDetails contact Details.
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.
DataAccountDetails account details of the data to be transferred.
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.
DcAccessSecurityCode dc access security code.
Details ...
DiskCopyLogDetails copy Log Details for a disk.
DiskCopyProgress dataBox Disk Copy Progress.
DiskJobDetails dataBox Disk Job Details.
DiskJobSecrets the secrets related to disk job.
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 ...
FilterFileDetails details of the filter files to be used for data transfer.
HeavyAccountCopyLogDetails copy log details for a storage account for Databox heavy.
HeavyJobDetails databox Heavy Device Job Details.
HeavyJobSecrets the secrets related to a databox heavy job.
HeavyScheduleAvailabilityRequest request body to get the availability for scheduling heavy orders.
HeavySecret the secrets related to a databox heavy.
IdentityProperties managed identity properties.
JobDeliveryInfo additional delivery info.
JobDetails job details.
JobDetailsType databox Job Details.
JobProperties job Properties.
JobResource job Resource.
JobResourceList job Resource Collection.
JobResourceListIterator provides access to a complete listing of JobResource values.
JobResourceListPage contains a page of JobResource values.
JobResourceUpdateParameter the JobResourceUpdateParameter.
JobsClient is the client for the Jobs methods of the Databox service.
JobsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
JobsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
JobSecrets the base class for the secrets.
JobSecretsType the secrets related to a databox job.
JobStages job stages.
JobsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
KeyEncryptionKey encryption key containing details about key to encrypt different keys.
ManagedDiskDetails details of the managed disks.
NotificationPreference notification preference for a job stage.
Operation operation entity.
OperationDisplay operation display.
OperationList operation Collection.
OperationListIterator provides access to a complete listing of Operation values.
OperationListPage contains a page of Operation values.
OperationsClient is the client for the Operations methods of the Databox service.
PackageShippingDetails 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.
ScheduleAvailabilityRequest request body to get the availability for scheduling orders.
ScheduleAvailabilityRequestType request body to get the availability for scheduling data box orders orders.
ScheduleAvailabilityResponse schedule availability for given sku in a region.
Secret the secrets related to a DataBox.
ServiceClient is the client for the Service methods of the Databox service.
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.
SkuProperties properties 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.
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.
TransferConfigurationTransferFilterDetails map of filter type and the details to filter.
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.
UpdateJobProperties job Properties 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.
ValidationResponseProperties properties of pre job creation validation response.
# Interfaces
BasicCopyLogDetails details for log generated during copy.
BasicDataAccountDetails account details of the data to be transferred.
BasicJobDetails job details.
BasicJobSecrets the base class for the secrets.
BasicScheduleAvailabilityRequest request body to get the availability for scheduling orders.
BasicValidationInputRequest minimum fields that must be present in any type of validation request.
BasicValidationInputResponse minimum properties that should be present in each individual validation response.
BasicValidationRequest minimum request requirement of any validation category.
# Type aliases
AccessProtocol enumerates the values for access protocol.
AddressType enumerates the values for address type.
AddressValidationStatus enumerates the values for address validation status.
CopyLogDetailsType enumerates the values for copy log details type.
CopyStatus enumerates the values for copy status.
DataAccountType enumerates the values for data account type.
DataAccountTypeBasicDataAccountDetails enumerates the values for data account type basic data account details.
DoubleEncryption enumerates the values for double encryption.
FilterFileType enumerates the values for filter file type.
JobDeliveryType enumerates the values for job delivery type.
JobDetailsTypeEnum enumerates the values for job details type enum.
JobSecretsTypeEnum enumerates the values for job secrets type enum.
KekType enumerates the values for kek type.
LogCollectionLevel enumerates the values for log collection level.
NotificationStageName enumerates the values for notification stage name.
OverallValidationStatus enumerates the values for overall validation status.
ShareDestinationFormatType enumerates the values for share destination format type.
SkuDisabledReason enumerates the values for sku disabled reason.
SkuName enumerates the values for sku name.
SkuNameBasicScheduleAvailabilityRequest enumerates the values for sku name basic schedule availability request.
StageName enumerates the values for stage name.
StageStatus enumerates the values for stage status.
TransferConfigurationType enumerates the values for transfer configuration type.
TransferType enumerates the values for transfer type.
TransportShipmentTypes enumerates the values for transport shipment types.
ValidationCategory enumerates the values for validation category.
ValidationStatus enumerates the values for validation status.
ValidationType enumerates the values for validation type.
ValidationTypeBasicValidationInputResponse enumerates the values for validation type basic validation input response.