azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/databox/mgmt/2019-09-01/databox Index | Files | Directories

package databox

import "github.com/Azure/azure-sdk-for-go/services/databox/mgmt/2019-09-01/databox"

Package databox implements the Azure ARM Databox service API version 2019-09-01.

Index

Package Files

client.go enums.go jobs.go models.go operations.go service.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Databox
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent Uses

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type AccessProtocol Uses

type AccessProtocol string

AccessProtocol enumerates the values for access protocol.

const (
    // NFS Network File System protocol(NFS).
    NFS AccessProtocol = "NFS"
    // SMB Server Message Block protocol(SMB).
    SMB AccessProtocol = "SMB"
)

func PossibleAccessProtocolValues Uses

func PossibleAccessProtocolValues() []AccessProtocol

PossibleAccessProtocolValues returns an array of possible values for the AccessProtocol const type.

type AccountCopyLogDetails Uses

type AccountCopyLogDetails struct {
    // AccountName - READ-ONLY; Destination account name.
    AccountName *string `json:"accountName,omitempty"`
    // CopyLogLink - READ-ONLY; Link for copy logs.
    CopyLogLink *string `json:"copyLogLink,omitempty"`
    // CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypeDataBox', 'CopyLogDetailsTypeDataBoxDisk', 'CopyLogDetailsTypeDataBoxHeavy'
    CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

AccountCopyLogDetails copy log details for a storage account of a DataBox job

func (AccountCopyLogDetails) AsAccountCopyLogDetails Uses

func (acld AccountCopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsBasicCopyLogDetails Uses

func (acld AccountCopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsCopyLogDetails Uses

func (acld AccountCopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsDiskCopyLogDetails Uses

func (acld AccountCopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsHeavyAccountCopyLogDetails Uses

func (acld AccountCopyLogDetails) AsHeavyAccountCopyLogDetails() (*HeavyAccountCopyLogDetails, bool)

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) MarshalJSON Uses

func (acld AccountCopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCopyLogDetails.

type AccountCredentialDetails Uses

type AccountCredentialDetails struct {
    // AccountName - READ-ONLY; Name of the account.
    AccountName *string `json:"accountName,omitempty"`
    // DataDestinationType - READ-ONLY; Data Destination Type. Possible values include: 'StorageAccount', 'ManagedDisk'
    DataDestinationType DataDestinationType `json:"dataDestinationType,omitempty"`
    // AccountConnectionString - READ-ONLY; Connection string of the account endpoint to use the account as a storage endpoint on the device.
    AccountConnectionString *string `json:"accountConnectionString,omitempty"`
    // ShareCredentialDetails - READ-ONLY; Per share level unencrypted access credentials.
    ShareCredentialDetails *[]ShareCredentialDetails `json:"shareCredentialDetails,omitempty"`
}

AccountCredentialDetails credential details of the account.

type AddressType Uses

type AddressType string

AddressType enumerates the values for address type.

const (
    // Commercial Commercial Address.
    Commercial AddressType = "Commercial"
    // None Address type not known.
    None AddressType = "None"
    // Residential Residential Address.
    Residential AddressType = "Residential"
)

func PossibleAddressTypeValues Uses

func PossibleAddressTypeValues() []AddressType

PossibleAddressTypeValues returns an array of possible values for the AddressType const type.

type AddressValidationOutput Uses

type AddressValidationOutput struct {
    autorest.Response `json:"-"`
    // AddressValidationProperties - READ-ONLY; The address validation properties.
    *AddressValidationProperties `json:"properties,omitempty"`
}

AddressValidationOutput output of the address validation api.

func (AddressValidationOutput) MarshalJSON Uses

func (avo AddressValidationOutput) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressValidationOutput.

func (*AddressValidationOutput) UnmarshalJSON Uses

func (avo *AddressValidationOutput) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AddressValidationOutput struct.

type AddressValidationProperties Uses

type AddressValidationProperties struct {
    // ValidationStatus - READ-ONLY; The address validation status. Possible values include: 'Valid', 'Invalid', 'Ambiguous'
    ValidationStatus AddressValidationStatus `json:"validationStatus,omitempty"`
    // AlternateAddresses - READ-ONLY; List of alternate addresses.
    AlternateAddresses *[]ShippingAddress `json:"alternateAddresses,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

AddressValidationProperties the address validation output.

func (AddressValidationProperties) AsAddressValidationProperties Uses

func (avp AddressValidationProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsBasicValidationInputResponse Uses

func (avp AddressValidationProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (avp AddressValidationProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (avp AddressValidationProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsPreferencesValidationResponseProperties Uses

func (avp AddressValidationProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (avp AddressValidationProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (avp AddressValidationProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) AsValidationInputResponse Uses

func (avp AddressValidationProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for AddressValidationProperties.

func (AddressValidationProperties) MarshalJSON Uses

func (avp AddressValidationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressValidationProperties.

type AddressValidationStatus Uses

type AddressValidationStatus string

AddressValidationStatus enumerates the values for address validation status.

const (
    // Ambiguous Address provided is ambiguous, please choose one of the alternate addresses returned.
    Ambiguous AddressValidationStatus = "Ambiguous"
    // Invalid Address provided is invalid or not supported.
    Invalid AddressValidationStatus = "Invalid"
    // Valid Address provided is valid.
    Valid AddressValidationStatus = "Valid"
)

func PossibleAddressValidationStatusValues Uses

func PossibleAddressValidationStatusValues() []AddressValidationStatus

PossibleAddressValidationStatusValues returns an array of possible values for the AddressValidationStatus const type.

type ApplianceNetworkConfiguration Uses

type ApplianceNetworkConfiguration struct {
    // Name - READ-ONLY; Name of the network.
    Name *string `json:"name,omitempty"`
    // MacAddress - READ-ONLY; Mac Address.
    MacAddress *string `json:"macAddress,omitempty"`
}

ApplianceNetworkConfiguration the Network Adapter configuration of a DataBox.

type ArmBaseObject Uses

type ArmBaseObject struct {
    // Name - READ-ONLY; Name of the object.
    Name *string `json:"name,omitempty"`
    // ID - READ-ONLY; Id of the object.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of the object.
    Type *string `json:"type,omitempty"`
}

ArmBaseObject base class for all objects under resource.

type AvailableSkuRequest Uses

type AvailableSkuRequest struct {
    // TransferType - Type of the transfer.
    TransferType *string `json:"transferType,omitempty"`
    // Country - ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
    Country *string `json:"country,omitempty"`
    // Location - Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    Location *string `json:"location,omitempty"`
    // SkuNames - Sku Names to filter for available skus
    SkuNames *[]SkuName `json:"skuNames,omitempty"`
}

AvailableSkuRequest the filters for showing the available skus.

type AvailableSkusResult Uses

type AvailableSkusResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; List of available skus.
    Value *[]SkuInformation `json:"value,omitempty"`
    // NextLink - Link for the next set of skus.
    NextLink *string `json:"nextLink,omitempty"`
}

AvailableSkusResult the available skus operation response.

func (AvailableSkusResult) IsEmpty Uses

func (asr AvailableSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AvailableSkusResult) MarshalJSON Uses

func (asr AvailableSkusResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AvailableSkusResult.

type AvailableSkusResultIterator Uses

type AvailableSkusResultIterator struct {
    // contains filtered or unexported fields
}

AvailableSkusResultIterator provides access to a complete listing of SkuInformation values.

func NewAvailableSkusResultIterator Uses

func NewAvailableSkusResultIterator(page AvailableSkusResultPage) AvailableSkusResultIterator

Creates a new instance of the AvailableSkusResultIterator type.

func (*AvailableSkusResultIterator) Next Uses

func (iter *AvailableSkusResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AvailableSkusResultIterator) NextWithContext Uses

func (iter *AvailableSkusResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AvailableSkusResultIterator) NotDone Uses

func (iter AvailableSkusResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AvailableSkusResultIterator) Response Uses

func (iter AvailableSkusResultIterator) Response() AvailableSkusResult

Response returns the raw server response from the last page request.

func (AvailableSkusResultIterator) Value Uses

func (iter AvailableSkusResultIterator) Value() SkuInformation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AvailableSkusResultPage Uses

type AvailableSkusResultPage struct {
    // contains filtered or unexported fields
}

AvailableSkusResultPage contains a page of SkuInformation values.

func NewAvailableSkusResultPage Uses

func NewAvailableSkusResultPage(cur AvailableSkusResult, getNextPage func(context.Context, AvailableSkusResult) (AvailableSkusResult, error)) AvailableSkusResultPage

Creates a new instance of the AvailableSkusResultPage type.

func (*AvailableSkusResultPage) Next Uses

func (page *AvailableSkusResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AvailableSkusResultPage) NextWithContext Uses

func (page *AvailableSkusResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AvailableSkusResultPage) NotDone Uses

func (page AvailableSkusResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AvailableSkusResultPage) Response Uses

func (page AvailableSkusResultPage) Response() AvailableSkusResult

Response returns the raw server response from the last page request.

func (AvailableSkusResultPage) Values Uses

func (page AvailableSkusResultPage) Values() []SkuInformation

Values returns the slice of values for the current page or nil if there are no values.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI        string
    SubscriptionID string
}

BaseClient is the base client for Databox.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicCopyLogDetails Uses

type BasicCopyLogDetails interface {
    AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)
    AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)
    AsHeavyAccountCopyLogDetails() (*HeavyAccountCopyLogDetails, bool)
    AsCopyLogDetails() (*CopyLogDetails, bool)
}

BasicCopyLogDetails details for log generated during copy.

type BasicDestinationAccountDetails Uses

type BasicDestinationAccountDetails interface {
    AsDestinationManagedDiskDetails() (*DestinationManagedDiskDetails, bool)
    AsDestinationStorageAccountDetails() (*DestinationStorageAccountDetails, bool)
    AsDestinationAccountDetails() (*DestinationAccountDetails, bool)
}

BasicDestinationAccountDetails details of the destination storage accounts.

type BasicJobDetails Uses

type BasicJobDetails interface {
    AsDiskJobDetails() (*DiskJobDetails, bool)
    AsHeavyJobDetails() (*HeavyJobDetails, bool)
    AsJobDetailsType() (*JobDetailsType, bool)
    AsJobDetails() (*JobDetails, bool)
}

BasicJobDetails job details.

type BasicJobSecrets Uses

type BasicJobSecrets interface {
    AsDiskJobSecrets() (*DiskJobSecrets, bool)
    AsHeavyJobSecrets() (*HeavyJobSecrets, bool)
    AsJobSecretsType() (*JobSecretsType, bool)
    AsJobSecrets() (*JobSecrets, bool)
}

BasicJobSecrets the base class for the secrets

type BasicScheduleAvailabilityRequest Uses

type BasicScheduleAvailabilityRequest interface {
    AsScheduleAvailabilityRequestType() (*ScheduleAvailabilityRequestType, bool)
    AsDiskScheduleAvailabilityRequest() (*DiskScheduleAvailabilityRequest, bool)
    AsHeavyScheduleAvailabilityRequest() (*HeavyScheduleAvailabilityRequest, bool)
    AsScheduleAvailabilityRequest() (*ScheduleAvailabilityRequest, bool)
}

BasicScheduleAvailabilityRequest request body to get the availability for scheduling orders.

type BasicValidationInputRequest Uses

type BasicValidationInputRequest interface {
    AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)
    AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)
    AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)
    AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)
    AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)
    AsValidateAddress() (*ValidateAddress, bool)
    AsValidationInputRequest() (*ValidationInputRequest, bool)
}

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

type BasicValidationInputResponse Uses

type BasicValidationInputResponse interface {
    AsAddressValidationProperties() (*AddressValidationProperties, bool)
    AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)
    AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)
    AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)
    AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)
    AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)
    AsValidationInputResponse() (*ValidationInputResponse, bool)
}

BasicValidationInputResponse minimum properties that should be present in each individual validation response.

type BasicValidationRequest Uses

type BasicValidationRequest interface {
    AsCreateJobValidations() (*CreateJobValidations, bool)
    AsValidationRequest() (*ValidationRequest, bool)
}

BasicValidationRequest input request for all pre job creation validation.

type CancellationReason Uses

type CancellationReason struct {
    // Reason - Reason for cancellation.
    Reason *string `json:"reason,omitempty"`
}

CancellationReason reason for cancellation.

type CloudError Uses

type CloudError struct {
    // Code - READ-ONLY; Error code string.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; Descriptive error information.
    Message *string `json:"message,omitempty"`
    // Target - Error target
    Target *string `json:"target,omitempty"`
    // Details - More detailed error information.
    Details *[]CloudError `json:"details,omitempty"`
}

CloudError the error information object.

func (CloudError) MarshalJSON Uses

func (ce CloudError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudError.

type ContactDetails Uses

type ContactDetails struct {
    // ContactName - Contact name of the person.
    ContactName *string `json:"contactName,omitempty"`
    // Phone - Phone number of the contact person.
    Phone *string `json:"phone,omitempty"`
    // PhoneExtension - Phone extension number of the contact person.
    PhoneExtension *string `json:"phoneExtension,omitempty"`
    // Mobile - Mobile number of the contact person.
    Mobile *string `json:"mobile,omitempty"`
    // EmailList - List of Email-ids to be notified about job progress.
    EmailList *[]string `json:"emailList,omitempty"`
    // NotificationPreference - Notification preference for a job stage.
    NotificationPreference *[]NotificationPreference `json:"notificationPreference,omitempty"`
}

ContactDetails contact Details.

type CopyLogDetails Uses

type CopyLogDetails struct {
    // CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypeDataBox', 'CopyLogDetailsTypeDataBoxDisk', 'CopyLogDetailsTypeDataBoxHeavy'
    CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

CopyLogDetails details for log generated during copy.

func (CopyLogDetails) AsAccountCopyLogDetails Uses

func (cld CopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsBasicCopyLogDetails Uses

func (cld CopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsCopyLogDetails Uses

func (cld CopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsDiskCopyLogDetails Uses

func (cld CopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsHeavyAccountCopyLogDetails Uses

func (cld CopyLogDetails) AsHeavyAccountCopyLogDetails() (*HeavyAccountCopyLogDetails, bool)

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) MarshalJSON Uses

func (cld CopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CopyLogDetails.

type CopyLogDetailsType Uses

type CopyLogDetailsType string

CopyLogDetailsType enumerates the values for copy log details type.

const (
    // CopyLogDetailsTypeCopyLogDetails ...
    CopyLogDetailsTypeCopyLogDetails CopyLogDetailsType = "CopyLogDetails"
    // CopyLogDetailsTypeDataBox ...
    CopyLogDetailsTypeDataBox CopyLogDetailsType = "DataBox"
    // CopyLogDetailsTypeDataBoxDisk ...
    CopyLogDetailsTypeDataBoxDisk CopyLogDetailsType = "DataBoxDisk"
    // CopyLogDetailsTypeDataBoxHeavy ...
    CopyLogDetailsTypeDataBoxHeavy CopyLogDetailsType = "DataBoxHeavy"
)

func PossibleCopyLogDetailsTypeValues Uses

func PossibleCopyLogDetailsTypeValues() []CopyLogDetailsType

PossibleCopyLogDetailsTypeValues returns an array of possible values for the CopyLogDetailsType const type.

type CopyProgress Uses

type CopyProgress struct {
    // StorageAccountName - READ-ONLY; Name of the storage account where the data needs to be uploaded.
    StorageAccountName *string `json:"storageAccountName,omitempty"`
    // DataDestinationType - READ-ONLY; Data Destination Type. Possible values include: 'StorageAccount', 'ManagedDisk'
    DataDestinationType DataDestinationType `json:"dataDestinationType,omitempty"`
    // AccountID - READ-ONLY; Id of the account where the data needs to be uploaded.
    AccountID *string `json:"accountId,omitempty"`
    // BytesSentToCloud - READ-ONLY; Amount of data uploaded by the job as of now.
    BytesSentToCloud *int64 `json:"bytesSentToCloud,omitempty"`
    // TotalBytesToProcess - READ-ONLY; Total amount of data to be processed by the job.
    TotalBytesToProcess *int64 `json:"totalBytesToProcess,omitempty"`
    // FilesProcessed - READ-ONLY; Number of files processed by the job as of now.
    FilesProcessed *int64 `json:"filesProcessed,omitempty"`
    // TotalFilesToProcess - READ-ONLY; Total number of files to be processed by the job.
    TotalFilesToProcess *int64 `json:"totalFilesToProcess,omitempty"`
    // InvalidFilesProcessed - READ-ONLY; Number of files not adhering to azure naming conventions which were processed by automatic renaming
    InvalidFilesProcessed *int64 `json:"invalidFilesProcessed,omitempty"`
    // InvalidFileBytesUploaded - READ-ONLY; Total amount of data not adhering to azure naming conventions which were processed by automatic renaming
    InvalidFileBytesUploaded *int64 `json:"invalidFileBytesUploaded,omitempty"`
    // RenamedContainerCount - READ-ONLY; Number of folders not adhering to azure naming conventions which were processed by automatic renaming
    RenamedContainerCount *int64 `json:"renamedContainerCount,omitempty"`
    // FilesErroredOut - READ-ONLY; Number of files which could not be copied
    FilesErroredOut *int64 `json:"filesErroredOut,omitempty"`
}

CopyProgress copy progress.

type CopyStatus Uses

type CopyStatus string

CopyStatus enumerates the values for copy status.

const (
    // Completed Data copy completed.
    Completed CopyStatus = "Completed"
    // CompletedWithErrors Data copy completed with errors.
    CompletedWithErrors CopyStatus = "CompletedWithErrors"
    // DeviceFormatted Data copy failed. The Device was formatted by user.
    DeviceFormatted CopyStatus = "DeviceFormatted"
    // DeviceMetadataModified Data copy failed. Device metadata was modified by user.
    DeviceMetadataModified CopyStatus = "DeviceMetadataModified"
    // Failed Data copy failed. No data was copied.
    Failed CopyStatus = "Failed"
    // HardwareError The Device has hit hardware issues.
    HardwareError CopyStatus = "HardwareError"
    // InProgress Data copy is in progress.
    InProgress CopyStatus = "InProgress"
    // NotReturned No copy triggered as device was not returned.
    NotReturned CopyStatus = "NotReturned"
    // NotStarted Data copy hasn't started yet.
    NotStarted CopyStatus = "NotStarted"
    // StorageAccountNotAccessible Data copy failed. Storage Account was not accessible during copy.
    StorageAccountNotAccessible CopyStatus = "StorageAccountNotAccessible"
    // UnsupportedData Data copy failed. The Device data content is not supported.
    UnsupportedData CopyStatus = "UnsupportedData"
)

func PossibleCopyStatusValues Uses

func PossibleCopyStatusValues() []CopyStatus

PossibleCopyStatusValues returns an array of possible values for the CopyStatus const type.

type CreateJobValidations Uses

type CreateJobValidations struct {
    // IndividualRequestDetails - List of request details contain validationType and its request as key and value respectively.
    IndividualRequestDetails *[]BasicValidationInputRequest `json:"individualRequestDetails,omitempty"`
    // ValidationCategory - Possible values include: 'ValidationCategoryValidationRequest', 'ValidationCategoryJobCreationValidation'
    ValidationCategory ValidationCategory `json:"validationCategory,omitempty"`
}

CreateJobValidations it does all pre-job creation validations.

func (CreateJobValidations) AsBasicValidationRequest Uses

func (cjv CreateJobValidations) AsBasicValidationRequest() (BasicValidationRequest, bool)

AsBasicValidationRequest is the BasicValidationRequest implementation for CreateJobValidations.

func (CreateJobValidations) AsCreateJobValidations Uses

func (cjv CreateJobValidations) AsCreateJobValidations() (*CreateJobValidations, bool)

AsCreateJobValidations is the BasicValidationRequest implementation for CreateJobValidations.

func (CreateJobValidations) AsValidationRequest Uses

func (cjv CreateJobValidations) AsValidationRequest() (*ValidationRequest, bool)

AsValidationRequest is the BasicValidationRequest implementation for CreateJobValidations.

func (CreateJobValidations) MarshalJSON Uses

func (cjv CreateJobValidations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateJobValidations.

func (*CreateJobValidations) UnmarshalJSON Uses

func (cjv *CreateJobValidations) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateJobValidations struct.

type CreateOrderLimitForSubscriptionValidationRequest Uses

type CreateOrderLimitForSubscriptionValidationRequest struct {
    // DeviceType - Device type to be used for the job. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    DeviceType SkuName `json:"deviceType,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

CreateOrderLimitForSubscriptionValidationRequest request to validate create order limit for current subscription.

func (CreateOrderLimitForSubscriptionValidationRequest) AsBasicValidationInputRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsDataDestinationDetailsValidationRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsPreferencesValidationRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsSkuAvailabilityValidationRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsValidateAddress Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) AsValidationInputRequest Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for CreateOrderLimitForSubscriptionValidationRequest.

func (CreateOrderLimitForSubscriptionValidationRequest) MarshalJSON Uses

func (colfsvr CreateOrderLimitForSubscriptionValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateOrderLimitForSubscriptionValidationRequest.

type CreateOrderLimitForSubscriptionValidationResponseProperties Uses

type CreateOrderLimitForSubscriptionValidationResponseProperties struct {
    // Status - READ-ONLY; Create order limit validation status. Possible values include: 'ValidationStatusValid', 'ValidationStatusInvalid', 'ValidationStatusSkipped'
    Status ValidationStatus `json:"status,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

CreateOrderLimitForSubscriptionValidationResponseProperties properties of create order limit for subscription validation response.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsAddressValidationProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsBasicValidationInputResponse Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsPreferencesValidationResponseProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) AsValidationInputResponse Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for CreateOrderLimitForSubscriptionValidationResponseProperties.

func (CreateOrderLimitForSubscriptionValidationResponseProperties) MarshalJSON Uses

func (colfsvrp CreateOrderLimitForSubscriptionValidationResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateOrderLimitForSubscriptionValidationResponseProperties.

type DataDestinationDetailsValidationRequest Uses

type DataDestinationDetailsValidationRequest struct {
    // DestinationAccountDetails - Destination account details list.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
    // Location - Location of stamp or geo.
    Location *string `json:"location,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

DataDestinationDetailsValidationRequest request to validate data destination details.

func (DataDestinationDetailsValidationRequest) AsBasicValidationInputRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsDataDestinationDetailsValidationRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsPreferencesValidationRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsSkuAvailabilityValidationRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsValidateAddress Uses

func (dddvr DataDestinationDetailsValidationRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) AsValidationInputRequest Uses

func (dddvr DataDestinationDetailsValidationRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for DataDestinationDetailsValidationRequest.

func (DataDestinationDetailsValidationRequest) MarshalJSON Uses

func (dddvr DataDestinationDetailsValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataDestinationDetailsValidationRequest.

func (*DataDestinationDetailsValidationRequest) UnmarshalJSON Uses

func (dddvr *DataDestinationDetailsValidationRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DataDestinationDetailsValidationRequest struct.

type DataDestinationDetailsValidationResponseProperties Uses

type DataDestinationDetailsValidationResponseProperties struct {
    // Status - READ-ONLY; Data destination details validation status. Possible values include: 'ValidationStatusValid', 'ValidationStatusInvalid', 'ValidationStatusSkipped'
    Status ValidationStatus `json:"status,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

DataDestinationDetailsValidationResponseProperties properties of data destination details validation response.

func (DataDestinationDetailsValidationResponseProperties) AsAddressValidationProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsBasicValidationInputResponse Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsPreferencesValidationResponseProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) AsValidationInputResponse Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for DataDestinationDetailsValidationResponseProperties.

func (DataDestinationDetailsValidationResponseProperties) MarshalJSON Uses

func (dddvrp DataDestinationDetailsValidationResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataDestinationDetailsValidationResponseProperties.

type DataDestinationType Uses

type DataDestinationType string

DataDestinationType enumerates the values for data destination type.

const (
    // ManagedDisk Azure Managed disk storage.
    ManagedDisk DataDestinationType = "ManagedDisk"
    // StorageAccount Storage Accounts .
    StorageAccount DataDestinationType = "StorageAccount"
)

func PossibleDataDestinationTypeValues Uses

func PossibleDataDestinationTypeValues() []DataDestinationType

PossibleDataDestinationTypeValues returns an array of possible values for the DataDestinationType const type.

type DataDestinationTypeBasicDestinationAccountDetails Uses

type DataDestinationTypeBasicDestinationAccountDetails string

DataDestinationTypeBasicDestinationAccountDetails enumerates the values for data destination type basic destination account details.

const (
    // DataDestinationTypeDestinationAccountDetails ...
    DataDestinationTypeDestinationAccountDetails DataDestinationTypeBasicDestinationAccountDetails = "DestinationAccountDetails"
    // DataDestinationTypeManagedDisk ...
    DataDestinationTypeManagedDisk DataDestinationTypeBasicDestinationAccountDetails = "ManagedDisk"
    // DataDestinationTypeStorageAccount ...
    DataDestinationTypeStorageAccount DataDestinationTypeBasicDestinationAccountDetails = "StorageAccount"
)

func PossibleDataDestinationTypeBasicDestinationAccountDetailsValues Uses

func PossibleDataDestinationTypeBasicDestinationAccountDetailsValues() []DataDestinationTypeBasicDestinationAccountDetails

PossibleDataDestinationTypeBasicDestinationAccountDetailsValues returns an array of possible values for the DataDestinationTypeBasicDestinationAccountDetails const type.

type DcAccessSecurityCode Uses

type DcAccessSecurityCode struct {
    // ForwardDcAccessCode - Dc Access Code for dispatching from DC.
    ForwardDcAccessCode *string `json:"forwardDcAccessCode,omitempty"`
    // ReverseDcAccessCode - Dc Access code for dropping off at DC.
    ReverseDcAccessCode *string `json:"reverseDcAccessCode,omitempty"`
}

DcAccessSecurityCode dc Access Security code for device.

type DestinationAccountDetails Uses

type DestinationAccountDetails struct {
    // AccountID - Arm Id of the destination where the data has to be moved.
    AccountID *string `json:"accountId,omitempty"`
    // SharePassword - Share password to be shared by all shares in SA.
    SharePassword *string `json:"sharePassword,omitempty"`
    // DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
    DataDestinationType DataDestinationTypeBasicDestinationAccountDetails `json:"dataDestinationType,omitempty"`
}

DestinationAccountDetails details of the destination storage accounts.

func (DestinationAccountDetails) AsBasicDestinationAccountDetails Uses

func (dad DestinationAccountDetails) AsBasicDestinationAccountDetails() (BasicDestinationAccountDetails, bool)

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationAccountDetails Uses

func (dad DestinationAccountDetails) AsDestinationAccountDetails() (*DestinationAccountDetails, bool)

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationManagedDiskDetails Uses

func (dad DestinationAccountDetails) AsDestinationManagedDiskDetails() (*DestinationManagedDiskDetails, bool)

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationStorageAccountDetails Uses

func (dad DestinationAccountDetails) AsDestinationStorageAccountDetails() (*DestinationStorageAccountDetails, bool)

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) MarshalJSON Uses

func (dad DestinationAccountDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DestinationAccountDetails.

type DestinationManagedDiskDetails Uses

type DestinationManagedDiskDetails struct {
    // ResourceGroupID - Destination Resource Group Id where the Compute disks should be created.
    ResourceGroupID *string `json:"resourceGroupId,omitempty"`
    // StagingStorageAccountID - Arm Id of the storage account that can be used to copy the vhd for staging.
    StagingStorageAccountID *string `json:"stagingStorageAccountId,omitempty"`
    // AccountID - Arm Id of the destination where the data has to be moved.
    AccountID *string `json:"accountId,omitempty"`
    // SharePassword - Share password to be shared by all shares in SA.
    SharePassword *string `json:"sharePassword,omitempty"`
    // DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
    DataDestinationType DataDestinationTypeBasicDestinationAccountDetails `json:"dataDestinationType,omitempty"`
}

DestinationManagedDiskDetails details for the destination compute disks.

func (DestinationManagedDiskDetails) AsBasicDestinationAccountDetails Uses

func (dmdd DestinationManagedDiskDetails) AsBasicDestinationAccountDetails() (BasicDestinationAccountDetails, bool)

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationAccountDetails Uses

func (dmdd DestinationManagedDiskDetails) AsDestinationAccountDetails() (*DestinationAccountDetails, bool)

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationManagedDiskDetails Uses

func (dmdd DestinationManagedDiskDetails) AsDestinationManagedDiskDetails() (*DestinationManagedDiskDetails, bool)

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationStorageAccountDetails Uses

func (dmdd DestinationManagedDiskDetails) AsDestinationStorageAccountDetails() (*DestinationStorageAccountDetails, bool)

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) MarshalJSON Uses

func (dmdd DestinationManagedDiskDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DestinationManagedDiskDetails.

type DestinationStorageAccountDetails Uses

type DestinationStorageAccountDetails struct {
    // StorageAccountID - Destination Storage Account Arm Id.
    StorageAccountID *string `json:"storageAccountId,omitempty"`
    // AccountID - Arm Id of the destination where the data has to be moved.
    AccountID *string `json:"accountId,omitempty"`
    // SharePassword - Share password to be shared by all shares in SA.
    SharePassword *string `json:"sharePassword,omitempty"`
    // DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
    DataDestinationType DataDestinationTypeBasicDestinationAccountDetails `json:"dataDestinationType,omitempty"`
}

DestinationStorageAccountDetails details for the destination storage account.

func (DestinationStorageAccountDetails) AsBasicDestinationAccountDetails Uses

func (dsad DestinationStorageAccountDetails) AsBasicDestinationAccountDetails() (BasicDestinationAccountDetails, bool)

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationAccountDetails Uses

func (dsad DestinationStorageAccountDetails) AsDestinationAccountDetails() (*DestinationAccountDetails, bool)

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationManagedDiskDetails Uses

func (dsad DestinationStorageAccountDetails) AsDestinationManagedDiskDetails() (*DestinationManagedDiskDetails, bool)

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationStorageAccountDetails Uses

func (dsad DestinationStorageAccountDetails) AsDestinationStorageAccountDetails() (*DestinationStorageAccountDetails, bool)

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) MarshalJSON Uses

func (dsad DestinationStorageAccountDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DestinationStorageAccountDetails.

type DestinationToServiceLocationMap Uses

type DestinationToServiceLocationMap struct {
    // DestinationLocation - READ-ONLY; Location of the destination.
    DestinationLocation *string `json:"destinationLocation,omitempty"`
    // ServiceLocation - READ-ONLY; Location of the service.
    ServiceLocation *string `json:"serviceLocation,omitempty"`
}

DestinationToServiceLocationMap map of destination location to service location.

type DiskCopyLogDetails Uses

type DiskCopyLogDetails struct {
    // DiskSerialNumber - READ-ONLY; Disk Serial Number.
    DiskSerialNumber *string `json:"diskSerialNumber,omitempty"`
    // ErrorLogLink - READ-ONLY; Link for copy error logs.
    ErrorLogLink *string `json:"errorLogLink,omitempty"`
    // VerboseLogLink - READ-ONLY; Link for copy verbose logs.
    VerboseLogLink *string `json:"verboseLogLink,omitempty"`
    // CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypeDataBox', 'CopyLogDetailsTypeDataBoxDisk', 'CopyLogDetailsTypeDataBoxHeavy'
    CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

DiskCopyLogDetails copy Log Details for a disk

func (DiskCopyLogDetails) AsAccountCopyLogDetails Uses

func (dcld DiskCopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsBasicCopyLogDetails Uses

func (dcld DiskCopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsCopyLogDetails Uses

func (dcld DiskCopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsDiskCopyLogDetails Uses

func (dcld DiskCopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsHeavyAccountCopyLogDetails Uses

func (dcld DiskCopyLogDetails) AsHeavyAccountCopyLogDetails() (*HeavyAccountCopyLogDetails, bool)

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) MarshalJSON Uses

func (dcld DiskCopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskCopyLogDetails.

type DiskCopyProgress Uses

type DiskCopyProgress struct {
    // SerialNumber - READ-ONLY; The serial number of the disk
    SerialNumber *string `json:"serialNumber,omitempty"`
    // BytesCopied - READ-ONLY; Bytes copied during the copy of disk.
    BytesCopied *int64 `json:"bytesCopied,omitempty"`
    // PercentComplete - READ-ONLY; Indicates the percentage completed for the copy of the disk.
    PercentComplete *int32 `json:"percentComplete,omitempty"`
    // Status - READ-ONLY; The Status of the copy. Possible values include: 'NotStarted', 'InProgress', 'Completed', 'CompletedWithErrors', 'Failed', 'NotReturned', 'HardwareError', 'DeviceFormatted', 'DeviceMetadataModified', 'StorageAccountNotAccessible', 'UnsupportedData'
    Status CopyStatus `json:"status,omitempty"`
}

DiskCopyProgress dataBox Disk Copy Progress

type DiskJobDetails Uses

type DiskJobDetails struct {
    // PreferredDisks - User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.
    PreferredDisks map[string]*int32 `json:"preferredDisks"`
    // CopyProgress - READ-ONLY; Copy progress per disk.
    CopyProgress *[]DiskCopyProgress `json:"copyProgress,omitempty"`
    // DisksAndSizeDetails - READ-ONLY; Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.
    DisksAndSizeDetails map[string]*int32 `json:"disksAndSizeDetails"`
    // Passkey - User entered passkey for DataBox Disk job.
    Passkey *string `json:"passkey,omitempty"`
    // ExpectedDataSizeInTerabytes - The expected size of the data, which needs to be transferred in this job, in terabytes.
    ExpectedDataSizeInTerabytes *int32 `json:"expectedDataSizeInTerabytes,omitempty"`
    // JobStages - READ-ONLY; List of stages that run in the job.
    JobStages *[]JobStages `json:"jobStages,omitempty"`
    // ContactDetails - Contact details for notification and shipping.
    ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
    // DeliveryPackage - READ-ONLY; Delivery package shipping details.
    DeliveryPackage *PackageShippingDetails `json:"deliveryPackage,omitempty"`
    // ReturnPackage - READ-ONLY; Return package shipping details.
    ReturnPackage *PackageShippingDetails `json:"returnPackage,omitempty"`
    // DestinationAccountDetails - Destination account details.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
    // ErrorDetails - READ-ONLY; Error details for failure. This is optional.
    ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
    // Preferences - Preferences for the order.
    Preferences *Preferences `json:"preferences,omitempty"`
    // CopyLogDetails - READ-ONLY; List of copy log details.
    CopyLogDetails *[]BasicCopyLogDetails `json:"copyLogDetails,omitempty"`
    // ReverseShipmentLabelSasKey - READ-ONLY; Shared access key to download the return shipment label
    ReverseShipmentLabelSasKey *string `json:"reverseShipmentLabelSasKey,omitempty"`
    // ChainOfCustodySasKey - READ-ONLY; Shared access key to download the chain of custody logs
    ChainOfCustodySasKey *string `json:"chainOfCustodySasKey,omitempty"`
    // JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDataBoxDisk', 'JobDetailsTypeDataBoxHeavy', 'JobDetailsTypeDataBox'
    JobDetailsType JobDetailsTypeEnum `json:"jobDetailsType,omitempty"`
}

DiskJobDetails dataBox Disk Job Details.

func (DiskJobDetails) AsBasicJobDetails Uses

func (djd DiskJobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsDiskJobDetails Uses

func (djd DiskJobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsHeavyJobDetails Uses

func (djd DiskJobDetails) AsHeavyJobDetails() (*HeavyJobDetails, bool)

AsHeavyJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsJobDetails Uses

func (djd DiskJobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsJobDetailsType Uses

func (djd DiskJobDetails) AsJobDetailsType() (*JobDetailsType, bool)

AsJobDetailsType is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) MarshalJSON Uses

func (djd DiskJobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskJobDetails.

func (*DiskJobDetails) UnmarshalJSON Uses

func (djd *DiskJobDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DiskJobDetails struct.

type DiskJobSecrets Uses

type DiskJobSecrets struct {
    // DiskSecrets - READ-ONLY; Contains the list of secrets object for that device.
    DiskSecrets *[]DiskSecret `json:"diskSecrets,omitempty"`
    // PassKey - READ-ONLY; PassKey for the disk Job.
    PassKey *string `json:"passKey,omitempty"`
    // IsPasskeyUserDefined - READ-ONLY; Whether passkey was provided by user.
    IsPasskeyUserDefined *bool `json:"isPasskeyUserDefined,omitempty"`
    // DcAccessSecurityCode - Dc Access Security Code for Customer Managed Shipping
    DcAccessSecurityCode *DcAccessSecurityCode `json:"dcAccessSecurityCode,omitempty"`
    // JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
    JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

DiskJobSecrets the secrets related to disk job.

func (DiskJobSecrets) AsBasicJobSecrets Uses

func (djs DiskJobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsDiskJobSecrets Uses

func (djs DiskJobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsHeavyJobSecrets Uses

func (djs DiskJobSecrets) AsHeavyJobSecrets() (*HeavyJobSecrets, bool)

AsHeavyJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsJobSecrets Uses

func (djs DiskJobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsJobSecretsType Uses

func (djs DiskJobSecrets) AsJobSecretsType() (*JobSecretsType, bool)

AsJobSecretsType is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) MarshalJSON Uses

func (djs DiskJobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskJobSecrets.

type DiskScheduleAvailabilityRequest Uses

type DiskScheduleAvailabilityRequest struct {
    // ExpectedDataSizeInTerabytes - The expected size of the data, which needs to be transferred in this job, in terabytes.
    ExpectedDataSizeInTerabytes *int32 `json:"expectedDataSizeInTerabytes,omitempty"`
    // StorageLocation - Location for data transfer.
    // For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    StorageLocation *string `json:"storageLocation,omitempty"`
    // SkuName - Possible values include: 'SkuNameScheduleAvailabilityRequest', 'SkuNameDataBox', 'SkuNameDataBoxDisk', 'SkuNameDataBoxHeavy'
    SkuName SkuNameBasicScheduleAvailabilityRequest `json:"skuName,omitempty"`
}

DiskScheduleAvailabilityRequest request body to get the availability for scheduling disk orders.

func (DiskScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest Uses

func (dsar DiskScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest() (BasicScheduleAvailabilityRequest, bool)

AsBasicScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for DiskScheduleAvailabilityRequest.

func (DiskScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest Uses

func (dsar DiskScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest() (*DiskScheduleAvailabilityRequest, bool)

AsDiskScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for DiskScheduleAvailabilityRequest.

func (DiskScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest Uses

func (dsar DiskScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest() (*HeavyScheduleAvailabilityRequest, bool)

AsHeavyScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for DiskScheduleAvailabilityRequest.

func (DiskScheduleAvailabilityRequest) AsScheduleAvailabilityRequest Uses

func (dsar DiskScheduleAvailabilityRequest) AsScheduleAvailabilityRequest() (*ScheduleAvailabilityRequest, bool)

AsScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for DiskScheduleAvailabilityRequest.

func (DiskScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType Uses

func (dsar DiskScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType() (*ScheduleAvailabilityRequestType, bool)

AsScheduleAvailabilityRequestType is the BasicScheduleAvailabilityRequest implementation for DiskScheduleAvailabilityRequest.

func (DiskScheduleAvailabilityRequest) MarshalJSON Uses

func (dsar DiskScheduleAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskScheduleAvailabilityRequest.

type DiskSecret Uses

type DiskSecret struct {
    // DiskSerialNumber - READ-ONLY; Serial number of the assigned disk.
    DiskSerialNumber *string `json:"diskSerialNumber,omitempty"`
    // BitLockerKey - READ-ONLY; Bit Locker key of the disk which can be used to unlock the disk to copy data.
    BitLockerKey *string `json:"bitLockerKey,omitempty"`
}

DiskSecret contains all the secrets of a Disk.

type Error Uses

type Error struct {
    // Code - READ-ONLY; Error code that can be used to programmatically identify the error.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; Describes the error in detail and provides debugging information.
    Message *string `json:"message,omitempty"`
}

Error top level error for the job.

type HeavyAccountCopyLogDetails Uses

type HeavyAccountCopyLogDetails struct {
    // AccountName - READ-ONLY; Destination account name.
    AccountName *string `json:"accountName,omitempty"`
    // CopyLogLink - READ-ONLY; Link for copy logs.
    CopyLogLink *[]string `json:"copyLogLink,omitempty"`
    // CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypeDataBox', 'CopyLogDetailsTypeDataBoxDisk', 'CopyLogDetailsTypeDataBoxHeavy'
    CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

HeavyAccountCopyLogDetails copy log details for a storage account for Databox heavy

func (HeavyAccountCopyLogDetails) AsAccountCopyLogDetails Uses

func (hacld HeavyAccountCopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsBasicCopyLogDetails Uses

func (hacld HeavyAccountCopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsCopyLogDetails Uses

func (hacld HeavyAccountCopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsDiskCopyLogDetails Uses

func (hacld HeavyAccountCopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsHeavyAccountCopyLogDetails Uses

func (hacld HeavyAccountCopyLogDetails) AsHeavyAccountCopyLogDetails() (*HeavyAccountCopyLogDetails, bool)

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) MarshalJSON Uses

func (hacld HeavyAccountCopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeavyAccountCopyLogDetails.

type HeavyJobDetails Uses

type HeavyJobDetails struct {
    // CopyProgress - READ-ONLY; Copy progress per account.
    CopyProgress *[]CopyProgress `json:"copyProgress,omitempty"`
    // DevicePassword - Set Device password for unlocking Databox Heavy
    DevicePassword *string `json:"devicePassword,omitempty"`
    // ExpectedDataSizeInTerabytes - The expected size of the data, which needs to be transferred in this job, in terabytes.
    ExpectedDataSizeInTerabytes *int32 `json:"expectedDataSizeInTerabytes,omitempty"`
    // JobStages - READ-ONLY; List of stages that run in the job.
    JobStages *[]JobStages `json:"jobStages,omitempty"`
    // ContactDetails - Contact details for notification and shipping.
    ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
    // DeliveryPackage - READ-ONLY; Delivery package shipping details.
    DeliveryPackage *PackageShippingDetails `json:"deliveryPackage,omitempty"`
    // ReturnPackage - READ-ONLY; Return package shipping details.
    ReturnPackage *PackageShippingDetails `json:"returnPackage,omitempty"`
    // DestinationAccountDetails - Destination account details.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
    // ErrorDetails - READ-ONLY; Error details for failure. This is optional.
    ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
    // Preferences - Preferences for the order.
    Preferences *Preferences `json:"preferences,omitempty"`
    // CopyLogDetails - READ-ONLY; List of copy log details.
    CopyLogDetails *[]BasicCopyLogDetails `json:"copyLogDetails,omitempty"`
    // ReverseShipmentLabelSasKey - READ-ONLY; Shared access key to download the return shipment label
    ReverseShipmentLabelSasKey *string `json:"reverseShipmentLabelSasKey,omitempty"`
    // ChainOfCustodySasKey - READ-ONLY; Shared access key to download the chain of custody logs
    ChainOfCustodySasKey *string `json:"chainOfCustodySasKey,omitempty"`
    // JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDataBoxDisk', 'JobDetailsTypeDataBoxHeavy', 'JobDetailsTypeDataBox'
    JobDetailsType JobDetailsTypeEnum `json:"jobDetailsType,omitempty"`
}

HeavyJobDetails databox Heavy Device Job Details

func (HeavyJobDetails) AsBasicJobDetails Uses

func (hjd HeavyJobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsDiskJobDetails Uses

func (hjd HeavyJobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsHeavyJobDetails Uses

func (hjd HeavyJobDetails) AsHeavyJobDetails() (*HeavyJobDetails, bool)

AsHeavyJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsJobDetails Uses

func (hjd HeavyJobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsJobDetailsType Uses

func (hjd HeavyJobDetails) AsJobDetailsType() (*JobDetailsType, bool)

AsJobDetailsType is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) MarshalJSON Uses

func (hjd HeavyJobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeavyJobDetails.

func (*HeavyJobDetails) UnmarshalJSON Uses

func (hjd *HeavyJobDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HeavyJobDetails struct.

type HeavyJobSecrets Uses

type HeavyJobSecrets struct {
    // CabinetPodSecrets - READ-ONLY; Contains the list of secret objects for a databox heavy job.
    CabinetPodSecrets *[]HeavySecret `json:"cabinetPodSecrets,omitempty"`
    // DcAccessSecurityCode - Dc Access Security Code for Customer Managed Shipping
    DcAccessSecurityCode *DcAccessSecurityCode `json:"dcAccessSecurityCode,omitempty"`
    // JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
    JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

HeavyJobSecrets the secrets related to a databox heavy job.

func (HeavyJobSecrets) AsBasicJobSecrets Uses

func (hjs HeavyJobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsDiskJobSecrets Uses

func (hjs HeavyJobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsHeavyJobSecrets Uses

func (hjs HeavyJobSecrets) AsHeavyJobSecrets() (*HeavyJobSecrets, bool)

AsHeavyJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsJobSecrets Uses

func (hjs HeavyJobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsJobSecretsType Uses

func (hjs HeavyJobSecrets) AsJobSecretsType() (*JobSecretsType, bool)

AsJobSecretsType is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) MarshalJSON Uses

func (hjs HeavyJobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeavyJobSecrets.

type HeavyScheduleAvailabilityRequest Uses

type HeavyScheduleAvailabilityRequest struct {
    // StorageLocation - Location for data transfer.
    // For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    StorageLocation *string `json:"storageLocation,omitempty"`
    // SkuName - Possible values include: 'SkuNameScheduleAvailabilityRequest', 'SkuNameDataBox', 'SkuNameDataBoxDisk', 'SkuNameDataBoxHeavy'
    SkuName SkuNameBasicScheduleAvailabilityRequest `json:"skuName,omitempty"`
}

HeavyScheduleAvailabilityRequest request body to get the availability for scheduling heavy orders.

func (HeavyScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest Uses

func (hsar HeavyScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest() (BasicScheduleAvailabilityRequest, bool)

AsBasicScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for HeavyScheduleAvailabilityRequest.

func (HeavyScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest Uses

func (hsar HeavyScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest() (*DiskScheduleAvailabilityRequest, bool)

AsDiskScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for HeavyScheduleAvailabilityRequest.

func (HeavyScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest Uses

func (hsar HeavyScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest() (*HeavyScheduleAvailabilityRequest, bool)

AsHeavyScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for HeavyScheduleAvailabilityRequest.

func (HeavyScheduleAvailabilityRequest) AsScheduleAvailabilityRequest Uses

func (hsar HeavyScheduleAvailabilityRequest) AsScheduleAvailabilityRequest() (*ScheduleAvailabilityRequest, bool)

AsScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for HeavyScheduleAvailabilityRequest.

func (HeavyScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType Uses

func (hsar HeavyScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType() (*ScheduleAvailabilityRequestType, bool)

AsScheduleAvailabilityRequestType is the BasicScheduleAvailabilityRequest implementation for HeavyScheduleAvailabilityRequest.

func (HeavyScheduleAvailabilityRequest) MarshalJSON Uses

func (hsar HeavyScheduleAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeavyScheduleAvailabilityRequest.

type HeavySecret Uses

type HeavySecret struct {
    // DeviceSerialNumber - READ-ONLY; Serial number of the assigned device.
    DeviceSerialNumber *string `json:"deviceSerialNumber,omitempty"`
    // DevicePassword - READ-ONLY; Password for out of the box experience on device.
    DevicePassword *string `json:"devicePassword,omitempty"`
    // NetworkConfigurations - READ-ONLY; Network configuration of the appliance.
    NetworkConfigurations *[]ApplianceNetworkConfiguration `json:"networkConfigurations,omitempty"`
    // EncodedValidationCertPubKey - READ-ONLY; The base 64 encoded public key to authenticate with the device
    EncodedValidationCertPubKey *string `json:"encodedValidationCertPubKey,omitempty"`
    // AccountCredentialDetails - READ-ONLY; Per account level access credentials.
    AccountCredentialDetails *[]AccountCredentialDetails `json:"accountCredentialDetails,omitempty"`
}

HeavySecret the secrets related to a databox heavy.

type JobDeliveryInfo Uses

type JobDeliveryInfo struct {
    // ScheduledDateTime - Scheduled date time.
    ScheduledDateTime *date.Time `json:"scheduledDateTime,omitempty"`
}

JobDeliveryInfo additional delivery info.

type JobDeliveryType Uses

type JobDeliveryType string

JobDeliveryType enumerates the values for job delivery type.

const (
    // NonScheduled Non Scheduled job.
    NonScheduled JobDeliveryType = "NonScheduled"
    // Scheduled Scheduled job.
    Scheduled JobDeliveryType = "Scheduled"
)

func PossibleJobDeliveryTypeValues Uses

func PossibleJobDeliveryTypeValues() []JobDeliveryType

PossibleJobDeliveryTypeValues returns an array of possible values for the JobDeliveryType const type.

type JobDetails Uses

type JobDetails struct {
    // ExpectedDataSizeInTerabytes - The expected size of the data, which needs to be transferred in this job, in terabytes.
    ExpectedDataSizeInTerabytes *int32 `json:"expectedDataSizeInTerabytes,omitempty"`
    // JobStages - READ-ONLY; List of stages that run in the job.
    JobStages *[]JobStages `json:"jobStages,omitempty"`
    // ContactDetails - Contact details for notification and shipping.
    ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
    // DeliveryPackage - READ-ONLY; Delivery package shipping details.
    DeliveryPackage *PackageShippingDetails `json:"deliveryPackage,omitempty"`
    // ReturnPackage - READ-ONLY; Return package shipping details.
    ReturnPackage *PackageShippingDetails `json:"returnPackage,omitempty"`
    // DestinationAccountDetails - Destination account details.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
    // ErrorDetails - READ-ONLY; Error details for failure. This is optional.
    ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
    // Preferences - Preferences for the order.
    Preferences *Preferences `json:"preferences,omitempty"`
    // CopyLogDetails - READ-ONLY; List of copy log details.
    CopyLogDetails *[]BasicCopyLogDetails `json:"copyLogDetails,omitempty"`
    // ReverseShipmentLabelSasKey - READ-ONLY; Shared access key to download the return shipment label
    ReverseShipmentLabelSasKey *string `json:"reverseShipmentLabelSasKey,omitempty"`
    // ChainOfCustodySasKey - READ-ONLY; Shared access key to download the chain of custody logs
    ChainOfCustodySasKey *string `json:"chainOfCustodySasKey,omitempty"`
    // JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDataBoxDisk', 'JobDetailsTypeDataBoxHeavy', 'JobDetailsTypeDataBox'
    JobDetailsType JobDetailsTypeEnum `json:"jobDetailsType,omitempty"`
}

JobDetails job details.

func (JobDetails) AsBasicJobDetails Uses

func (jd JobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsDiskJobDetails Uses

func (jd JobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsHeavyJobDetails Uses

func (jd JobDetails) AsHeavyJobDetails() (*HeavyJobDetails, bool)

AsHeavyJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsJobDetails Uses

func (jd JobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsJobDetailsType Uses

func (jd JobDetails) AsJobDetailsType() (*JobDetailsType, bool)

AsJobDetailsType is the BasicJobDetails implementation for JobDetails.

func (JobDetails) MarshalJSON Uses

func (jd JobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDetails.

func (*JobDetails) UnmarshalJSON Uses

func (jd *JobDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobDetails struct.

type JobDetailsType Uses

type JobDetailsType struct {
    // CopyProgress - READ-ONLY; Copy progress per storage account.
    CopyProgress *[]CopyProgress `json:"copyProgress,omitempty"`
    // DevicePassword - Set Device password for unlocking Databox
    DevicePassword *string `json:"devicePassword,omitempty"`
    // ExpectedDataSizeInTerabytes - The expected size of the data, which needs to be transferred in this job, in terabytes.
    ExpectedDataSizeInTerabytes *int32 `json:"expectedDataSizeInTerabytes,omitempty"`
    // JobStages - READ-ONLY; List of stages that run in the job.
    JobStages *[]JobStages `json:"jobStages,omitempty"`
    // ContactDetails - Contact details for notification and shipping.
    ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
    // DeliveryPackage - READ-ONLY; Delivery package shipping details.
    DeliveryPackage *PackageShippingDetails `json:"deliveryPackage,omitempty"`
    // ReturnPackage - READ-ONLY; Return package shipping details.
    ReturnPackage *PackageShippingDetails `json:"returnPackage,omitempty"`
    // DestinationAccountDetails - Destination account details.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
    // ErrorDetails - READ-ONLY; Error details for failure. This is optional.
    ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
    // Preferences - Preferences for the order.
    Preferences *Preferences `json:"preferences,omitempty"`
    // CopyLogDetails - READ-ONLY; List of copy log details.
    CopyLogDetails *[]BasicCopyLogDetails `json:"copyLogDetails,omitempty"`
    // ReverseShipmentLabelSasKey - READ-ONLY; Shared access key to download the return shipment label
    ReverseShipmentLabelSasKey *string `json:"reverseShipmentLabelSasKey,omitempty"`
    // ChainOfCustodySasKey - READ-ONLY; Shared access key to download the chain of custody logs
    ChainOfCustodySasKey *string `json:"chainOfCustodySasKey,omitempty"`
    // JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDataBoxDisk', 'JobDetailsTypeDataBoxHeavy', 'JobDetailsTypeDataBox'
    JobDetailsType JobDetailsTypeEnum `json:"jobDetailsType,omitempty"`
}

JobDetailsType databox Job Details

func (JobDetailsType) AsBasicJobDetails Uses

func (jdt JobDetailsType) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsDiskJobDetails Uses

func (jdt JobDetailsType) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsHeavyJobDetails Uses

func (jdt JobDetailsType) AsHeavyJobDetails() (*HeavyJobDetails, bool)

AsHeavyJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsJobDetails Uses

func (jdt JobDetailsType) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsJobDetailsType Uses

func (jdt JobDetailsType) AsJobDetailsType() (*JobDetailsType, bool)

AsJobDetailsType is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) MarshalJSON Uses

func (jdt JobDetailsType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDetailsType.

func (*JobDetailsType) UnmarshalJSON Uses

func (jdt *JobDetailsType) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobDetailsType struct.

type JobDetailsTypeEnum Uses

type JobDetailsTypeEnum string

JobDetailsTypeEnum enumerates the values for job details type enum.

const (
    // JobDetailsTypeDataBox ...
    JobDetailsTypeDataBox JobDetailsTypeEnum = "DataBox"
    // JobDetailsTypeDataBoxDisk ...
    JobDetailsTypeDataBoxDisk JobDetailsTypeEnum = "DataBoxDisk"
    // JobDetailsTypeDataBoxHeavy ...
    JobDetailsTypeDataBoxHeavy JobDetailsTypeEnum = "DataBoxHeavy"
    // JobDetailsTypeJobDetails ...
    JobDetailsTypeJobDetails JobDetailsTypeEnum = "JobDetails"
)

func PossibleJobDetailsTypeEnumValues Uses

func PossibleJobDetailsTypeEnumValues() []JobDetailsTypeEnum

PossibleJobDetailsTypeEnumValues returns an array of possible values for the JobDetailsTypeEnum const type.

type JobErrorDetails Uses

type JobErrorDetails struct {
    // ErrorMessage - READ-ONLY; Message for the error.
    ErrorMessage *string `json:"errorMessage,omitempty"`
    // ErrorCode - READ-ONLY; Code for the error.
    ErrorCode *int32 `json:"errorCode,omitempty"`
    // RecommendedAction - READ-ONLY; Recommended action for the error.
    RecommendedAction *string `json:"recommendedAction,omitempty"`
    // ExceptionMessage - READ-ONLY; Contains the non localized exception message
    ExceptionMessage *string `json:"exceptionMessage,omitempty"`
}

JobErrorDetails job Error Details for providing the information and recommended action.

type JobProperties Uses

type JobProperties struct {
    // IsCancellable - READ-ONLY; Describes whether the job is cancellable or not.
    IsCancellable *bool `json:"isCancellable,omitempty"`
    // IsDeletable - READ-ONLY; Describes whether the job is deletable or not.
    IsDeletable *bool `json:"isDeletable,omitempty"`
    // IsShippingAddressEditable - READ-ONLY; Describes whether the shipping address is editable or not.
    IsShippingAddressEditable *bool `json:"isShippingAddressEditable,omitempty"`
    // Status - READ-ONLY; Name of the stage which is in progress. Possible values include: 'StageNameDeviceOrdered', 'StageNameDevicePrepared', 'StageNameDispatched', 'StageNameDelivered', 'StageNamePickedUp', 'StageNameAtAzureDC', 'StageNameDataCopy', 'StageNameCompleted', 'StageNameCompletedWithErrors', 'StageNameCancelled', 'StageNameFailedIssueReportedAtCustomer', 'StageNameFailedIssueDetectedAtAzureDC', 'StageNameAborted', 'StageNameCompletedWithWarnings', 'StageNameReadyToDispatchFromAzureDC', 'StageNameReadyToReceiveAtAzureDC'
    Status StageName `json:"status,omitempty"`
    // StartTime - READ-ONLY; Time at which the job was started in UTC ISO 8601 format.
    StartTime *date.Time `json:"startTime,omitempty"`
    // Error - READ-ONLY; Top level error for the job.
    Error *Error `json:"error,omitempty"`
    // Details - Details of a job run. This field will only be sent for expand details filter.
    Details BasicJobDetails `json:"details,omitempty"`
    // CancellationReason - READ-ONLY; Reason for cancellation.
    CancellationReason *string `json:"cancellationReason,omitempty"`
    // DeliveryType - Delivery type of Job. Possible values include: 'NonScheduled', 'Scheduled'
    DeliveryType JobDeliveryType `json:"deliveryType,omitempty"`
    // DeliveryInfo - Delivery Info of Job.
    DeliveryInfo *JobDeliveryInfo `json:"deliveryInfo,omitempty"`
    // IsCancellableWithoutFee - READ-ONLY; Flag to indicate cancellation of scheduled job.
    IsCancellableWithoutFee *bool `json:"isCancellableWithoutFee,omitempty"`
}

JobProperties job Properties

func (JobProperties) MarshalJSON Uses

func (jp JobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobProperties.

func (*JobProperties) UnmarshalJSON Uses

func (jp *JobProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobProperties struct.

type JobResource Uses

type JobResource struct {
    autorest.Response `json:"-"`
    // JobProperties - Properties of a job.
    *JobProperties `json:"properties,omitempty"`
    // Name - READ-ONLY; Name of the object.
    Name *string `json:"name,omitempty"`
    // ID - READ-ONLY; Id of the object.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of the object.
    Type *string `json:"type,omitempty"`
    // Location - The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
    Location *string `json:"location,omitempty"`
    // Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
    Tags map[string]*string `json:"tags"`
    // Sku - The sku type.
    Sku *Sku `json:"sku,omitempty"`
}

JobResource job Resource.

func (JobResource) MarshalJSON Uses

func (jr JobResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResource.

func (*JobResource) UnmarshalJSON Uses

func (jr *JobResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobResource struct.

type JobResourceList Uses

type JobResourceList struct {
    autorest.Response `json:"-"`
    // Value - List of job resources.
    Value *[]JobResource `json:"value,omitempty"`
    // NextLink - Link for the next set of job resources.
    NextLink *string `json:"nextLink,omitempty"`
}

JobResourceList job Resource Collection

func (JobResourceList) IsEmpty Uses

func (jrl JobResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobResourceListIterator Uses

type JobResourceListIterator struct {
    // contains filtered or unexported fields
}

JobResourceListIterator provides access to a complete listing of JobResource values.

func NewJobResourceListIterator Uses

func NewJobResourceListIterator(page JobResourceListPage) JobResourceListIterator

Creates a new instance of the JobResourceListIterator type.

func (*JobResourceListIterator) Next Uses

func (iter *JobResourceListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*JobResourceListIterator) NextWithContext Uses

func (iter *JobResourceListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (JobResourceListIterator) NotDone Uses

func (iter JobResourceListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (JobResourceListIterator) Response Uses

func (iter JobResourceListIterator) Response() JobResourceList

Response returns the raw server response from the last page request.

func (JobResourceListIterator) Value Uses

func (iter JobResourceListIterator) Value() JobResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobResourceListPage Uses

type JobResourceListPage struct {
    // contains filtered or unexported fields
}

JobResourceListPage contains a page of JobResource values.

func NewJobResourceListPage Uses

func NewJobResourceListPage(cur JobResourceList, getNextPage func(context.Context, JobResourceList) (JobResourceList, error)) JobResourceListPage

Creates a new instance of the JobResourceListPage type.

func (*JobResourceListPage) Next Uses

func (page *JobResourceListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*JobResourceListPage) NextWithContext Uses

func (page *JobResourceListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (JobResourceListPage) NotDone Uses

func (page JobResourceListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (JobResourceListPage) Response Uses

func (page JobResourceListPage) Response() JobResourceList

Response returns the raw server response from the last page request.

func (JobResourceListPage) Values Uses

func (page JobResourceListPage) Values() []JobResource

Values returns the slice of values for the current page or nil if there are no values.

type JobResourceUpdateParameter Uses

type JobResourceUpdateParameter struct {
    // UpdateJobProperties - Properties of a job to be updated.
    *UpdateJobProperties `json:"properties,omitempty"`
    // Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
    Tags map[string]*string `json:"tags"`
}

JobResourceUpdateParameter the JobResourceUpdateParameter.

func (JobResourceUpdateParameter) MarshalJSON Uses

func (jrup JobResourceUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResourceUpdateParameter.

func (*JobResourceUpdateParameter) UnmarshalJSON Uses

func (jrup *JobResourceUpdateParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobResourceUpdateParameter struct.

type JobSecrets Uses

type JobSecrets struct {
    // DcAccessSecurityCode - Dc Access Security Code for Customer Managed Shipping
    DcAccessSecurityCode *DcAccessSecurityCode `json:"dcAccessSecurityCode,omitempty"`
    // JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
    JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

JobSecrets the base class for the secrets

func (JobSecrets) AsBasicJobSecrets Uses

func (js JobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsDiskJobSecrets Uses

func (js JobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsHeavyJobSecrets Uses

func (js JobSecrets) AsHeavyJobSecrets() (*HeavyJobSecrets, bool)

AsHeavyJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsJobSecrets Uses

func (js JobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsJobSecretsType Uses

func (js JobSecrets) AsJobSecretsType() (*JobSecretsType, bool)

AsJobSecretsType is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) MarshalJSON Uses

func (js JobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobSecrets.

type JobSecretsType Uses

type JobSecretsType struct {
    // PodSecrets - Contains the list of secret objects for a job.
    PodSecrets *[]Secret `json:"podSecrets,omitempty"`
    // DcAccessSecurityCode - Dc Access Security Code for Customer Managed Shipping
    DcAccessSecurityCode *DcAccessSecurityCode `json:"dcAccessSecurityCode,omitempty"`
    // JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
    JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

JobSecretsType the secrets related to a databox job.

func (JobSecretsType) AsBasicJobSecrets Uses

func (jst JobSecretsType) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsDiskJobSecrets Uses

func (jst JobSecretsType) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsHeavyJobSecrets Uses

func (jst JobSecretsType) AsHeavyJobSecrets() (*HeavyJobSecrets, bool)

AsHeavyJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsJobSecrets Uses

func (jst JobSecretsType) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsJobSecretsType Uses

func (jst JobSecretsType) AsJobSecretsType() (*JobSecretsType, bool)

AsJobSecretsType is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) MarshalJSON Uses

func (jst JobSecretsType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobSecretsType.

type JobSecretsTypeEnum Uses

type JobSecretsTypeEnum string

JobSecretsTypeEnum enumerates the values for job secrets type enum.

const (
    // JobSecretsTypeDataBox ...
    JobSecretsTypeDataBox JobSecretsTypeEnum = "DataBox"
    // JobSecretsTypeDataBoxDisk ...
    JobSecretsTypeDataBoxDisk JobSecretsTypeEnum = "DataBoxDisk"
    // JobSecretsTypeDataBoxHeavy ...
    JobSecretsTypeDataBoxHeavy JobSecretsTypeEnum = "DataBoxHeavy"
    // JobSecretsTypeJobSecrets ...
    JobSecretsTypeJobSecrets JobSecretsTypeEnum = "JobSecrets"
)

func PossibleJobSecretsTypeEnumValues Uses

func PossibleJobSecretsTypeEnumValues() []JobSecretsTypeEnum

PossibleJobSecretsTypeEnumValues returns an array of possible values for the JobSecretsTypeEnum const type.

type JobStages Uses

type JobStages struct {
    // StageName - READ-ONLY; Name of the job stage. Possible values include: 'StageNameDeviceOrdered', 'StageNameDevicePrepared', 'StageNameDispatched', 'StageNameDelivered', 'StageNamePickedUp', 'StageNameAtAzureDC', 'StageNameDataCopy', 'StageNameCompleted', 'StageNameCompletedWithErrors', 'StageNameCancelled', 'StageNameFailedIssueReportedAtCustomer', 'StageNameFailedIssueDetectedAtAzureDC', 'StageNameAborted', 'StageNameCompletedWithWarnings', 'StageNameReadyToDispatchFromAzureDC', 'StageNameReadyToReceiveAtAzureDC'
    StageName StageName `json:"stageName,omitempty"`
    // DisplayName - READ-ONLY; Display name of the job stage.
    DisplayName *string `json:"displayName,omitempty"`
    // StageStatus - READ-ONLY; Status of the job stage. Possible values include: 'StageStatusNone', 'StageStatusInProgress', 'StageStatusSucceeded', 'StageStatusFailed', 'StageStatusCancelled', 'StageStatusCancelling', 'StageStatusSucceededWithErrors'
    StageStatus StageStatus `json:"stageStatus,omitempty"`
    // StageTime - READ-ONLY; Time for the job stage in UTC ISO 8601 format.
    StageTime *date.Time `json:"stageTime,omitempty"`
    // JobStageDetails - READ-ONLY; Job Stage Details
    JobStageDetails interface{} `json:"jobStageDetails,omitempty"`
    // ErrorDetails - READ-ONLY; Error details for the stage.
    ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
}

JobStages job stages.

type JobsClient Uses

type JobsClient struct {
    BaseClient
}

JobsClient is the client for the Jobs methods of the Databox service.

func NewJobsClient Uses

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI Uses

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (JobsClient) BookShipmentPickUp Uses

func (client JobsClient) BookShipmentPickUp(ctx context.Context, resourceGroupName string, jobName string, shipmentPickUpRequest ShipmentPickUpRequest) (result ShipmentPickUpResponse, err error)

BookShipmentPickUp book shipment pick up. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only shipmentPickUpRequest - details of shipment pick up request.

func (JobsClient) BookShipmentPickUpPreparer Uses

func (client JobsClient) BookShipmentPickUpPreparer(ctx context.Context, resourceGroupName string, jobName string, shipmentPickUpRequest ShipmentPickUpRequest) (*http.Request, error)

BookShipmentPickUpPreparer prepares the BookShipmentPickUp request.

func (JobsClient) BookShipmentPickUpResponder Uses

func (client JobsClient) BookShipmentPickUpResponder(resp *http.Response) (result ShipmentPickUpResponse, err error)

BookShipmentPickUpResponder handles the response to the BookShipmentPickUp request. The method always closes the http.Response Body.

func (JobsClient) BookShipmentPickUpSender Uses

func (client JobsClient) BookShipmentPickUpSender(req *http.Request) (*http.Response, error)

BookShipmentPickUpSender sends the BookShipmentPickUp request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Cancel Uses

func (client JobsClient) Cancel(ctx context.Context, resourceGroupName string, jobName string, cancellationReason CancellationReason) (result autorest.Response, err error)

Cancel cancelJob. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only cancellationReason - reason for cancellation.

func (JobsClient) CancelPreparer Uses

func (client JobsClient) CancelPreparer(ctx context.Context, resourceGroupName string, jobName string, cancellationReason CancellationReason) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (JobsClient) CancelResponder Uses

func (client JobsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (JobsClient) CancelSender Uses

func (client JobsClient) CancelSender(req *http.Request) (*http.Response, error)

CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Create Uses

func (client JobsClient) Create(ctx context.Context, resourceGroupName string, jobName string, jobResource JobResource) (result JobsCreateFuture, err error)

Create creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only jobResource - job details from request body.

func (JobsClient) CreatePreparer Uses

func (client JobsClient) CreatePreparer(ctx context.Context, resourceGroupName string, jobName string, jobResource JobResource) (*http.Request, error)

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder Uses

func (client JobsClient) CreateResponder(resp *http.Response) (result JobResource, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (JobsClient) CreateSender Uses

func (client JobsClient) CreateSender(req *http.Request) (future JobsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Delete Uses

func (client JobsClient) Delete(ctx context.Context, resourceGroupName string, jobName string) (result JobsDeleteFuture, err error)

Delete deletes a job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) DeletePreparer Uses

func (client JobsClient) DeletePreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder Uses

func (client JobsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobsClient) DeleteSender Uses

func (client JobsClient) DeleteSender(req *http.Request) (future JobsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Get Uses

func (client JobsClient) Get(ctx context.Context, resourceGroupName string, jobName string, expand string) (result JobResource, err error)

Get gets information about the specified job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only expand - $expand is supported on details parameter for job, which provides details on the job stages.

func (JobsClient) GetPreparer Uses

func (client JobsClient) GetPreparer(ctx context.Context, resourceGroupName string, jobName string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder Uses

func (client JobsClient) GetResponder(resp *http.Response) (result JobResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (JobsClient) GetSender Uses

func (client JobsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (JobsClient) List Uses

func (client JobsClient) List(ctx context.Context, skipToken string) (result JobResourceListPage, err error)

List lists all the jobs available under the subscription. Parameters: skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

func (JobsClient) ListByResourceGroup Uses

func (client JobsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result JobResourceListPage, err error)

ListByResourceGroup lists all the jobs available under the given resource group. Parameters: resourceGroupName - the Resource Group Name skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

func (JobsClient) ListByResourceGroupComplete Uses

func (client JobsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skipToken string) (result JobResourceListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListByResourceGroupPreparer Uses

func (client JobsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobsClient) ListByResourceGroupResponder Uses

func (client JobsClient) ListByResourceGroupResponder(resp *http.Response) (result JobResourceList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (JobsClient) ListByResourceGroupSender Uses

func (client JobsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListComplete Uses

func (client JobsClient) ListComplete(ctx context.Context, skipToken string) (result JobResourceListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListCredentials Uses

func (client JobsClient) ListCredentials(ctx context.Context, resourceGroupName string, jobName string) (result UnencryptedCredentialsList, err error)

ListCredentials this method gets the unencrypted secrets related to the job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) ListCredentialsPreparer Uses

func (client JobsClient) ListCredentialsPreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

ListCredentialsPreparer prepares the ListCredentials request.

func (JobsClient) ListCredentialsResponder Uses

func (client JobsClient) ListCredentialsResponder(resp *http.Response) (result UnencryptedCredentialsList, err error)

ListCredentialsResponder handles the response to the ListCredentials request. The method always closes the http.Response Body.

func (JobsClient) ListCredentialsSender Uses

func (client JobsClient) ListCredentialsSender(req *http.Request) (*http.Response, error)

ListCredentialsSender sends the ListCredentials request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListPreparer Uses

func (client JobsClient) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListResponder Uses

func (client JobsClient) ListResponder(resp *http.Response) (result JobResourceList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (JobsClient) ListSender Uses

func (client JobsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Update Uses

func (client JobsClient) Update(ctx context.Context, resourceGroupName string, jobName string, jobResourceUpdateParameter JobResourceUpdateParameter, ifMatch string) (result JobsUpdateFuture, err error)

Update updates the properties of an existing job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only jobResourceUpdateParameter - job update parameters from request body. ifMatch - defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

func (JobsClient) UpdatePreparer Uses

func (client JobsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, jobName string, jobResourceUpdateParameter JobResourceUpdateParameter, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (JobsClient) UpdateResponder Uses

func (client JobsClient) UpdateResponder(resp *http.Response) (result JobResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (JobsClient) UpdateSender Uses

func (client JobsClient) UpdateSender(req *http.Request) (future JobsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type JobsCreateFuture Uses

type JobsCreateFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(JobsClient) (JobResource, error)
}

JobsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type JobsDeleteFuture Uses

type JobsDeleteFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(JobsClient) (autorest.Response, error)
}

JobsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type JobsUpdateFuture Uses

type JobsUpdateFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(JobsClient) (JobResource, error)
}

JobsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type NotificationPreference Uses

type NotificationPreference struct {
    // StageName - Name of the stage. Possible values include: 'DevicePrepared', 'Dispatched', 'Delivered', 'PickedUp', 'AtAzureDC', 'DataCopy'
    StageName NotificationStageName `json:"stageName,omitempty"`
    // SendNotification - Notification is required or not.
    SendNotification *bool `json:"sendNotification,omitempty"`
}

NotificationPreference notification preference for a job stage.

type NotificationStageName Uses

type NotificationStageName string

NotificationStageName enumerates the values for notification stage name.

const (
    // AtAzureDC Notification at device received at azure datacenter stage.
    AtAzureDC NotificationStageName = "AtAzureDC"
    // DataCopy Notification at data copy started stage.
    DataCopy NotificationStageName = "DataCopy"
    // Delivered Notification at device delivered stage.
    Delivered NotificationStageName = "Delivered"
    // DevicePrepared Notification at device prepared stage.
    DevicePrepared NotificationStageName = "DevicePrepared"
    // Dispatched Notification at device dispatched stage.
    Dispatched NotificationStageName = "Dispatched"
    // PickedUp Notification at device picked up from user stage.
    PickedUp NotificationStageName = "PickedUp"
)

func PossibleNotificationStageNameValues Uses

func PossibleNotificationStageNameValues() []NotificationStageName

PossibleNotificationStageNameValues returns an array of possible values for the NotificationStageName const type.

type Operation Uses

type Operation struct {
    // Name - READ-ONLY; Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}
    Name *string `json:"name,omitempty"`
    // Display - READ-ONLY; Operation display values.
    Display *OperationDisplay `json:"display,omitempty"`
    // Properties - READ-ONLY; Operation properties.
    Properties interface{} `json:"properties,omitempty"`
    // Origin - READ-ONLY; Origin of the operation. Can be : user|system|user,system
    Origin *string `json:"origin,omitempty"`
}

Operation operation entity.

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - Provider name.
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource name.
    Resource *string `json:"resource,omitempty"`
    // Operation - Localized name of the operation for display purpose.
    Operation *string `json:"operation,omitempty"`
    // Description - Localized description of the operation for display purpose.
    Description *string `json:"description,omitempty"`
}

OperationDisplay operation display

type OperationList Uses

type OperationList struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; List of operations.
    Value *[]Operation `json:"value,omitempty"`
    // NextLink - Link for the next set of operations.
    NextLink *string `json:"nextLink,omitempty"`
}

OperationList operation Collection.

func (OperationList) IsEmpty Uses

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationList) MarshalJSON Uses

func (ol OperationList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationList.

type OperationListIterator Uses

type OperationListIterator struct {
    // contains filtered or unexported fields
}

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator Uses

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next Uses

func (iter *OperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListIterator) NextWithContext Uses

func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone Uses

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response Uses

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value Uses

func (iter OperationListIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage Uses

type OperationListPage struct {
    // contains filtered or unexported fields
}

OperationListPage contains a page of Operation values.

func NewOperationListPage Uses

func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next Uses

func (page *OperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListPage) NextWithContext Uses

func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListPage) NotDone Uses

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response Uses

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values Uses

func (page OperationListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the client for the Operations methods of the Databox service.

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result OperationListPage, err error)

List this method gets all the operations.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer Uses

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender Uses

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OverallValidationStatus Uses

type OverallValidationStatus string

OverallValidationStatus enumerates the values for overall validation status.

const (
    // AllValidToProceed Every input request is valid.
    AllValidToProceed OverallValidationStatus = "AllValidToProceed"
    // CertainInputValidationsSkipped Certain input validations skipped.
    CertainInputValidationsSkipped OverallValidationStatus = "CertainInputValidationsSkipped"
    // InputsRevisitRequired Some input requests are not valid.
    InputsRevisitRequired OverallValidationStatus = "InputsRevisitRequired"
)

func PossibleOverallValidationStatusValues Uses

func PossibleOverallValidationStatusValues() []OverallValidationStatus

PossibleOverallValidationStatusValues returns an array of possible values for the OverallValidationStatus const type.

type PackageShippingDetails Uses

type PackageShippingDetails struct {
    // CarrierName - READ-ONLY; Name of the carrier.
    CarrierName *string `json:"carrierName,omitempty"`
    // TrackingID - READ-ONLY; Tracking Id of shipment.
    TrackingID *string `json:"trackingId,omitempty"`
    // TrackingURL - READ-ONLY; Url where shipment can be tracked.
    TrackingURL *string `json:"trackingUrl,omitempty"`
}

PackageShippingDetails shipping details.

type Preferences Uses

type Preferences struct {
    // PreferredDataCenterRegion - Preferred Data Center Region.
    PreferredDataCenterRegion *[]string `json:"preferredDataCenterRegion,omitempty"`
    // TransportPreferences - Preferences related to the shipment logistics of the sku.
    TransportPreferences *TransportPreferences `json:"transportPreferences,omitempty"`
}

Preferences preferences related to the order

type PreferencesValidationRequest Uses

type PreferencesValidationRequest struct {
    // Preference - Preference requested with respect to transport type and data center
    Preference *Preferences `json:"preference,omitempty"`
    // DeviceType - Device type to be used for the job. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    DeviceType SkuName `json:"deviceType,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

PreferencesValidationRequest request to validate preference of transport and data center.

func (PreferencesValidationRequest) AsBasicValidationInputRequest Uses

func (pvr PreferencesValidationRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (pvr PreferencesValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsDataDestinationDetailsValidationRequest Uses

func (pvr PreferencesValidationRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsPreferencesValidationRequest Uses

func (pvr PreferencesValidationRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsSkuAvailabilityValidationRequest Uses

func (pvr PreferencesValidationRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (pvr PreferencesValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsValidateAddress Uses

func (pvr PreferencesValidationRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) AsValidationInputRequest Uses

func (pvr PreferencesValidationRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for PreferencesValidationRequest.

func (PreferencesValidationRequest) MarshalJSON Uses

func (pvr PreferencesValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PreferencesValidationRequest.

type PreferencesValidationResponseProperties Uses

type PreferencesValidationResponseProperties struct {
    // Status - READ-ONLY; Validation status of requested data center and transport. Possible values include: 'ValidationStatusValid', 'ValidationStatusInvalid', 'ValidationStatusSkipped'
    Status ValidationStatus `json:"status,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

PreferencesValidationResponseProperties properties of data center and transport preference validation response.

func (PreferencesValidationResponseProperties) AsAddressValidationProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsBasicValidationInputResponse Uses

func (pvrp PreferencesValidationResponseProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsPreferencesValidationResponseProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (pvrp PreferencesValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) AsValidationInputResponse Uses

func (pvrp PreferencesValidationResponseProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for PreferencesValidationResponseProperties.

func (PreferencesValidationResponseProperties) MarshalJSON Uses

func (pvrp PreferencesValidationResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PreferencesValidationResponseProperties.

type RegionConfigurationRequest Uses

type RegionConfigurationRequest struct {
    // ScheduleAvailabilityRequest - Request body to get the availability for scheduling orders.
    ScheduleAvailabilityRequest BasicScheduleAvailabilityRequest `json:"scheduleAvailabilityRequest,omitempty"`
    // TransportAvailabilityRequest - Request body to get the transport availability for given sku.
    TransportAvailabilityRequest *TransportAvailabilityRequest `json:"transportAvailabilityRequest,omitempty"`
}

RegionConfigurationRequest request body to get the configuration for the region.

func (*RegionConfigurationRequest) UnmarshalJSON Uses

func (rcr *RegionConfigurationRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegionConfigurationRequest struct.

type RegionConfigurationResponse Uses

type RegionConfigurationResponse struct {
    autorest.Response `json:"-"`
    // ScheduleAvailabilityResponse - READ-ONLY; Schedule availability for given sku in a region.
    ScheduleAvailabilityResponse *ScheduleAvailabilityResponse `json:"scheduleAvailabilityResponse,omitempty"`
    // TransportAvailabilityResponse - READ-ONLY; Transport options available for given sku in a region.
    TransportAvailabilityResponse *TransportAvailabilityResponse `json:"transportAvailabilityResponse,omitempty"`
}

RegionConfigurationResponse configuration response specific to a region.

type Resource Uses

type Resource struct {
    // Location - The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
    Location *string `json:"location,omitempty"`
    // Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
    Tags map[string]*string `json:"tags"`
    // Sku - The sku type.
    Sku *Sku `json:"sku,omitempty"`
}

Resource model of the Resource.

func (Resource) MarshalJSON Uses

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ScheduleAvailabilityRequest Uses

type ScheduleAvailabilityRequest struct {
    // StorageLocation - Location for data transfer.
    // For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    StorageLocation *string `json:"storageLocation,omitempty"`
    // SkuName - Possible values include: 'SkuNameScheduleAvailabilityRequest', 'SkuNameDataBox', 'SkuNameDataBoxDisk', 'SkuNameDataBoxHeavy'
    SkuName SkuNameBasicScheduleAvailabilityRequest `json:"skuName,omitempty"`
}

ScheduleAvailabilityRequest request body to get the availability for scheduling orders.

func (ScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest Uses

func (sar ScheduleAvailabilityRequest) AsBasicScheduleAvailabilityRequest() (BasicScheduleAvailabilityRequest, bool)

AsBasicScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequest.

func (ScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest Uses

func (sar ScheduleAvailabilityRequest) AsDiskScheduleAvailabilityRequest() (*DiskScheduleAvailabilityRequest, bool)

AsDiskScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequest.

func (ScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest Uses

func (sar ScheduleAvailabilityRequest) AsHeavyScheduleAvailabilityRequest() (*HeavyScheduleAvailabilityRequest, bool)

AsHeavyScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequest.

func (ScheduleAvailabilityRequest) AsScheduleAvailabilityRequest Uses

func (sar ScheduleAvailabilityRequest) AsScheduleAvailabilityRequest() (*ScheduleAvailabilityRequest, bool)

AsScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequest.

func (ScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType Uses

func (sar ScheduleAvailabilityRequest) AsScheduleAvailabilityRequestType() (*ScheduleAvailabilityRequestType, bool)

AsScheduleAvailabilityRequestType is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequest.

func (ScheduleAvailabilityRequest) MarshalJSON Uses

func (sar ScheduleAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ScheduleAvailabilityRequest.

type ScheduleAvailabilityRequestType Uses

type ScheduleAvailabilityRequestType struct {
    // StorageLocation - Location for data transfer.
    // For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    StorageLocation *string `json:"storageLocation,omitempty"`
    // SkuName - Possible values include: 'SkuNameScheduleAvailabilityRequest', 'SkuNameDataBox', 'SkuNameDataBoxDisk', 'SkuNameDataBoxHeavy'
    SkuName SkuNameBasicScheduleAvailabilityRequest `json:"skuName,omitempty"`
}

ScheduleAvailabilityRequestType request body to get the availability for scheduling data box orders orders.

func (ScheduleAvailabilityRequestType) AsBasicScheduleAvailabilityRequest Uses

func (sart ScheduleAvailabilityRequestType) AsBasicScheduleAvailabilityRequest() (BasicScheduleAvailabilityRequest, bool)

AsBasicScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequestType.

func (ScheduleAvailabilityRequestType) AsDiskScheduleAvailabilityRequest Uses

func (sart ScheduleAvailabilityRequestType) AsDiskScheduleAvailabilityRequest() (*DiskScheduleAvailabilityRequest, bool)

AsDiskScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequestType.

func (ScheduleAvailabilityRequestType) AsHeavyScheduleAvailabilityRequest Uses

func (sart ScheduleAvailabilityRequestType) AsHeavyScheduleAvailabilityRequest() (*HeavyScheduleAvailabilityRequest, bool)

AsHeavyScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequestType.

func (ScheduleAvailabilityRequestType) AsScheduleAvailabilityRequest Uses

func (sart ScheduleAvailabilityRequestType) AsScheduleAvailabilityRequest() (*ScheduleAvailabilityRequest, bool)

AsScheduleAvailabilityRequest is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequestType.

func (ScheduleAvailabilityRequestType) AsScheduleAvailabilityRequestType Uses

func (sart ScheduleAvailabilityRequestType) AsScheduleAvailabilityRequestType() (*ScheduleAvailabilityRequestType, bool)

AsScheduleAvailabilityRequestType is the BasicScheduleAvailabilityRequest implementation for ScheduleAvailabilityRequestType.

func (ScheduleAvailabilityRequestType) MarshalJSON Uses

func (sart ScheduleAvailabilityRequestType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ScheduleAvailabilityRequestType.

type ScheduleAvailabilityResponse Uses

type ScheduleAvailabilityResponse struct {
    // AvailableDates - READ-ONLY; List of dates available to schedule
    AvailableDates *[]date.Time `json:"availableDates,omitempty"`
}

ScheduleAvailabilityResponse schedule availability response for given sku in a region.

type Secret Uses

type Secret struct {
    // DeviceSerialNumber - READ-ONLY; Serial number of the assigned device.
    DeviceSerialNumber *string `json:"deviceSerialNumber,omitempty"`
    // DevicePassword - READ-ONLY; Password for out of the box experience on device.
    DevicePassword *string `json:"devicePassword,omitempty"`
    // NetworkConfigurations - READ-ONLY; Network configuration of the appliance.
    NetworkConfigurations *[]ApplianceNetworkConfiguration `json:"networkConfigurations,omitempty"`
    // EncodedValidationCertPubKey - READ-ONLY; The base 64 encoded public key to authenticate with the device
    EncodedValidationCertPubKey *string `json:"encodedValidationCertPubKey,omitempty"`
    // AccountCredentialDetails - READ-ONLY; Per account level access credentials.
    AccountCredentialDetails *[]AccountCredentialDetails `json:"accountCredentialDetails,omitempty"`
}

Secret the secrets related to a DataBox.

type ServiceClient Uses

type ServiceClient struct {
    BaseClient
}

ServiceClient is the client for the Service methods of the Databox service.

func NewServiceClient Uses

func NewServiceClient(subscriptionID string) ServiceClient

NewServiceClient creates an instance of the ServiceClient client.

func NewServiceClientWithBaseURI Uses

func NewServiceClientWithBaseURI(baseURI string, subscriptionID string) ServiceClient

NewServiceClientWithBaseURI creates an instance of the ServiceClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ServiceClient) ListAvailableSkus Uses

func (client ServiceClient) ListAvailableSkus(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultPage, err error)

ListAvailableSkus this method provides the list of available skus for the given subscription and location. Parameters: location - the location of the resource availableSkuRequest - filters for showing the available skus.

func (ServiceClient) ListAvailableSkusByResourceGroup Uses

func (client ServiceClient) ListAvailableSkusByResourceGroup(ctx context.Context, resourceGroupName string, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultPage, err error)

ListAvailableSkusByResourceGroup this method provides the list of available skus for the given subscription, resource group and location. Parameters: resourceGroupName - the Resource Group Name location - the location of the resource availableSkuRequest - filters for showing the available skus.

func (ServiceClient) ListAvailableSkusByResourceGroupComplete Uses

func (client ServiceClient) ListAvailableSkusByResourceGroupComplete(ctx context.Context, resourceGroupName string, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultIterator, err error)

ListAvailableSkusByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceClient) ListAvailableSkusByResourceGroupPreparer Uses

func (client ServiceClient) ListAvailableSkusByResourceGroupPreparer(ctx context.Context, resourceGroupName string, location string, availableSkuRequest AvailableSkuRequest) (*http.Request, error)

ListAvailableSkusByResourceGroupPreparer prepares the ListAvailableSkusByResourceGroup request.

func (ServiceClient) ListAvailableSkusByResourceGroupResponder Uses

func (client ServiceClient) ListAvailableSkusByResourceGroupResponder(resp *http.Response) (result AvailableSkusResult, err error)

ListAvailableSkusByResourceGroupResponder handles the response to the ListAvailableSkusByResourceGroup request. The method always closes the http.Response Body.

func (ServiceClient) ListAvailableSkusByResourceGroupSender Uses

func (client ServiceClient) ListAvailableSkusByResourceGroupSender(req *http.Request) (*http.Response, error)

ListAvailableSkusByResourceGroupSender sends the ListAvailableSkusByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) ListAvailableSkusComplete Uses

func (client ServiceClient) ListAvailableSkusComplete(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultIterator, err error)

ListAvailableSkusComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceClient) ListAvailableSkusPreparer Uses

func (client ServiceClient) ListAvailableSkusPreparer(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (*http.Request, error)

ListAvailableSkusPreparer prepares the ListAvailableSkus request.

func (ServiceClient) ListAvailableSkusResponder Uses

func (client ServiceClient) ListAvailableSkusResponder(resp *http.Response) (result AvailableSkusResult, err error)

ListAvailableSkusResponder handles the response to the ListAvailableSkus request. The method always closes the http.Response Body.

func (ServiceClient) ListAvailableSkusSender Uses

func (client ServiceClient) ListAvailableSkusSender(req *http.Request) (*http.Response, error)

ListAvailableSkusSender sends the ListAvailableSkus request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) RegionConfiguration Uses

func (client ServiceClient) RegionConfiguration(ctx context.Context, location string, regionConfigurationRequest RegionConfigurationRequest) (result RegionConfigurationResponse, err error)

RegionConfiguration this API provides configuration details specific to given region/location. Parameters: location - the location of the resource regionConfigurationRequest - request body to get the configuration for the region.

func (ServiceClient) RegionConfigurationPreparer Uses

func (client ServiceClient) RegionConfigurationPreparer(ctx context.Context, location string, regionConfigurationRequest RegionConfigurationRequest) (*http.Request, error)

RegionConfigurationPreparer prepares the RegionConfiguration request.

func (ServiceClient) RegionConfigurationResponder Uses

func (client ServiceClient) RegionConfigurationResponder(resp *http.Response) (result RegionConfigurationResponse, err error)

RegionConfigurationResponder handles the response to the RegionConfiguration request. The method always closes the http.Response Body.

func (ServiceClient) RegionConfigurationSender Uses

func (client ServiceClient) RegionConfigurationSender(req *http.Request) (*http.Response, error)

RegionConfigurationSender sends the RegionConfiguration request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) ValidateAddressMethod Uses

func (client ServiceClient) ValidateAddressMethod(ctx context.Context, location string, validateAddress ValidateAddress) (result AddressValidationOutput, err error)

ValidateAddressMethod [DEPRECATED NOTICE: This operation will soon be removed] This method validates the customer shipping address and provide alternate addresses if any. Parameters: location - the location of the resource validateAddress - shipping address of the customer.

func (ServiceClient) ValidateAddressMethodPreparer Uses

func (client ServiceClient) ValidateAddressMethodPreparer(ctx context.Context, location string, validateAddress ValidateAddress) (*http.Request, error)

ValidateAddressMethodPreparer prepares the ValidateAddressMethod request.

func (ServiceClient) ValidateAddressMethodResponder Uses

func (client ServiceClient) ValidateAddressMethodResponder(resp *http.Response) (result AddressValidationOutput, err error)

ValidateAddressMethodResponder handles the response to the ValidateAddressMethod request. The method always closes the http.Response Body.

func (ServiceClient) ValidateAddressMethodSender Uses

func (client ServiceClient) ValidateAddressMethodSender(req *http.Request) (*http.Response, error)

ValidateAddressMethodSender sends the ValidateAddressMethod request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) ValidateInputs Uses

func (client ServiceClient) ValidateInputs(ctx context.Context, location string, validationRequest BasicValidationRequest) (result ValidationResponse, err error)

ValidateInputs this method does all necessary pre-job creation validation under subscription. Parameters: location - the location of the resource validationRequest - inputs of the customer.

func (ServiceClient) ValidateInputsByResourceGroup Uses

func (client ServiceClient) ValidateInputsByResourceGroup(ctx context.Context, resourceGroupName string, location string, validationRequest BasicValidationRequest) (result ValidationResponse, err error)

ValidateInputsByResourceGroup this method does all necessary pre-job creation validation under resource group. Parameters: resourceGroupName - the Resource Group Name location - the location of the resource validationRequest - inputs of the customer.

func (ServiceClient) ValidateInputsByResourceGroupPreparer Uses

func (client ServiceClient) ValidateInputsByResourceGroupPreparer(ctx context.Context, resourceGroupName string, location string, validationRequest BasicValidationRequest) (*http.Request, error)

ValidateInputsByResourceGroupPreparer prepares the ValidateInputsByResourceGroup request.

func (ServiceClient) ValidateInputsByResourceGroupResponder Uses

func (client ServiceClient) ValidateInputsByResourceGroupResponder(resp *http.Response) (result ValidationResponse, err error)

ValidateInputsByResourceGroupResponder handles the response to the ValidateInputsByResourceGroup request. The method always closes the http.Response Body.

func (ServiceClient) ValidateInputsByResourceGroupSender Uses

func (client ServiceClient) ValidateInputsByResourceGroupSender(req *http.Request) (*http.Response, error)

ValidateInputsByResourceGroupSender sends the ValidateInputsByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) ValidateInputsPreparer Uses

func (client ServiceClient) ValidateInputsPreparer(ctx context.Context, location string, validationRequest BasicValidationRequest) (*http.Request, error)

ValidateInputsPreparer prepares the ValidateInputs request.

func (ServiceClient) ValidateInputsResponder Uses

func (client ServiceClient) ValidateInputsResponder(resp *http.Response) (result ValidationResponse, err error)

ValidateInputsResponder handles the response to the ValidateInputs request. The method always closes the http.Response Body.

func (ServiceClient) ValidateInputsSender Uses

func (client ServiceClient) ValidateInputsSender(req *http.Request) (*http.Response, error)

ValidateInputsSender sends the ValidateInputs request. The method will close the http.Response Body if it receives an error.

type ShareCredentialDetails Uses

type ShareCredentialDetails struct {
    // ShareName - READ-ONLY; Name of the share.
    ShareName *string `json:"shareName,omitempty"`
    // ShareType - READ-ONLY; Type of the share. Possible values include: 'ShareDestinationFormatTypeUnknownType', 'ShareDestinationFormatTypeHCS', 'ShareDestinationFormatTypeBlockBlob', 'ShareDestinationFormatTypePageBlob', 'ShareDestinationFormatTypeAzureFile', 'ShareDestinationFormatTypeManagedDisk'
    ShareType ShareDestinationFormatType `json:"shareType,omitempty"`
    // UserName - READ-ONLY; User name for the share.
    UserName *string `json:"userName,omitempty"`
    // Password - READ-ONLY; Password for the share.
    Password *string `json:"password,omitempty"`
    // SupportedAccessProtocols - READ-ONLY; Access protocols supported on the device.
    SupportedAccessProtocols *[]AccessProtocol `json:"supportedAccessProtocols,omitempty"`
}

ShareCredentialDetails credential details of the shares in account.

type ShareDestinationFormatType Uses

type ShareDestinationFormatType string

ShareDestinationFormatType enumerates the values for share destination format type.

const (
    // ShareDestinationFormatTypeAzureFile Azure storage file format.
    ShareDestinationFormatTypeAzureFile ShareDestinationFormatType = "AzureFile"
    // ShareDestinationFormatTypeBlockBlob Azure storage block blob format.
    ShareDestinationFormatTypeBlockBlob ShareDestinationFormatType = "BlockBlob"
    // ShareDestinationFormatTypeHCS Storsimple data format.
    ShareDestinationFormatTypeHCS ShareDestinationFormatType = "HCS"
    // ShareDestinationFormatTypeManagedDisk Azure Compute Disk.
    ShareDestinationFormatTypeManagedDisk ShareDestinationFormatType = "ManagedDisk"
    // ShareDestinationFormatTypePageBlob Azure storage page blob format.
    ShareDestinationFormatTypePageBlob ShareDestinationFormatType = "PageBlob"
    // ShareDestinationFormatTypeUnknownType Unknown format.
    ShareDestinationFormatTypeUnknownType ShareDestinationFormatType = "UnknownType"
)

func PossibleShareDestinationFormatTypeValues Uses

func PossibleShareDestinationFormatTypeValues() []ShareDestinationFormatType

PossibleShareDestinationFormatTypeValues returns an array of possible values for the ShareDestinationFormatType const type.

type ShipmentPickUpRequest Uses

type ShipmentPickUpRequest struct {
    // StartTime - Minimum date after which the pick up should commence, this must be in local time of pick up area.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - Maximum date before which the pick up should commence, this must be in local time of pick up area.
    EndTime *date.Time `json:"endTime,omitempty"`
    // ShipmentLocation - Shipment Location in the pickup place. Eg.front desk
    ShipmentLocation *string `json:"shipmentLocation,omitempty"`
}

ShipmentPickUpRequest shipment pick up request details.

type ShipmentPickUpResponse Uses

type ShipmentPickUpResponse struct {
    autorest.Response `json:"-"`
    // ConfirmationNumber - READ-ONLY; Confirmation number for the pick up request.
    ConfirmationNumber *string `json:"confirmationNumber,omitempty"`
    // ReadyByTime - READ-ONLY; Time by which shipment should be ready for pick up, this is in local time of pick up area.
    ReadyByTime *date.Time `json:"readyByTime,omitempty"`
}

ShipmentPickUpResponse shipment pick up response.

type ShippingAddress Uses

type ShippingAddress struct {
    // StreetAddress1 - Street Address line 1.
    StreetAddress1 *string `json:"streetAddress1,omitempty"`
    // StreetAddress2 - Street Address line 2.
    StreetAddress2 *string `json:"streetAddress2,omitempty"`
    // StreetAddress3 - Street Address line 3.
    StreetAddress3 *string `json:"streetAddress3,omitempty"`
    // City - Name of the City.
    City *string `json:"city,omitempty"`
    // StateOrProvince - Name of the State or Province.
    StateOrProvince *string `json:"stateOrProvince,omitempty"`
    // Country - Name of the Country.
    Country *string `json:"country,omitempty"`
    // PostalCode - Postal code.
    PostalCode *string `json:"postalCode,omitempty"`
    // ZipExtendedCode - Extended Zip Code.
    ZipExtendedCode *string `json:"zipExtendedCode,omitempty"`
    // CompanyName - Name of the company.
    CompanyName *string `json:"companyName,omitempty"`
    // AddressType - Type of address. Possible values include: 'None', 'Residential', 'Commercial'
    AddressType AddressType `json:"addressType,omitempty"`
}

ShippingAddress shipping address where customer wishes to receive the device.

type Sku Uses

type Sku struct {
    // Name - The sku name. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    Name SkuName `json:"name,omitempty"`
    // DisplayName - The display name of the sku.
    DisplayName *string `json:"displayName,omitempty"`
    // Family - The sku family.
    Family *string `json:"family,omitempty"`
}

Sku the Sku.

type SkuAvailabilityValidationRequest Uses

type SkuAvailabilityValidationRequest struct {
    // DeviceType - Device type to be used for the job. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    DeviceType SkuName `json:"deviceType,omitempty"`
    // TransferType - Type of the transfer.
    TransferType *string `json:"transferType,omitempty"`
    // Country - ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
    Country *string `json:"country,omitempty"`
    // Location - Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
    Location *string `json:"location,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

SkuAvailabilityValidationRequest request to validate sku availability.

func (SkuAvailabilityValidationRequest) AsBasicValidationInputRequest Uses

func (savr SkuAvailabilityValidationRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (savr SkuAvailabilityValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsDataDestinationDetailsValidationRequest Uses

func (savr SkuAvailabilityValidationRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsPreferencesValidationRequest Uses

func (savr SkuAvailabilityValidationRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsSkuAvailabilityValidationRequest Uses

func (savr SkuAvailabilityValidationRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (savr SkuAvailabilityValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsValidateAddress Uses

func (savr SkuAvailabilityValidationRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) AsValidationInputRequest Uses

func (savr SkuAvailabilityValidationRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for SkuAvailabilityValidationRequest.

func (SkuAvailabilityValidationRequest) MarshalJSON Uses

func (savr SkuAvailabilityValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuAvailabilityValidationRequest.

type SkuAvailabilityValidationResponseProperties Uses

type SkuAvailabilityValidationResponseProperties struct {
    // Status - READ-ONLY; Sku availability validation status. Possible values include: 'ValidationStatusValid', 'ValidationStatusInvalid', 'ValidationStatusSkipped'
    Status ValidationStatus `json:"status,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

SkuAvailabilityValidationResponseProperties properties of sku availability validation response.

func (SkuAvailabilityValidationResponseProperties) AsAddressValidationProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsBasicValidationInputResponse Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsPreferencesValidationResponseProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) AsValidationInputResponse Uses

func (savrp SkuAvailabilityValidationResponseProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for SkuAvailabilityValidationResponseProperties.

func (SkuAvailabilityValidationResponseProperties) MarshalJSON Uses

func (savrp SkuAvailabilityValidationResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuAvailabilityValidationResponseProperties.

type SkuCapacity Uses

type SkuCapacity struct {
    // Usable - READ-ONLY; Usable capacity in TB.
    Usable *string `json:"usable,omitempty"`
    // Maximum - READ-ONLY; Maximum capacity in TB.
    Maximum *string `json:"maximum,omitempty"`
}

SkuCapacity capacity of the sku.

type SkuCost Uses

type SkuCost struct {
    // MeterID - READ-ONLY; Meter id of the Sku.
    MeterID *string `json:"meterId,omitempty"`
    // MeterType - READ-ONLY; The type of the meter.
    MeterType *string `json:"meterType,omitempty"`
}

SkuCost describes metadata for retrieving price info.

type SkuDisabledReason Uses

type SkuDisabledReason string

SkuDisabledReason enumerates the values for sku disabled reason.

const (
    // SkuDisabledReasonCountry SKU is not available in the requested country.
    SkuDisabledReasonCountry SkuDisabledReason = "Country"
    // SkuDisabledReasonFeature Required features are not enabled for the SKU.
    SkuDisabledReasonFeature SkuDisabledReason = "Feature"
    // SkuDisabledReasonNone SKU is not disabled.
    SkuDisabledReasonNone SkuDisabledReason = "None"
    // SkuDisabledReasonNoSubscriptionInfo Subscription has not registered to Microsoft.DataBox and Service
    // does not have the subscription notification.
    SkuDisabledReasonNoSubscriptionInfo SkuDisabledReason = "NoSubscriptionInfo"
    // SkuDisabledReasonOfferType Subscription does not have required offer types for the SKU.
    SkuDisabledReasonOfferType SkuDisabledReason = "OfferType"
    // SkuDisabledReasonRegion SKU is not available to push data to the requested Azure region.
    SkuDisabledReasonRegion SkuDisabledReason = "Region"
)

func PossibleSkuDisabledReasonValues Uses

func PossibleSkuDisabledReasonValues() []SkuDisabledReason

PossibleSkuDisabledReasonValues returns an array of possible values for the SkuDisabledReason const type.

type SkuInformation Uses

type SkuInformation struct {
    // Sku - READ-ONLY; The Sku.
    Sku *Sku `json:"sku,omitempty"`
    // Enabled - READ-ONLY; The sku is enabled or not.
    Enabled *bool `json:"enabled,omitempty"`
    // SkuProperties - READ-ONLY; Properties of the sku.
    *SkuProperties `json:"properties,omitempty"`
}

SkuInformation information of the sku.

func (SkuInformation) MarshalJSON Uses

func (si SkuInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuInformation.

func (*SkuInformation) UnmarshalJSON Uses

func (si *SkuInformation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SkuInformation struct.

type SkuName Uses

type SkuName string

SkuName enumerates the values for sku name.

const (
    // DataBox Databox.
    DataBox SkuName = "DataBox"
    // DataBoxDisk DataboxDisk.
    DataBoxDisk SkuName = "DataBoxDisk"
    // DataBoxHeavy DataboxHeavy.
    DataBoxHeavy SkuName = "DataBoxHeavy"
)

func PossibleSkuNameValues Uses

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type SkuNameBasicScheduleAvailabilityRequest Uses

type SkuNameBasicScheduleAvailabilityRequest string

SkuNameBasicScheduleAvailabilityRequest enumerates the values for sku name basic schedule availability request.

const (
    // SkuNameDataBox ...
    SkuNameDataBox SkuNameBasicScheduleAvailabilityRequest = "DataBox"
    // SkuNameDataBoxDisk ...
    SkuNameDataBoxDisk SkuNameBasicScheduleAvailabilityRequest = "DataBoxDisk"
    // SkuNameDataBoxHeavy ...
    SkuNameDataBoxHeavy SkuNameBasicScheduleAvailabilityRequest = "DataBoxHeavy"
    // SkuNameScheduleAvailabilityRequest ...
    SkuNameScheduleAvailabilityRequest SkuNameBasicScheduleAvailabilityRequest = "ScheduleAvailabilityRequest"
)

func PossibleSkuNameBasicScheduleAvailabilityRequestValues Uses

func PossibleSkuNameBasicScheduleAvailabilityRequestValues() []SkuNameBasicScheduleAvailabilityRequest

PossibleSkuNameBasicScheduleAvailabilityRequestValues returns an array of possible values for the SkuNameBasicScheduleAvailabilityRequest const type.

type SkuProperties Uses

type SkuProperties struct {
    // DestinationToServiceLocationMap - READ-ONLY; The map of destination location to service location.
    DestinationToServiceLocationMap *[]DestinationToServiceLocationMap `json:"destinationToServiceLocationMap,omitempty"`
    // Capacity - READ-ONLY; Capacity of the Sku.
    Capacity *SkuCapacity `json:"capacity,omitempty"`
    // Costs - READ-ONLY; Cost of the Sku.
    Costs *[]SkuCost `json:"costs,omitempty"`
    // APIVersions - READ-ONLY; Api versions that support this Sku.
    APIVersions *[]string `json:"apiVersions,omitempty"`
    // DisabledReason - READ-ONLY; Reason why the Sku is disabled. Possible values include: 'SkuDisabledReasonNone', 'SkuDisabledReasonCountry', 'SkuDisabledReasonRegion', 'SkuDisabledReasonFeature', 'SkuDisabledReasonOfferType', 'SkuDisabledReasonNoSubscriptionInfo'
    DisabledReason SkuDisabledReason `json:"disabledReason,omitempty"`
    // DisabledReasonMessage - READ-ONLY; Message for why the Sku is disabled.
    DisabledReasonMessage *string `json:"disabledReasonMessage,omitempty"`
    // RequiredFeature - READ-ONLY; Required feature to access the sku.
    RequiredFeature *string `json:"requiredFeature,omitempty"`
}

SkuProperties properties of the sku.

type StageName Uses

type StageName string

StageName enumerates the values for stage name.

const (
    // StageNameAborted Order has been aborted.
    StageNameAborted StageName = "Aborted"
    // StageNameAtAzureDC Device has been received at azure datacenter from the user.
    StageNameAtAzureDC StageName = "AtAzureDC"
    // StageNameCancelled Order has been cancelled.
    StageNameCancelled StageName = "Cancelled"
    // StageNameCompleted Order has completed.
    StageNameCompleted StageName = "Completed"
    // StageNameCompletedWithErrors Order has completed with errors.
    StageNameCompletedWithErrors StageName = "CompletedWithErrors"
    // StageNameCompletedWithWarnings Order has completed with warnings.
    StageNameCompletedWithWarnings StageName = "CompletedWithWarnings"
    // StageNameDataCopy Data copy from the device at azure datacenter.
    StageNameDataCopy StageName = "DataCopy"
    // StageNameDelivered Device has been delivered to the user of the order.
    StageNameDelivered StageName = "Delivered"
    // StageNameDeviceOrdered An order has been created.
    StageNameDeviceOrdered StageName = "DeviceOrdered"
    // StageNameDevicePrepared A device has been prepared for the order.
    StageNameDevicePrepared StageName = "DevicePrepared"
    // StageNameDispatched Device has been dispatched to the user of the order.
    StageNameDispatched StageName = "Dispatched"
    // StageNameFailedIssueDetectedAtAzureDC Order has failed due to issue detected at azure datacenter.
    StageNameFailedIssueDetectedAtAzureDC StageName = "Failed_IssueDetectedAtAzureDC"
    // StageNameFailedIssueReportedAtCustomer Order has failed due to issue reported by user.
    StageNameFailedIssueReportedAtCustomer StageName = "Failed_IssueReportedAtCustomer"
    // StageNamePickedUp Device has been picked up from user and in transit to azure datacenter.
    StageNamePickedUp StageName = "PickedUp"
    // StageNameReadyToDispatchFromAzureDC Device is ready to be handed to customer from Azure DC.
    StageNameReadyToDispatchFromAzureDC StageName = "ReadyToDispatchFromAzureDC"
    // StageNameReadyToReceiveAtAzureDC Device can be dropped off at Azure DC.
    StageNameReadyToReceiveAtAzureDC StageName = "ReadyToReceiveAtAzureDC"
)

func PossibleStageNameValues Uses

func PossibleStageNameValues() []StageName

PossibleStageNameValues returns an array of possible values for the StageName const type.

type StageStatus Uses

type StageStatus string

StageStatus enumerates the values for stage status.

const (
    // StageStatusCancelled Stage has been cancelled.
    StageStatusCancelled StageStatus = "Cancelled"
    // StageStatusCancelling Stage is cancelling.
    StageStatusCancelling StageStatus = "Cancelling"
    // StageStatusFailed Stage has failed.
    StageStatusFailed StageStatus = "Failed"
    // StageStatusInProgress Stage is in progress.
    StageStatusInProgress StageStatus = "InProgress"
    // StageStatusNone No status available yet.
    StageStatusNone StageStatus = "None"
    // StageStatusSucceeded Stage has succeeded.
    StageStatusSucceeded StageStatus = "Succeeded"
    // StageStatusSucceededWithErrors Stage has succeeded with errors.
    StageStatusSucceededWithErrors StageStatus = "SucceededWithErrors"
)

func PossibleStageStatusValues Uses

func PossibleStageStatusValues() []StageStatus

PossibleStageStatusValues returns an array of possible values for the StageStatus const type.

type SubscriptionIsAllowedToCreateJobValidationRequest Uses

type SubscriptionIsAllowedToCreateJobValidationRequest struct {
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

SubscriptionIsAllowedToCreateJobValidationRequest request to validate subscription permission to create jobs.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsBasicValidationInputRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsDataDestinationDetailsValidationRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsPreferencesValidationRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsSkuAvailabilityValidationRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsValidateAddress Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) AsValidationInputRequest Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for SubscriptionIsAllowedToCreateJobValidationRequest.

func (SubscriptionIsAllowedToCreateJobValidationRequest) MarshalJSON Uses

func (siatcjvr SubscriptionIsAllowedToCreateJobValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionIsAllowedToCreateJobValidationRequest.

type SubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

type SubscriptionIsAllowedToCreateJobValidationResponseProperties struct {
    // Status - READ-ONLY; Validation status of subscription permission to create job. Possible values include: 'ValidationStatusValid', 'ValidationStatusInvalid', 'ValidationStatusSkipped'
    Status ValidationStatus `json:"status,omitempty"`
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

SubscriptionIsAllowedToCreateJobValidationResponseProperties properties of subscription permission to create job validation response.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsAddressValidationProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsBasicValidationInputResponse Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsPreferencesValidationResponseProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsValidationInputResponse Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

func (SubscriptionIsAllowedToCreateJobValidationResponseProperties) MarshalJSON Uses

func (siatcjvrp SubscriptionIsAllowedToCreateJobValidationResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionIsAllowedToCreateJobValidationResponseProperties.

type TransportAvailabilityDetails Uses

type TransportAvailabilityDetails struct {
    // ShipmentType - READ-ONLY; Transport Shipment Type supported for given region. Possible values include: 'CustomerManaged', 'MicrosoftManaged'
    ShipmentType TransportShipmentTypes `json:"shipmentType,omitempty"`
}

TransportAvailabilityDetails transport options availability details for given region.

type TransportAvailabilityRequest Uses

type TransportAvailabilityRequest struct {
    // SkuName - Type of the device. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    SkuName SkuName `json:"skuName,omitempty"`
}

TransportAvailabilityRequest request body to get the transport availability for given sku.

type TransportAvailabilityResponse Uses

type TransportAvailabilityResponse struct {
    // TransportAvailabilityDetails - READ-ONLY; List of transport availability details for given region
    TransportAvailabilityDetails *[]TransportAvailabilityDetails `json:"transportAvailabilityDetails,omitempty"`
}

TransportAvailabilityResponse transport options available for given sku in a region.

type TransportPreferences Uses

type TransportPreferences struct {
    // PreferredShipmentType - Indicates Shipment Logistics type that the customer preferred. Possible values include: 'CustomerManaged', 'MicrosoftManaged'
    PreferredShipmentType TransportShipmentTypes `json:"preferredShipmentType,omitempty"`
}

TransportPreferences preferences related to the shipment logistics of the sku

type TransportShipmentTypes Uses

type TransportShipmentTypes string

TransportShipmentTypes enumerates the values for transport shipment types.

const (
    // CustomerManaged Shipment Logistics is handled by the customer.
    CustomerManaged TransportShipmentTypes = "CustomerManaged"
    // MicrosoftManaged Shipment Logistics is handled by Microsoft.
    MicrosoftManaged TransportShipmentTypes = "MicrosoftManaged"
)

func PossibleTransportShipmentTypesValues Uses

func PossibleTransportShipmentTypesValues() []TransportShipmentTypes

PossibleTransportShipmentTypesValues returns an array of possible values for the TransportShipmentTypes const type.

type UnencryptedCredentials Uses

type UnencryptedCredentials struct {
    // JobName - READ-ONLY; Name of the job.
    JobName *string `json:"jobName,omitempty"`
    // JobSecrets - READ-ONLY; Secrets related to this job.
    JobSecrets BasicJobSecrets `json:"jobSecrets,omitempty"`
}

UnencryptedCredentials unencrypted credentials for accessing device.

func (*UnencryptedCredentials) UnmarshalJSON Uses

func (uc *UnencryptedCredentials) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UnencryptedCredentials struct.

type UnencryptedCredentialsList Uses

type UnencryptedCredentialsList struct {
    autorest.Response `json:"-"`
    // Value - List of unencrypted credentials.
    Value *[]UnencryptedCredentials `json:"value,omitempty"`
    // NextLink - Link for the next set of unencrypted credentials.
    NextLink *string `json:"nextLink,omitempty"`
}

UnencryptedCredentialsList list of unencrypted credentials for accessing device.

type UpdateJobDetails Uses

type UpdateJobDetails struct {
    // ContactDetails - Contact details for notification and shipping.
    ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
}

UpdateJobDetails job details for update.

type UpdateJobProperties Uses

type UpdateJobProperties struct {
    // Details - Details of a job to be updated.
    Details *UpdateJobDetails `json:"details,omitempty"`
    // DestinationAccountDetails - Destination account details.
    DestinationAccountDetails *[]BasicDestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
}

UpdateJobProperties job Properties for update

func (*UpdateJobProperties) UnmarshalJSON Uses

func (ujp *UpdateJobProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UpdateJobProperties struct.

type ValidateAddress Uses

type ValidateAddress struct {
    // ShippingAddress - Shipping address of the customer.
    ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
    // DeviceType - Device type to be used for the job. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
    DeviceType SkuName `json:"deviceType,omitempty"`
    // TransportPreferences - Preferences related to the shipment logistics of the sku.
    TransportPreferences *TransportPreferences `json:"transportPreferences,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

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

func (ValidateAddress) AsBasicValidationInputRequest Uses

func (va ValidateAddress) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (va ValidateAddress) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsDataDestinationDetailsValidationRequest Uses

func (va ValidateAddress) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsPreferencesValidationRequest Uses

func (va ValidateAddress) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsSkuAvailabilityValidationRequest Uses

func (va ValidateAddress) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (va ValidateAddress) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsValidateAddress Uses

func (va ValidateAddress) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) AsValidationInputRequest Uses

func (va ValidateAddress) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for ValidateAddress.

func (ValidateAddress) MarshalJSON Uses

func (va ValidateAddress) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ValidateAddress.

type ValidationCategory Uses

type ValidationCategory string

ValidationCategory enumerates the values for validation category.

const (
    // ValidationCategoryJobCreationValidation ...
    ValidationCategoryJobCreationValidation ValidationCategory = "JobCreationValidation"
    // ValidationCategoryValidationRequest ...
    ValidationCategoryValidationRequest ValidationCategory = "ValidationRequest"
)

func PossibleValidationCategoryValues Uses

func PossibleValidationCategoryValues() []ValidationCategory

PossibleValidationCategoryValues returns an array of possible values for the ValidationCategory const type.

type ValidationInputRequest Uses

type ValidationInputRequest struct {
    // ValidationType - Possible values include: 'ValidationTypeValidationInputRequest', 'ValidationTypeValidateCreateOrderLimit', 'ValidationTypeValidateDataDestinationDetails', 'ValidationTypeValidatePreferences', 'ValidationTypeValidateSkuAvailability', 'ValidationTypeValidateSubscriptionIsAllowedToCreateJob', 'ValidationTypeValidateAddress'
    ValidationType ValidationType `json:"validationType,omitempty"`
}

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

func (ValidationInputRequest) AsBasicValidationInputRequest Uses

func (vir ValidationInputRequest) AsBasicValidationInputRequest() (BasicValidationInputRequest, bool)

AsBasicValidationInputRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsCreateOrderLimitForSubscriptionValidationRequest Uses

func (vir ValidationInputRequest) AsCreateOrderLimitForSubscriptionValidationRequest() (*CreateOrderLimitForSubscriptionValidationRequest, bool)

AsCreateOrderLimitForSubscriptionValidationRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsDataDestinationDetailsValidationRequest Uses

func (vir ValidationInputRequest) AsDataDestinationDetailsValidationRequest() (*DataDestinationDetailsValidationRequest, bool)

AsDataDestinationDetailsValidationRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsPreferencesValidationRequest Uses

func (vir ValidationInputRequest) AsPreferencesValidationRequest() (*PreferencesValidationRequest, bool)

AsPreferencesValidationRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsSkuAvailabilityValidationRequest Uses

func (vir ValidationInputRequest) AsSkuAvailabilityValidationRequest() (*SkuAvailabilityValidationRequest, bool)

AsSkuAvailabilityValidationRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest Uses

func (vir ValidationInputRequest) AsSubscriptionIsAllowedToCreateJobValidationRequest() (*SubscriptionIsAllowedToCreateJobValidationRequest, bool)

AsSubscriptionIsAllowedToCreateJobValidationRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsValidateAddress Uses

func (vir ValidationInputRequest) AsValidateAddress() (*ValidateAddress, bool)

AsValidateAddress is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) AsValidationInputRequest Uses

func (vir ValidationInputRequest) AsValidationInputRequest() (*ValidationInputRequest, bool)

AsValidationInputRequest is the BasicValidationInputRequest implementation for ValidationInputRequest.

func (ValidationInputRequest) MarshalJSON Uses

func (vir ValidationInputRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ValidationInputRequest.

type ValidationInputResponse Uses

type ValidationInputResponse struct {
    // Error - READ-ONLY; Error code and message of validation response.
    Error *Error `json:"error,omitempty"`
    // ValidationType - Possible values include: 'ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails', 'ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability', 'ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob'
    ValidationType ValidationTypeBasicValidationInputResponse `json:"validationType,omitempty"`
}

ValidationInputResponse minimum properties that should be present in each individual validation response.

func (ValidationInputResponse) AsAddressValidationProperties Uses

func (vir ValidationInputResponse) AsAddressValidationProperties() (*AddressValidationProperties, bool)

AsAddressValidationProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsBasicValidationInputResponse Uses

func (vir ValidationInputResponse) AsBasicValidationInputResponse() (BasicValidationInputResponse, bool)

AsBasicValidationInputResponse is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsCreateOrderLimitForSubscriptionValidationResponseProperties Uses

func (vir ValidationInputResponse) AsCreateOrderLimitForSubscriptionValidationResponseProperties() (*CreateOrderLimitForSubscriptionValidationResponseProperties, bool)

AsCreateOrderLimitForSubscriptionValidationResponseProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsDataDestinationDetailsValidationResponseProperties Uses

func (vir ValidationInputResponse) AsDataDestinationDetailsValidationResponseProperties() (*DataDestinationDetailsValidationResponseProperties, bool)

AsDataDestinationDetailsValidationResponseProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsPreferencesValidationResponseProperties Uses

func (vir ValidationInputResponse) AsPreferencesValidationResponseProperties() (*PreferencesValidationResponseProperties, bool)

AsPreferencesValidationResponseProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsSkuAvailabilityValidationResponseProperties Uses

func (vir ValidationInputResponse) AsSkuAvailabilityValidationResponseProperties() (*SkuAvailabilityValidationResponseProperties, bool)

AsSkuAvailabilityValidationResponseProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties Uses

func (vir ValidationInputResponse) AsSubscriptionIsAllowedToCreateJobValidationResponseProperties() (*SubscriptionIsAllowedToCreateJobValidationResponseProperties, bool)

AsSubscriptionIsAllowedToCreateJobValidationResponseProperties is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) AsValidationInputResponse Uses

func (vir ValidationInputResponse) AsValidationInputResponse() (*ValidationInputResponse, bool)

AsValidationInputResponse is the BasicValidationInputResponse implementation for ValidationInputResponse.

func (ValidationInputResponse) MarshalJSON Uses

func (vir ValidationInputResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ValidationInputResponse.

type ValidationRequest Uses

type ValidationRequest struct {
    // IndividualRequestDetails - List of request details contain validationType and its request as key and value respectively.
    IndividualRequestDetails *[]BasicValidationInputRequest `json:"individualRequestDetails,omitempty"`
    // ValidationCategory - Possible values include: 'ValidationCategoryValidationRequest', 'ValidationCategoryJobCreationValidation'
    ValidationCategory ValidationCategory `json:"validationCategory,omitempty"`
}

ValidationRequest input request for all pre job creation validation.

func (ValidationRequest) AsBasicValidationRequest Uses

func (vr ValidationRequest) AsBasicValidationRequest() (BasicValidationRequest, bool)

AsBasicValidationRequest is the BasicValidationRequest implementation for ValidationRequest.

func (ValidationRequest) AsCreateJobValidations Uses

func (vr ValidationRequest) AsCreateJobValidations() (*CreateJobValidations, bool)

AsCreateJobValidations is the BasicValidationRequest implementation for ValidationRequest.

func (ValidationRequest) AsValidationRequest Uses

func (vr ValidationRequest) AsValidationRequest() (*ValidationRequest, bool)

AsValidationRequest is the BasicValidationRequest implementation for ValidationRequest.

func (ValidationRequest) MarshalJSON Uses

func (vr ValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ValidationRequest.

func (*ValidationRequest) UnmarshalJSON Uses

func (vr *ValidationRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ValidationRequest struct.

type ValidationResponse Uses

type ValidationResponse struct {
    autorest.Response `json:"-"`
    // ValidationResponseProperties - READ-ONLY; Properties of pre job creation validation response.
    *ValidationResponseProperties `json:"properties,omitempty"`
}

ValidationResponse response of pre job creation validations.

func (ValidationResponse) MarshalJSON Uses

func (vr ValidationResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ValidationResponse.

func (*ValidationResponse) UnmarshalJSON Uses

func (vr *ValidationResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ValidationResponse struct.

type ValidationResponseProperties Uses

type ValidationResponseProperties struct {
    // Status - READ-ONLY; Overall validation status. Possible values include: 'AllValidToProceed', 'InputsRevisitRequired', 'CertainInputValidationsSkipped'
    Status OverallValidationStatus `json:"status,omitempty"`
    // IndividualResponseDetails - READ-ONLY; List of response details contain validationType and its response as key and value respectively.
    IndividualResponseDetails *[]BasicValidationInputResponse `json:"individualResponseDetails,omitempty"`
}

ValidationResponseProperties properties of pre job creation validation response.

func (*ValidationResponseProperties) UnmarshalJSON Uses

func (vrp *ValidationResponseProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ValidationResponseProperties struct.

type ValidationStatus Uses

type ValidationStatus string

ValidationStatus enumerates the values for validation status.

const (
    // ValidationStatusInvalid Validation is not successful
    ValidationStatusInvalid ValidationStatus = "Invalid"
    // ValidationStatusSkipped Validation is skipped
    ValidationStatusSkipped ValidationStatus = "Skipped"
    // ValidationStatusValid Validation is successful
    ValidationStatusValid ValidationStatus = "Valid"
)

func PossibleValidationStatusValues Uses

func PossibleValidationStatusValues() []ValidationStatus

PossibleValidationStatusValues returns an array of possible values for the ValidationStatus const type.

type ValidationType Uses

type ValidationType string

ValidationType enumerates the values for validation type.

const (
    // ValidationTypeValidateAddress ...
    ValidationTypeValidateAddress ValidationType = "ValidateAddress"
    // ValidationTypeValidateCreateOrderLimit ...
    ValidationTypeValidateCreateOrderLimit ValidationType = "ValidateCreateOrderLimit"
    // ValidationTypeValidateDataDestinationDetails ...
    ValidationTypeValidateDataDestinationDetails ValidationType = "ValidateDataDestinationDetails"
    // ValidationTypeValidatePreferences ...
    ValidationTypeValidatePreferences ValidationType = "ValidatePreferences"
    // ValidationTypeValidateSkuAvailability ...
    ValidationTypeValidateSkuAvailability ValidationType = "ValidateSkuAvailability"
    // ValidationTypeValidateSubscriptionIsAllowedToCreateJob ...
    ValidationTypeValidateSubscriptionIsAllowedToCreateJob ValidationType = "ValidateSubscriptionIsAllowedToCreateJob"
    // ValidationTypeValidationInputRequest ...
    ValidationTypeValidationInputRequest ValidationType = "ValidationInputRequest"
)

func PossibleValidationTypeValues Uses

func PossibleValidationTypeValues() []ValidationType

PossibleValidationTypeValues returns an array of possible values for the ValidationType const type.

type ValidationTypeBasicValidationInputResponse Uses

type ValidationTypeBasicValidationInputResponse string

ValidationTypeBasicValidationInputResponse enumerates the values for validation type basic validation input response.

const (
    // ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidateAddress ValidationTypeBasicValidationInputResponse = "ValidateAddress"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidateCreateOrderLimit ValidationTypeBasicValidationInputResponse = "ValidateCreateOrderLimit"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidateDataDestinationDetails ValidationTypeBasicValidationInputResponse = "ValidateDataDestinationDetails"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidatePreferences ValidationTypeBasicValidationInputResponse = "ValidatePreferences"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidateSkuAvailability ValidationTypeBasicValidationInputResponse = "ValidateSkuAvailability"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidateSubscriptionIsAllowedToCreateJob ValidationTypeBasicValidationInputResponse = "ValidateSubscriptionIsAllowedToCreateJob"
    // ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse ...
    ValidationTypeBasicValidationInputResponseValidationTypeValidationInputResponse ValidationTypeBasicValidationInputResponse = "ValidationInputResponse"
)

func PossibleValidationTypeBasicValidationInputResponseValues Uses

func PossibleValidationTypeBasicValidationInputResponseValues() []ValidationTypeBasicValidationInputResponse

PossibleValidationTypeBasicValidationInputResponseValues returns an array of possible values for the ValidationTypeBasicValidationInputResponse const type.

Directories

PathSynopsis
databoxapi

Package databox imports 10 packages (graph) and is imported by 2 packages. Updated 2021-01-18. Refresh now. Tools for package owners.