databox

package
v61.2.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 14, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type AccessProtocol 

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 

func PossibleAccessProtocolValues() []AccessProtocol

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

type AccountCopyLogDetails 

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 

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

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsBasicCopyLogDetails 

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

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsCopyLogDetails 

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

AsCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsDiskCopyLogDetails 

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

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsHeavyAccountCopyLogDetails 

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

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for AccountCopyLogDetails.

type AccountCredentialDetails 

type AccountCredentialDetails struct {
	// AccountName - READ-ONLY; Name of the account.
	AccountName *string `json:"accountName,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.

func (AccountCredentialDetails) MarshalJSON 

func (acd AccountCredentialDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCredentialDetails.

type AddressType 

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 

func PossibleAddressTypeValues() []AddressType

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

type AddressValidationOutput 

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 

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

MarshalJSON is the custom marshaler for AddressValidationOutput.

func (*AddressValidationOutput) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for AddressValidationOutput struct.

type AddressValidationProperties 

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"`
}

AddressValidationProperties the address validation output.

func (AddressValidationProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for AddressValidationProperties.

type AddressValidationStatus 

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 

func PossibleAddressValidationStatusValues() []AddressValidationStatus

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

type ApplianceNetworkConfiguration 

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.

func (ApplianceNetworkConfiguration) MarshalJSON 

func (anc ApplianceNetworkConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ApplianceNetworkConfiguration.

type ArmBaseObject 

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.

func (ArmBaseObject) MarshalJSON 

func (abo ArmBaseObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ArmBaseObject.

type AvailableSkuRequest 

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 

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 

func (asr AvailableSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AvailableSkusResult) MarshalJSON 

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

MarshalJSON is the custom marshaler for AvailableSkusResult.

type AvailableSkusResultIterator 

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

AvailableSkusResultIterator provides access to a complete listing of SkuInformation values.

func NewAvailableSkusResultIterator 

func NewAvailableSkusResultIterator(page AvailableSkusResultPage) AvailableSkusResultIterator

Creates a new instance of the AvailableSkusResultIterator type.

func (*AvailableSkusResultIterator) Next 

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 

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 

func (iter AvailableSkusResultIterator) NotDone() bool

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

func (AvailableSkusResultIterator) Response 

func (iter AvailableSkusResultIterator) Response() AvailableSkusResult

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

func (AvailableSkusResultIterator) Value 

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 

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

AvailableSkusResultPage contains a page of SkuInformation values.

func NewAvailableSkusResultPage 

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

Creates a new instance of the AvailableSkusResultPage type.

func (*AvailableSkusResultPage) Next 

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 

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 

func (page AvailableSkusResultPage) NotDone() bool

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

func (AvailableSkusResultPage) Response 

func (page AvailableSkusResultPage) Response() AvailableSkusResult

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

func (AvailableSkusResultPage) Values 

func (page AvailableSkusResultPage) Values() []SkuInformation

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

type BaseClient 

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

BaseClient is the base client for Databox.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

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 

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

BasicCopyLogDetails details for log generated during copy.

type BasicDestinationAccountDetails 

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

BasicDestinationAccountDetails details of the destination of the data

type BasicJobDetails 

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

BasicJobDetails job details.

type BasicJobSecrets 

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

BasicJobSecrets the base class for the secrets

type CancellationReason 

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

CancellationReason reason for cancellation.

type ContactDetails 

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 

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 

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

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsBasicCopyLogDetails 

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

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsCopyLogDetails 

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

AsCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsDiskCopyLogDetails 

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

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsHeavyAccountCopyLogDetails 

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

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for CopyLogDetails.

type CopyLogDetailsType 

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 

func PossibleCopyLogDetailsTypeValues() []CopyLogDetailsType

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

type CopyProgress 

type CopyProgress struct {
	// StorageAccountName - READ-ONLY; Name of the storage account where the data needs to be uploaded.
	StorageAccountName *string `json:"storageAccountName,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"`
}

CopyProgress copy progress.

func (CopyProgress) MarshalJSON 

func (cp CopyProgress) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CopyProgress.

type CopyStatus 

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"
	// Failed Data copy failed. No data was copied.
	Failed CopyStatus = "Failed"
	// 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"
)

func PossibleCopyStatusValues 

func PossibleCopyStatusValues() []CopyStatus

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

type DataDestinationType 

type DataDestinationType string

DataDestinationType enumerates the values for data destination type. 

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

func PossibleDataDestinationTypeValues 

func PossibleDataDestinationTypeValues() []DataDestinationType

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

type DestinationAccountDetails 

type DestinationAccountDetails struct {
	// AccountID - Arm Id of the destination where the data has to be moved.
	AccountID *string `json:"accountId,omitempty"`
	// DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
	DataDestinationType DataDestinationType `json:"dataDestinationType,omitempty"`
}

DestinationAccountDetails details of the destination of the data

func (DestinationAccountDetails) AsBasicDestinationAccountDetails 

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

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationAccountDetails 

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

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationManagedDiskDetails 

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

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) AsDestinationStorageAccountDetails 

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

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationAccountDetails.

func (DestinationAccountDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for DestinationAccountDetails.

type DestinationManagedDiskDetails 

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"`
	// DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
	DataDestinationType DataDestinationType `json:"dataDestinationType,omitempty"`
}

DestinationManagedDiskDetails details for the destination compute disks.

func (DestinationManagedDiskDetails) AsBasicDestinationAccountDetails 

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

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationAccountDetails 

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

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationManagedDiskDetails 

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

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) AsDestinationStorageAccountDetails 

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

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationManagedDiskDetails.

