models Package

Classes

AccountCredentialDetails

Credential details of the account.

Variables are only populated by the server, and will be ignored when sending a request.

AdditionalErrorInfo

Additional error info.

AddressValidationOutput

Output of the address validation api.

Variables are only populated by the server, and will be ignored when sending a request.

AddressValidationProperties

The address validation output.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ApiError

ApiError.

All required parameters must be populated in order to send to Azure.

ApplianceNetworkConfiguration

The Network Adapter configuration of a DataBox.

Variables are only populated by the server, and will be ignored when sending a request.

ArmBaseObject

Base class for all objects under resource.

Variables are only populated by the server, and will be ignored when sending a request.

AvailableSkuRequest

The filters for showing the available skus.

All required parameters must be populated in order to send to Azure.

AvailableSkusResult

The available skus operation response.

Variables are only populated by the server, and will be ignored when sending a request.

AzureFileFilterDetails

Filter details to transfer Azure files.

BlobFilterDetails

Filter details to transfer Azure Blobs.

CancellationReason

Reason for cancellation.

All required parameters must be populated in order to send to Azure.

CloudError

Cloud error.

Variables are only populated by the server, and will be ignored when sending a request.

ContactDetails

Contact Details.

All required parameters must be populated in order to send to Azure.

CopyLogDetails

Details for log generated during copy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataBoxAccountCopyLogDetails, DataBoxDiskCopyLogDetails, DataBoxHeavyAccountCopyLogDetails

All required parameters must be populated in order to send to Azure.

CopyProgress

Copy progress.

Variables are only populated by the server, and will be ignored when sending a request.

CreateJobValidations

It does all pre-job creation validations.

All required parameters must be populated in order to send to Azure.

CreateOrderLimitForSubscriptionValidationRequest

Request to validate create order limit for current subscription.

All required parameters must be populated in order to send to Azure.

CreateOrderLimitForSubscriptionValidationResponseProperties

Properties of create order limit for subscription validation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataAccountDetails

Account details of the data to be transferred.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedDiskDetails, StorageAccountDetails

All required parameters must be populated in order to send to Azure.

DataBoxAccountCopyLogDetails

Copy log details for a storage account of a DataBox job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxDiskCopyLogDetails

Copy Log Details for a disk.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxDiskCopyProgress

DataBox Disk Copy Progress.

Variables are only populated by the server, and will be ignored when sending a request.

DataBoxDiskJobDetails

DataBox Disk Job Details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxDiskJobSecrets

The secrets related to disk job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxHeavyAccountCopyLogDetails

Copy log details for a storage account for Databox heavy.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxHeavyJobDetails

Databox Heavy Device Job Details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxHeavyJobSecrets

The secrets related to a databox heavy job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxHeavySecret

The secrets related to a databox heavy.

Variables are only populated by the server, and will be ignored when sending a request.

DataBoxJobDetails

Databox Job Details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataBoxScheduleAvailabilityRequest

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

All required parameters must be populated in order to send to Azure.

DataBoxSecret

The secrets related to a DataBox.

Variables are only populated by the server, and will be ignored when sending a request.

DataExportDetails

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

All required parameters must be populated in order to send to Azure.

DataImportDetails

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

All required parameters must be populated in order to send to Azure.

DataLocationToServiceLocationMap

Map of data location to service location.

Variables are only populated by the server, and will be ignored when sending a request.

DataTransferDetailsValidationRequest

Request to validate export and import data details.

All required parameters must be populated in order to send to Azure.

DataTransferDetailsValidationResponseProperties

Properties of data transfer details validation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataboxJobSecrets

The secrets related to a databox job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DcAccessSecurityCode

Dc access security code.

Details

Details.

All required parameters must be populated in order to send to Azure.

DiskScheduleAvailabilityRequest

Request body to get the availability for scheduling disk orders.

All required parameters must be populated in order to send to Azure.

DiskSecret

Contains all the secrets of a Disk.

Variables are only populated by the server, and will be ignored when sending a request.

EncryptionPreferences

Preferences related to the Encryption.

ErrorDetail

ErrorDetail.

All required parameters must be populated in order to send to Azure.

FilterFileDetails

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

All required parameters must be populated in order to send to Azure.

HeavyScheduleAvailabilityRequest

Request body to get the availability for scheduling heavy orders.

All required parameters must be populated in order to send to Azure.

IdentityProperties

Managed identity properties.

JobDeliveryInfo

Additional delivery info.

JobDetails

Job details.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataBoxJobDetails, DataBoxDiskJobDetails, DataBoxHeavyJobDetails

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

JobResource

Job Resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

JobResourceList

Job Resource Collection.

JobResourceUpdateParameter

The JobResourceUpdateParameter.

JobSecrets

The base class for the secrets.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataboxJobSecrets, DataBoxDiskJobSecrets, DataBoxHeavyJobSecrets

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

JobStages

Job stages.

Variables are only populated by the server, and will be ignored when sending a request.

KeyEncryptionKey

Encryption key containing details about key to encrypt different keys.

All required parameters must be populated in order to send to Azure.

ManagedDiskDetails

Details of the managed disks.

All required parameters must be populated in order to send to Azure.

NotificationPreference

Notification preference for a job stage.

All required parameters must be populated in order to send to Azure.

Operation

Operation entity.

Variables are only populated by the server, and will be ignored when sending a request.

OperationDisplay

Operation display.

OperationList

Operation Collection.

Variables are only populated by the server, and will be ignored when sending a request.

PackageShippingDetails

Shipping details.

Variables are only populated by the server, and will be ignored when sending a request.

Preferences

Preferences related to the order.

PreferencesValidationRequest

Request to validate preference of transport and data center.

All required parameters must be populated in order to send to Azure.

PreferencesValidationResponseProperties

Properties of data center and transport preference validation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RegionConfigurationRequest

Request body to get the configuration for the region.

RegionConfigurationResponse

Configuration response specific to a region.

Variables are only populated by the server, and will be ignored when sending a request.

Resource

Model of the Resource.

All required parameters must be populated in order to send to Azure.

ResourceIdentity

Msi identity details of the resource.

Variables are only populated by the server, and will be ignored when sending a request.

ScheduleAvailabilityRequest

Request body to get the availability for scheduling orders.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataBoxScheduleAvailabilityRequest, DiskScheduleAvailabilityRequest, HeavyScheduleAvailabilityRequest

All required parameters must be populated in order to send to Azure.

ScheduleAvailabilityResponse

Schedule availability for given sku in a region.

Variables are only populated by the server, and will be ignored when sending a request.

ShareCredentialDetails

Credential details of the shares in account.

Variables are only populated by the server, and will be ignored when sending a request.

ShipmentPickUpRequest

Shipment pick up request details.

All required parameters must be populated in order to send to Azure.

ShipmentPickUpResponse

Shipment pick up response.

Variables are only populated by the server, and will be ignored when sending a request.

ShippingAddress

Shipping address where customer wishes to receive the device.

All required parameters must be populated in order to send to Azure.

Sku

The Sku.

All required parameters must be populated in order to send to Azure.

SkuAvailabilityValidationRequest

Request to validate sku availability.

All required parameters must be populated in order to send to Azure.

SkuAvailabilityValidationResponseProperties

Properties of sku availability validation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SkuCapacity

Capacity of the sku.

Variables are only populated by the server, and will be ignored when sending a request.

SkuCost

Describes metadata for retrieving price info.

Variables are only populated by the server, and will be ignored when sending a request.

SkuInformation

Information of the sku.

Variables are only populated by the server, and will be ignored when sending a request.

StorageAccountDetails

Details for the storage account.

All required parameters must be populated in order to send to Azure.

SubscriptionIsAllowedToCreateJobValidationRequest

Request to validate subscription permission to create jobs.

All required parameters must be populated in order to send to Azure.

SubscriptionIsAllowedToCreateJobValidationResponseProperties

Properties of subscription permission to create job validation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SystemData

Provides details about resource creation and update time.

Variables are only populated by the server, and will be ignored when sending a request.

TransferAllDetails

Details to transfer all data.

All required parameters must be populated in order to send to Azure.

TransferConfiguration

Configuration for defining the transfer of data.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

TransportAvailabilityDetails

Transport options availability details for given region.

Variables are only populated by the server, and will be ignored when sending a request.

TransportAvailabilityRequest

Request body to get the transport availability for given sku.

TransportAvailabilityResponse

Transport options available for given sku in a region.

Variables are only populated by the server, and will be ignored when sending a request.

TransportPreferences

Preferences related to the shipment logistics of the sku.

All required parameters must be populated in order to send to Azure.

UnencryptedCredentials

Unencrypted credentials for accessing device.

Variables are only populated by the server, and will be ignored when sending a request.

UnencryptedCredentialsList

List of unencrypted credentials for accessing device.

UpdateJobDetails

Job details for update.

UserAssignedIdentity

Class defining User assigned identity details.

Variables are only populated by the server, and will be ignored when sending a request.

UserAssignedProperties

User assigned identity properties.

ValidateAddress

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

All required parameters must be populated in order to send to Azure.

ValidationInputRequest

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ValidateAddress, CreateOrderLimitForSubscriptionValidationRequest, DataTransferDetailsValidationRequest, PreferencesValidationRequest, SkuAvailabilityValidationRequest, SubscriptionIsAllowedToCreateJobValidationRequest

All required parameters must be populated in order to send to Azure.

ValidationInputResponse

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AddressValidationProperties, CreateOrderLimitForSubscriptionValidationResponseProperties, DataTransferDetailsValidationResponseProperties, PreferencesValidationResponseProperties, SkuAvailabilityValidationResponseProperties, SubscriptionIsAllowedToCreateJobValidationResponseProperties

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ValidationRequest

Minimum request requirement of any validation category.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CreateJobValidations

All required parameters must be populated in order to send to Azure.

ValidationResponse

Response of pre job creation validations.

Variables are only populated by the server, and will be ignored when sending a request.

Enums

AccessProtocol

AccessProtocol.

AddressType

Type of address.

AddressValidationStatus

The address validation status.

ClassDiscriminator

Indicates the type of job details.

CopyStatus

The Status of the copy.

DataAccountType

Type of the account.

DoubleEncryption

Defines secondary layer of software-based encryption enablement.

FilterFileType

Type of the filter file.

JobDeliveryType

Delivery type of Job.

KekType

Type of encryption key used for key encryption.

LogCollectionLevel

Level of the logs to be collected.

NotificationStageName

Name of the stage.

OverallValidationStatus

Overall validation status.

ShareDestinationFormatType

Type of the share.

SkuDisabledReason

Reason why the Sku is disabled.

SkuName

SkuName.

StageName

Name of the stage which is in progress.

StageStatus

Status of the job stage.

TransferConfigurationType

Type of the configuration for transfer.

TransferType

Type of the transfer.

TransportShipmentTypes

Transport Shipment Type supported for given region.

ValidationInputDiscriminator

Identifies the type of validation request.

ValidationStatus

Create order limit validation status.