func (DestinationManagedDiskDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for DestinationManagedDiskDetails.

type DestinationStorageAccountDetails 

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"`
	// DataDestinationType - Possible values include: 'DataDestinationTypeDestinationAccountDetails', 'DataDestinationTypeManagedDisk', 'DataDestinationTypeStorageAccount'
	DataDestinationType DataDestinationType `json:"dataDestinationType,omitempty"`
}

DestinationStorageAccountDetails details for the destination storage account.

func (DestinationStorageAccountDetails) AsBasicDestinationAccountDetails 

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

AsBasicDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationAccountDetails 

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

AsDestinationAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationManagedDiskDetails 

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

AsDestinationManagedDiskDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) AsDestinationStorageAccountDetails 

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

AsDestinationStorageAccountDetails is the BasicDestinationAccountDetails implementation for DestinationStorageAccountDetails.

func (DestinationStorageAccountDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for DestinationStorageAccountDetails.

type DestinationToServiceLocationMap 

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

func (DestinationToServiceLocationMap) MarshalJSON 

func (dtslm DestinationToServiceLocationMap) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DestinationToServiceLocationMap.

type DiskCopyLogDetails 

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 

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

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsBasicCopyLogDetails 

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

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsCopyLogDetails 

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

AsCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsDiskCopyLogDetails 

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

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsHeavyAccountCopyLogDetails 

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

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for DiskCopyLogDetails.

type DiskCopyProgress 

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'
	Status CopyStatus `json:"status,omitempty"`
}

DiskCopyProgress dataBox Disk Copy Progress

func (DiskCopyProgress) MarshalJSON 

func (dcp DiskCopyProgress) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskCopyProgress.

type DiskJobDetails 

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 

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

AsBasicJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsDiskJobDetails 

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

AsDiskJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsHeavyJobDetails 

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

AsHeavyJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsJobDetails 

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

AsJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsJobDetailsType 

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

AsJobDetailsType is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for DiskJobDetails.

func (*DiskJobDetails) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for DiskJobDetails struct.

type DiskJobSecrets 

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"`
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
	JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

DiskJobSecrets the secrets related to disk job.

func (DiskJobSecrets) AsBasicJobSecrets 

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

AsBasicJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsDiskJobSecrets 

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

AsDiskJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsHeavyJobSecrets 

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

AsHeavyJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsJobSecrets 

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

AsJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsJobSecretsType 

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

AsJobSecretsType is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) MarshalJSON 

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

MarshalJSON is the custom marshaler for DiskJobSecrets.

type DiskSecret 

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.

func (DiskSecret) MarshalJSON 

func (ds DiskSecret) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskSecret.

type Error 

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.

func (Error) MarshalJSON 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Error.

type HeavyAccountCopyLogDetails 

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 DataBoxHeavy

func (HeavyAccountCopyLogDetails) AsAccountCopyLogDetails 

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

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsBasicCopyLogDetails 

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

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsCopyLogDetails 

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

AsCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsDiskCopyLogDetails 

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

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) AsHeavyAccountCopyLogDetails 

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

AsHeavyAccountCopyLogDetails is the BasicCopyLogDetails implementation for HeavyAccountCopyLogDetails.

func (HeavyAccountCopyLogDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for HeavyAccountCopyLogDetails.

type HeavyJobDetails 

type HeavyJobDetails struct {
	// CopyProgress - READ-ONLY; Copy progress per account.
	CopyProgress *[]CopyProgress `json:"copyProgress,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 dataBoxHeavy Device Job Details

func (HeavyJobDetails) AsBasicJobDetails 

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

AsBasicJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsDiskJobDetails 

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

AsDiskJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsHeavyJobDetails 

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

AsHeavyJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsJobDetails 

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

AsJobDetails is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) AsJobDetailsType 

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

AsJobDetailsType is the BasicJobDetails implementation for HeavyJobDetails.

func (HeavyJobDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for HeavyJobDetails.

func (*HeavyJobDetails) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for HeavyJobDetails struct.

type HeavyJobSecrets 

type HeavyJobSecrets struct {
	// CabinetPodSecrets - READ-ONLY; Contains the list of secret objects for a DataBoxHeavy job.
	CabinetPodSecrets *[]HeavySecret `json:"cabinetPodSecrets,omitempty"`
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
	JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

HeavyJobSecrets the secrets related to a DataBoxHeavy job.

func (HeavyJobSecrets) AsBasicJobSecrets 

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

AsBasicJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsDiskJobSecrets 

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

AsDiskJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsHeavyJobSecrets 

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

AsHeavyJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsJobSecrets 

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

AsJobSecrets is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) AsJobSecretsType 

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

AsJobSecretsType is the BasicJobSecrets implementation for HeavyJobSecrets.

func (HeavyJobSecrets) MarshalJSON 

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

MarshalJSON is the custom marshaler for HeavyJobSecrets.

type HeavySecret 

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 DataBoxHeavy.

func (HeavySecret) MarshalJSON 

func (hs HeavySecret) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeavySecret.

type JobDetails 

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 

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

AsBasicJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsDiskJobDetails 

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

AsDiskJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsHeavyJobDetails 

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

AsHeavyJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsJobDetails 

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

AsJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsJobDetailsType 

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

AsJobDetailsType is the BasicJobDetails implementation for JobDetails.

func (JobDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobDetails.

func (*JobDetails) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for JobDetails struct.

type JobDetailsType 

type JobDetailsType struct {
	// CopyProgress - READ-ONLY; Copy progress per storage account.
	CopyProgress *[]CopyProgress `json:"copyProgress,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 

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

AsBasicJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsDiskJobDetails 

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

AsDiskJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsHeavyJobDetails 

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

AsHeavyJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsJobDetails 

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

AsJobDetails is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) AsJobDetailsType 

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

AsJobDetailsType is the BasicJobDetails implementation for JobDetailsType.

func (JobDetailsType) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobDetailsType.

func (*JobDetailsType) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for JobDetailsType struct.

type JobDetailsTypeEnum 

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 

func PossibleJobDetailsTypeEnumValues() []JobDetailsTypeEnum

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

type JobErrorDetails 

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.

func (JobErrorDetails) MarshalJSON 

func (jed JobErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobErrorDetails.

type JobProperties 

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'
	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"`
}

JobProperties job Properties

func (JobProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobProperties.

func (*JobProperties) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for JobProperties struct.

type JobResource 

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 

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

MarshalJSON is the custom marshaler for JobResource.

func (*JobResource) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for JobResource struct.

type JobResourceList 

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 

func (jrl JobResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobResourceListIterator 

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

JobResourceListIterator provides access to a complete listing of JobResource values.

func NewJobResourceListIterator 

func NewJobResourceListIterator(page JobResourceListPage) JobResourceListIterator

Creates a new instance of the JobResourceListIterator type.

func (*JobResourceListIterator) Next 

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 

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 

func (iter JobResourceListIterator) NotDone() bool

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

func (JobResourceListIterator) Response 

func (iter JobResourceListIterator) Response() JobResourceList

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

func (JobResourceListIterator) Value 

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 

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

JobResourceListPage contains a page of JobResource values.

func NewJobResourceListPage 

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

Creates a new instance of the JobResourceListPage type.

func (*JobResourceListPage) Next 

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 

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 

func (page JobResourceListPage) NotDone() bool

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

func (JobResourceListPage) Response 

func (page JobResourceListPage) Response() JobResourceList

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

func (JobResourceListPage) Values 

func (page JobResourceListPage) Values() []JobResource

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

type JobResourceUpdateParameter 

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 

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

MarshalJSON is the custom marshaler for JobResourceUpdateParameter.

func (*JobResourceUpdateParameter) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for JobResourceUpdateParameter struct.

type JobSecrets 

type JobSecrets struct {
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeDataBoxDisk', 'JobSecretsTypeDataBoxHeavy', 'JobSecretsTypeDataBox'
	JobSecretsType JobSecretsTypeEnum `json:"jobSecretsType,omitempty"`
}

JobSecrets the base class for the secrets

func (JobSecrets) AsBasicJobSecrets 

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

AsBasicJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsDiskJobSecrets 

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

AsDiskJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsHeavyJobSecrets 

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

AsHeavyJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsJobSecrets 

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

AsJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsJobSecretsType 

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

AsJobSecretsType is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobSecrets.

type JobSecretsType 

type JobSecretsType struct {
	// PodSecrets - Contains the list of secret objects for a job.
	PodSecrets *[]Secret `json:"podSecrets,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 

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

AsBasicJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsDiskJobSecrets 

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

AsDiskJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsHeavyJobSecrets 

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

AsHeavyJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsJobSecrets 

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

AsJobSecrets is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) AsJobSecretsType 

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

AsJobSecretsType is the BasicJobSecrets implementation for JobSecretsType.

func (JobSecretsType) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobSecretsType.

type JobSecretsTypeEnum 

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 

func PossibleJobSecretsTypeEnumValues() []JobSecretsTypeEnum

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

type JobStages 

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'
	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.

func (JobStages) MarshalJSON 

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

MarshalJSON is the custom marshaler for JobStages.

type JobsClient 

type JobsClient struct {
	BaseClient
}

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

func NewJobsClient 

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI 

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 

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 

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

BookShipmentPickUpPreparer prepares the BookShipmentPickUp request.

func (JobsClient) BookShipmentPickUpResponder 

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 

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 

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 

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

CancelPreparer prepares the Cancel request.

func (JobsClient) CancelResponder 

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 

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 

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 

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

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder 

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 

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 

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 

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

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder 

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 

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 

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 

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder 

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 

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 

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 

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 

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 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobsClient) ListByResourceGroupResponder 

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 

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 

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 

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 

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

ListCredentialsPreparer prepares the ListCredentials request.

func (JobsClient) ListCredentialsResponder 

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 

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 

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

ListPreparer prepares the List request.

func (JobsClient) ListResponder 

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 

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 

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 

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 

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 

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 

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.

func (*JobsCreateFuture) UnmarshalJSON 

func (future *JobsCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type JobsDeleteFuture 

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.

func (*JobsDeleteFuture) UnmarshalJSON 

func (future *JobsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type JobsUpdateFuture 

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.

func (*JobsUpdateFuture) UnmarshalJSON 

func (future *JobsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type NotificationPreference 

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 

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 

func PossibleNotificationStageNameValues() []NotificationStageName

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

type Operation 

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.

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

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 

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 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationList) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationList.

type OperationListIterator 

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

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

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 

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 

func (iter OperationListIterator) NotDone() bool

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

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

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

func (OperationListIterator) Value 

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 

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

OperationListPage contains a page of Operation values.

func NewOperationListPage 

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

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

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 

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 

func (page OperationListPage) NotDone() bool

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

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

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

func (OperationListPage) Values 

func (page OperationListPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

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

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

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 

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

List this method gets all the operations.

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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 

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 PackageShippingDetails 

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.

func (PackageShippingDetails) MarshalJSON 

func (psd PackageShippingDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PackageShippingDetails.

type Preferences 

type Preferences struct {
	PreferredDataCenterRegion *[]string `json:"preferredDataCenterRegion,omitempty"`
}

Preferences preferences related to the order

type Resource 

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 

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

MarshalJSON is the custom marshaler for Resource.

type Secret 

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.

func (Secret) MarshalJSON 

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Secret.

type ServiceClient 

type ServiceClient struct {
	BaseClient
}

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

func NewServiceClient 

func NewServiceClient(subscriptionID string) ServiceClient

NewServiceClient creates an instance of the ServiceClient client.

func NewServiceClientWithBaseURI 

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 

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) ListAvailableSkusComplete 

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 

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

ListAvailableSkusPreparer prepares the ListAvailableSkus request.

func (ServiceClient) ListAvailableSkusResponder 

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 

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) ValidateAddressMethod 

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

ValidateAddressMethod 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 

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

ValidateAddressMethodPreparer prepares the ValidateAddressMethod request.

func (ServiceClient) ValidateAddressMethodResponder 

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 

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.

type ShareCredentialDetails 

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: 'UnknownType', 'HCS', 'BlockBlob', 'PageBlob', 'AzureFile', 'ManagedDisk'
	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.

func (ShareCredentialDetails) MarshalJSON 

func (scd ShareCredentialDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ShareCredentialDetails.

type ShareDestinationFormatType 

type ShareDestinationFormatType string

ShareDestinationFormatType enumerates the values for share destination format type. 

const (
	// AzureFile Azure storage file format.
	AzureFile ShareDestinationFormatType = "AzureFile"
	// BlockBlob Azure storage block blob format.
	BlockBlob ShareDestinationFormatType = "BlockBlob"
	// HCS StorSimple data format.
	HCS ShareDestinationFormatType = "HCS"
	// ManagedDisk Azure Compute Disk.
	ManagedDisk ShareDestinationFormatType = "ManagedDisk"
	// PageBlob Azure storage page blob format.
	PageBlob ShareDestinationFormatType = "PageBlob"
	// UnknownType Unknown format.
	UnknownType ShareDestinationFormatType = "UnknownType"
)

func PossibleShareDestinationFormatTypeValues 

func PossibleShareDestinationFormatTypeValues() []ShareDestinationFormatType

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

type ShipmentPickUpRequest 

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 

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.

func (ShipmentPickUpResponse) MarshalJSON 

func (spur ShipmentPickUpResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ShipmentPickUpResponse.

type ShippingAddress 

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 

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 SkuCapacity 

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.

func (SkuCapacity) MarshalJSON 

func (sc SkuCapacity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuCapacity.

type SkuCost 

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.

func (SkuCost) MarshalJSON 

func (sc SkuCost) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuCost.

type SkuDisabledReason 

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 

func PossibleSkuDisabledReasonValues() []SkuDisabledReason

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

type SkuInformation 

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 

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

MarshalJSON is the custom marshaler for SkuInformation.

func (*SkuInformation) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for SkuInformation struct.

type SkuName 

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 

func PossibleSkuNameValues() []SkuName

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

type SkuProperties 

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.

func (SkuProperties) MarshalJSON 

func (sp SkuProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuProperties.

type StageName 

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"
	// 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"
)

func PossibleStageNameValues 

func PossibleStageNameValues() []StageName

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

type StageStatus 

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 

func PossibleStageStatusValues() []StageStatus

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

type UnencryptedCredentials 

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) MarshalJSON 

func (uc UnencryptedCredentials) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UnencryptedCredentials.

func (*UnencryptedCredentials) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for UnencryptedCredentials struct.

type UnencryptedCredentialsList 

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 

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 

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 

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

UnmarshalJSON is the custom unmarshaler for UpdateJobProperties struct.

type ValidateAddress 

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"`
}

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.