databoxedge

package
v48.2.2 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation ¶

Overview ¶

Package databoxedge implements the Azure ARM Databoxedge service API version 2019-08-01.

Index ¶

Constants ¶

View Source
const (
	// DefaultBaseURI is the default URI used for the service Databoxedge
	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 ARMBaseModel ¶

type ARMBaseModel struct {
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

ARMBaseModel represents the base class for all object models.

type AccountType ¶

type AccountType string

AccountType enumerates the values for account type.

const (
	// BlobStorage ...
	BlobStorage AccountType = "BlobStorage"
	// GeneralPurposeStorage ...
	GeneralPurposeStorage AccountType = "GeneralPurposeStorage"
)

func PossibleAccountTypeValues ¶

func PossibleAccountTypeValues() []AccountType

PossibleAccountTypeValues returns an array of possible values for the AccountType const type.

type Address ¶

type Address struct {
	// AddressLine1 - The address line1.
	AddressLine1 *string `json:"addressLine1,omitempty"`
	// AddressLine2 - The address line2.
	AddressLine2 *string `json:"addressLine2,omitempty"`
	// AddressLine3 - The address line3.
	AddressLine3 *string `json:"addressLine3,omitempty"`
	// PostalCode - The postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// City - The city name.
	City *string `json:"city,omitempty"`
	// State - The state name.
	State *string `json:"state,omitempty"`
	// Country - The country name.
	Country *string `json:"country,omitempty"`
}

Address the shipping address of the customer.

type Alert ¶

type Alert struct {
	autorest.Response `json:"-"`
	// AlertProperties - READ-ONLY; Properties of alert.
	*AlertProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Alert alert on the data box edge/gateway device.

func (Alert) MarshalJSON ¶

func (a Alert) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Alert.

func (*Alert) UnmarshalJSON ¶

func (a *Alert) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Alert struct.

type AlertErrorDetails ¶

type AlertErrorDetails struct {
	// ErrorCode - READ-ONLY; Error code.
	ErrorCode *string `json:"errorCode,omitempty"`
	// ErrorMessage - READ-ONLY; Error Message.
	ErrorMessage *string `json:"errorMessage,omitempty"`
	// Occurrences - READ-ONLY; Number of occurrences.
	Occurrences *int32 `json:"occurrences,omitempty"`
}

AlertErrorDetails error details for the alert.

type AlertList ¶

type AlertList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The value.
	Value *[]Alert `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

AlertList collection of alerts.

func (AlertList) IsEmpty ¶

func (al AlertList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AlertListIterator ¶

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

AlertListIterator provides access to a complete listing of Alert values.

func NewAlertListIterator ¶

func NewAlertListIterator(page AlertListPage) AlertListIterator

Creates a new instance of the AlertListIterator type.

func (*AlertListIterator) Next ¶

func (iter *AlertListIterator) 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 (*AlertListIterator) NextWithContext ¶

func (iter *AlertListIterator) 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 (AlertListIterator) NotDone ¶

func (iter AlertListIterator) NotDone() bool

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

func (AlertListIterator) Response ¶

func (iter AlertListIterator) Response() AlertList

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

func (AlertListIterator) Value ¶

func (iter AlertListIterator) Value() Alert

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

type AlertListPage ¶

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

AlertListPage contains a page of Alert values.

func NewAlertListPage ¶

func NewAlertListPage(cur AlertList, getNextPage func(context.Context, AlertList) (AlertList, error)) AlertListPage

Creates a new instance of the AlertListPage type.

func (*AlertListPage) Next ¶

func (page *AlertListPage) 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 (*AlertListPage) NextWithContext ¶

func (page *AlertListPage) 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 (AlertListPage) NotDone ¶

func (page AlertListPage) NotDone() bool

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

func (AlertListPage) Response ¶

func (page AlertListPage) Response() AlertList

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

func (AlertListPage) Values ¶

func (page AlertListPage) Values() []Alert

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

type AlertProperties ¶

type AlertProperties struct {
	// Title - READ-ONLY; Alert title.
	Title *string `json:"title,omitempty"`
	// AlertType - READ-ONLY; Alert type.
	AlertType *string `json:"alertType,omitempty"`
	// AppearedAtDateTime - READ-ONLY; UTC time when the alert appeared.
	AppearedAtDateTime *date.Time `json:"appearedAtDateTime,omitempty"`
	// Recommendation - READ-ONLY; Alert recommendation.
	Recommendation *string `json:"recommendation,omitempty"`
	// Severity - READ-ONLY; Severity of the alert. Possible values include: 'Informational', 'Warning', 'Critical'
	Severity AlertSeverity `json:"severity,omitempty"`
	// ErrorDetails - READ-ONLY; Error details of the alert.
	ErrorDetails *AlertErrorDetails `json:"errorDetails,omitempty"`
	// DetailedInformation - READ-ONLY; Alert details.
	DetailedInformation map[string]*string `json:"detailedInformation"`
}

AlertProperties properties of alert.

func (AlertProperties) MarshalJSON ¶

func (ap AlertProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertProperties.

type AlertSeverity ¶

type AlertSeverity string

AlertSeverity enumerates the values for alert severity.

const (
	// Critical ...
	Critical AlertSeverity = "Critical"
	// Informational ...
	Informational AlertSeverity = "Informational"
	// Warning ...
	Warning AlertSeverity = "Warning"
)

func PossibleAlertSeverityValues ¶

func PossibleAlertSeverityValues() []AlertSeverity

PossibleAlertSeverityValues returns an array of possible values for the AlertSeverity const type.

type AlertsClient ¶

type AlertsClient struct {
	BaseClient
}

AlertsClient is the client for the Alerts methods of the Databoxedge service.

func NewAlertsClient ¶

func NewAlertsClient(subscriptionID string) AlertsClient

NewAlertsClient creates an instance of the AlertsClient client.

func NewAlertsClientWithBaseURI ¶

func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string) AlertsClient

NewAlertsClientWithBaseURI creates an instance of the AlertsClient 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 (AlertsClient) Get ¶

func (client AlertsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result Alert, err error)

Get sends the get request. Parameters: deviceName - the device name. name - the alert name. resourceGroupName - the resource group name.

func (AlertsClient) GetPreparer ¶

func (client AlertsClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AlertsClient) GetResponder ¶

func (client AlertsClient) GetResponder(resp *http.Response) (result Alert, err error)

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

func (AlertsClient) GetSender ¶

func (client AlertsClient) 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 (AlertsClient) ListByDataBoxEdgeDevice ¶

func (client AlertsClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result AlertListPage, err error)

ListByDataBoxEdgeDevice gets all the alerts for a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (AlertsClient) ListByDataBoxEdgeDeviceComplete ¶

func (client AlertsClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result AlertListIterator, err error)

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

func (AlertsClient) ListByDataBoxEdgeDevicePreparer ¶

func (client AlertsClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (AlertsClient) ListByDataBoxEdgeDeviceResponder ¶

func (client AlertsClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result AlertList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (AlertsClient) ListByDataBoxEdgeDeviceSender ¶

func (client AlertsClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type AsymmetricEncryptedSecret ¶

type AsymmetricEncryptedSecret struct {
	// Value - The value of the secret.
	Value *string `json:"value,omitempty"`
	// EncryptionCertThumbprint - Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null.
	EncryptionCertThumbprint *string `json:"encryptionCertThumbprint,omitempty"`
	// EncryptionAlgorithm - The algorithm used to encrypt "Value". Possible values include: 'None', 'AES256', 'RSAESPKCS1V15'
	EncryptionAlgorithm EncryptionAlgorithm `json:"encryptionAlgorithm,omitempty"`
}

AsymmetricEncryptedSecret represent the secrets intended for encryption with asymmetric key pair.

type Authentication ¶

type Authentication struct {
	// SymmetricKey - Symmetric key for authentication.
	SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
}

Authentication authentication mechanism for IoT devices.

type AuthenticationType ¶

type AuthenticationType string

AuthenticationType enumerates the values for authentication type.

const (
	// AzureActiveDirectory ...
	AzureActiveDirectory AuthenticationType = "AzureActiveDirectory"
	// Invalid ...
	Invalid AuthenticationType = "Invalid"
)

func PossibleAuthenticationTypeValues ¶

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.

type AzureContainerDataFormat ¶

type AzureContainerDataFormat string

AzureContainerDataFormat enumerates the values for azure container data format.

const (
	// AzureFile ...
	AzureFile AzureContainerDataFormat = "AzureFile"
	// BlockBlob ...
	BlockBlob AzureContainerDataFormat = "BlockBlob"
	// PageBlob ...
	PageBlob AzureContainerDataFormat = "PageBlob"
)

func PossibleAzureContainerDataFormatValues ¶

func PossibleAzureContainerDataFormatValues() []AzureContainerDataFormat

PossibleAzureContainerDataFormatValues returns an array of possible values for the AzureContainerDataFormat const type.

type AzureContainerInfo ¶

type AzureContainerInfo struct {
	// StorageAccountCredentialID - ID of the storage account credential used to access storage.
	StorageAccountCredentialID *string `json:"storageAccountCredentialId,omitempty"`
	// ContainerName - Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
	ContainerName *string `json:"containerName,omitempty"`
	// DataFormat - Storage format used for the file represented by the share. Possible values include: 'BlockBlob', 'PageBlob', 'AzureFile'
	DataFormat AzureContainerDataFormat `json:"dataFormat,omitempty"`
}

AzureContainerInfo azure container mapping of the endpoint.

type BandwidthSchedule ¶

type BandwidthSchedule struct {
	autorest.Response `json:"-"`
	// BandwidthScheduleProperties - The properties of the bandwidth schedule.
	*BandwidthScheduleProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

BandwidthSchedule the bandwidth schedule details.

func (BandwidthSchedule) MarshalJSON ¶

func (bs BandwidthSchedule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BandwidthSchedule.

func (*BandwidthSchedule) UnmarshalJSON ¶

func (bs *BandwidthSchedule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BandwidthSchedule struct.

type BandwidthScheduleProperties ¶

type BandwidthScheduleProperties struct {
	// Start - The start time of the schedule in UTC.
	Start *string `json:"start,omitempty"`
	// Stop - The stop time of the schedule in UTC.
	Stop *string `json:"stop,omitempty"`
	// RateInMbps - The bandwidth rate in Mbps.
	RateInMbps *int32 `json:"rateInMbps,omitempty"`
	// Days - The days of the week when this schedule is applicable.
	Days *[]DayOfWeek `json:"days,omitempty"`
}

BandwidthScheduleProperties the properties of the bandwidth schedule.

type BandwidthSchedulesClient ¶

type BandwidthSchedulesClient struct {
	BaseClient
}

BandwidthSchedulesClient is the client for the BandwidthSchedules methods of the Databoxedge service.

func NewBandwidthSchedulesClient ¶

func NewBandwidthSchedulesClient(subscriptionID string) BandwidthSchedulesClient

NewBandwidthSchedulesClient creates an instance of the BandwidthSchedulesClient client.

func NewBandwidthSchedulesClientWithBaseURI ¶

func NewBandwidthSchedulesClientWithBaseURI(baseURI string, subscriptionID string) BandwidthSchedulesClient

NewBandwidthSchedulesClientWithBaseURI creates an instance of the BandwidthSchedulesClient 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 (BandwidthSchedulesClient) CreateOrUpdate ¶

func (client BandwidthSchedulesClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, parameters BandwidthSchedule, resourceGroupName string) (result BandwidthSchedulesCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a bandwidth schedule. Parameters: deviceName - the device name. name - the bandwidth schedule name which needs to be added/updated. parameters - the bandwidth schedule to be added or updated. resourceGroupName - the resource group name.

func (BandwidthSchedulesClient) CreateOrUpdatePreparer ¶

func (client BandwidthSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, parameters BandwidthSchedule, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BandwidthSchedulesClient) CreateOrUpdateResponder ¶

func (client BandwidthSchedulesClient) CreateOrUpdateResponder(resp *http.Response) (result BandwidthSchedule, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (BandwidthSchedulesClient) CreateOrUpdateSender ¶

func (client BandwidthSchedulesClient) CreateOrUpdateSender(req *http.Request) (future BandwidthSchedulesCreateOrUpdateFuture, err error)

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

func (BandwidthSchedulesClient) Delete ¶

func (client BandwidthSchedulesClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result BandwidthSchedulesDeleteFuture, err error)

Delete deletes the specified bandwidth schedule. Parameters: deviceName - the device name. name - the bandwidth schedule name. resourceGroupName - the resource group name.

func (BandwidthSchedulesClient) DeletePreparer ¶

func (client BandwidthSchedulesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BandwidthSchedulesClient) DeleteResponder ¶

func (client BandwidthSchedulesClient) 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 (BandwidthSchedulesClient) DeleteSender ¶

func (client BandwidthSchedulesClient) DeleteSender(req *http.Request) (future BandwidthSchedulesDeleteFuture, err error)

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

func (BandwidthSchedulesClient) Get ¶

func (client BandwidthSchedulesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result BandwidthSchedule, err error)

Get gets the properties of the specified bandwidth schedule. Parameters: deviceName - the device name. name - the bandwidth schedule name. resourceGroupName - the resource group name.

func (BandwidthSchedulesClient) GetPreparer ¶

func (client BandwidthSchedulesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BandwidthSchedulesClient) GetResponder ¶

func (client BandwidthSchedulesClient) GetResponder(resp *http.Response) (result BandwidthSchedule, err error)

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

func (BandwidthSchedulesClient) GetSender ¶

func (client BandwidthSchedulesClient) 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 (BandwidthSchedulesClient) ListByDataBoxEdgeDevice ¶

func (client BandwidthSchedulesClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result BandwidthSchedulesListPage, err error)

ListByDataBoxEdgeDevice gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceComplete ¶

func (client BandwidthSchedulesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result BandwidthSchedulesListIterator, err error)

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

func (BandwidthSchedulesClient) ListByDataBoxEdgeDevicePreparer ¶

func (client BandwidthSchedulesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceResponder ¶

func (client BandwidthSchedulesClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result BandwidthSchedulesList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceSender ¶

func (client BandwidthSchedulesClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type BandwidthSchedulesCreateOrUpdateFuture ¶

type BandwidthSchedulesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*BandwidthSchedulesCreateOrUpdateFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type BandwidthSchedulesDeleteFuture ¶

type BandwidthSchedulesDeleteFuture struct {
	azure.Future
}

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

func (*BandwidthSchedulesDeleteFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type BandwidthSchedulesList ¶

type BandwidthSchedulesList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of bandwidth schedules.
	Value *[]BandwidthSchedule `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

BandwidthSchedulesList the collection of bandwidth schedules.

func (BandwidthSchedulesList) IsEmpty ¶

func (bsl BandwidthSchedulesList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BandwidthSchedulesListIterator ¶

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

BandwidthSchedulesListIterator provides access to a complete listing of BandwidthSchedule values.

func NewBandwidthSchedulesListIterator ¶

func NewBandwidthSchedulesListIterator(page BandwidthSchedulesListPage) BandwidthSchedulesListIterator

Creates a new instance of the BandwidthSchedulesListIterator type.

func (*BandwidthSchedulesListIterator) Next ¶

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 (*BandwidthSchedulesListIterator) NextWithContext ¶

func (iter *BandwidthSchedulesListIterator) 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 (BandwidthSchedulesListIterator) NotDone ¶

func (iter BandwidthSchedulesListIterator) NotDone() bool

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

func (BandwidthSchedulesListIterator) Response ¶

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

func (BandwidthSchedulesListIterator) Value ¶

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

type BandwidthSchedulesListPage ¶

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

BandwidthSchedulesListPage contains a page of BandwidthSchedule values.

func NewBandwidthSchedulesListPage ¶

Creates a new instance of the BandwidthSchedulesListPage type.

func (*BandwidthSchedulesListPage) Next ¶

func (page *BandwidthSchedulesListPage) 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 (*BandwidthSchedulesListPage) NextWithContext ¶

func (page *BandwidthSchedulesListPage) 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 (BandwidthSchedulesListPage) NotDone ¶

func (page BandwidthSchedulesListPage) NotDone() bool

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

func (BandwidthSchedulesListPage) Response ¶

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

func (BandwidthSchedulesListPage) Values ¶

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

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 BasicRole ¶

type BasicRole interface {
	AsIoTRole() (*IoTRole, bool)
	AsRole() (*Role, bool)
}

BasicRole compute role.

type BasicTrigger ¶

type BasicTrigger interface {
	AsFileEventTrigger() (*FileEventTrigger, bool)
	AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)
	AsTrigger() (*Trigger, bool)
}

BasicTrigger trigger details.

type ClientAccessRight ¶

type ClientAccessRight struct {
	// Client - IP of the client.
	Client *string `json:"client,omitempty"`
	// AccessPermission - Type of access to be allowed for the client. Possible values include: 'NoAccess', 'ReadOnly', 'ReadWrite'
	AccessPermission ClientPermissionType `json:"accessPermission,omitempty"`
}

ClientAccessRight the mapping between a particular client IP and the type of access client has on the NFS share.

type ClientPermissionType ¶

type ClientPermissionType string

ClientPermissionType enumerates the values for client permission type.

const (
	// NoAccess ...
	NoAccess ClientPermissionType = "NoAccess"
	// ReadOnly ...
	ReadOnly ClientPermissionType = "ReadOnly"
	// ReadWrite ...
	ReadWrite ClientPermissionType = "ReadWrite"
)

func PossibleClientPermissionTypeValues ¶

func PossibleClientPermissionTypeValues() []ClientPermissionType

PossibleClientPermissionTypeValues returns an array of possible values for the ClientPermissionType const type.

type CloudError ¶

type CloudError struct {
	// Error - The error details.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the service.

type CloudErrorBody ¶

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the service.

type ContactDetails ¶

type ContactDetails struct {
	// ContactPerson - The contact person name.
	ContactPerson *string `json:"contactPerson,omitempty"`
	// CompanyName - The name of the company.
	CompanyName *string `json:"companyName,omitempty"`
	// Phone - The phone number.
	Phone *string `json:"phone,omitempty"`
	// EmailList - The email list.
	EmailList *[]string `json:"emailList,omitempty"`
}

ContactDetails contains all the contact details of the customer.

type Container ¶

type Container struct {
	autorest.Response `json:"-"`
	// ContainerProperties - The container properties.
	*ContainerProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Container represents a container on the Data Box Edge/Gateway device.

func (Container) MarshalJSON ¶

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Container.

func (*Container) UnmarshalJSON ¶

func (c *Container) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Container struct.

type ContainerList ¶

type ContainerList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of containers.
	Value *[]Container `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ContainerList collection of all the containers on the Data Box Edge/Gateway device.

func (ContainerList) IsEmpty ¶

func (cl ContainerList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ContainerListIterator ¶

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

ContainerListIterator provides access to a complete listing of Container values.

func NewContainerListIterator ¶

func NewContainerListIterator(page ContainerListPage) ContainerListIterator

Creates a new instance of the ContainerListIterator type.

func (*ContainerListIterator) Next ¶

func (iter *ContainerListIterator) 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 (*ContainerListIterator) NextWithContext ¶

func (iter *ContainerListIterator) 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 (ContainerListIterator) NotDone ¶

func (iter ContainerListIterator) NotDone() bool

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

func (ContainerListIterator) Response ¶

func (iter ContainerListIterator) Response() ContainerList

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

func (ContainerListIterator) Value ¶

func (iter ContainerListIterator) Value() Container

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

type ContainerListPage ¶

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

ContainerListPage contains a page of Container values.

func NewContainerListPage ¶

func NewContainerListPage(cur ContainerList, getNextPage func(context.Context, ContainerList) (ContainerList, error)) ContainerListPage

Creates a new instance of the ContainerListPage type.

func (*ContainerListPage) Next ¶

func (page *ContainerListPage) 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 (*ContainerListPage) NextWithContext ¶

func (page *ContainerListPage) 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 (ContainerListPage) NotDone ¶

func (page ContainerListPage) NotDone() bool

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

func (ContainerListPage) Response ¶

func (page ContainerListPage) Response() ContainerList

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

func (ContainerListPage) Values ¶

func (page ContainerListPage) Values() []Container

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

type ContainerProperties ¶

type ContainerProperties struct {
	// ContainerStatus - READ-ONLY; Current status of the container. Possible values include: 'OK', 'Offline', 'Unknown', 'Updating', 'NeedsAttention'
	ContainerStatus ContainerStatus `json:"containerStatus,omitempty"`
	// DataFormat - DataFormat for Container. Possible values include: 'BlockBlob', 'PageBlob', 'AzureFile'
	DataFormat AzureContainerDataFormat `json:"dataFormat,omitempty"`
	// RefreshDetails - READ-ONLY; Details of the refresh job on this container.
	RefreshDetails *RefreshDetails `json:"refreshDetails,omitempty"`
	// CreatedDateTime - READ-ONLY; The UTC time when container got created.
	CreatedDateTime *date.Time `json:"createdDateTime,omitempty"`
}

ContainerProperties the container properties.

func (ContainerProperties) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for ContainerProperties.

type ContainerStatus ¶

type ContainerStatus string

ContainerStatus enumerates the values for container status.

const (
	// NeedsAttention ...
	NeedsAttention ContainerStatus = "NeedsAttention"
	// Offline ...
	Offline ContainerStatus = "Offline"
	// OK ...
	OK ContainerStatus = "OK"
	// Unknown ...
	Unknown ContainerStatus = "Unknown"
	// Updating ...
	Updating ContainerStatus = "Updating"
)

func PossibleContainerStatusValues ¶

func PossibleContainerStatusValues() []ContainerStatus

PossibleContainerStatusValues returns an array of possible values for the ContainerStatus const type.

type ContainersClient ¶

type ContainersClient struct {
	BaseClient
}

ContainersClient is the client for the Containers methods of the Databoxedge service.

func NewContainersClient ¶

func NewContainersClient(subscriptionID string) ContainersClient

NewContainersClient creates an instance of the ContainersClient client.

func NewContainersClientWithBaseURI ¶

func NewContainersClientWithBaseURI(baseURI string, subscriptionID string) ContainersClient

NewContainersClientWithBaseURI creates an instance of the ContainersClient 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 (ContainersClient) CreateOrUpdate ¶

func (client ContainersClient) CreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, containerName string, containerParameter Container, resourceGroupName string) (result ContainersCreateOrUpdateFuture, err error)

CreateOrUpdate sends the create or update request. Parameters: deviceName - the device name. storageAccountName - the Storage Account Name containerName - the container name. containerParameter - the container properties. resourceGroupName - the resource group name.

func (ContainersClient) CreateOrUpdatePreparer ¶

func (client ContainersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, storageAccountName string, containerName string, containerParameter Container, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ContainersClient) CreateOrUpdateResponder ¶

func (client ContainersClient) CreateOrUpdateResponder(resp *http.Response) (result Container, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ContainersClient) CreateOrUpdateSender ¶

func (client ContainersClient) CreateOrUpdateSender(req *http.Request) (future ContainersCreateOrUpdateFuture, err error)

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

func (ContainersClient) Delete ¶

func (client ContainersClient) Delete(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result ContainersDeleteFuture, err error)

Delete deletes the container on the Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. storageAccountName - the Storage Account Name containerName - the container name. resourceGroupName - the resource group name.

func (ContainersClient) DeletePreparer ¶

func (client ContainersClient) DeletePreparer(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ContainersClient) DeleteResponder ¶

func (client ContainersClient) 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 (ContainersClient) DeleteSender ¶

func (client ContainersClient) DeleteSender(req *http.Request) (future ContainersDeleteFuture, err error)

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

func (ContainersClient) Get ¶

func (client ContainersClient) Get(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result Container, err error)

Get sends the get request. Parameters: deviceName - the device name. storageAccountName - the Storage Account Name containerName - the container Name resourceGroupName - the resource group name.

func (ContainersClient) GetPreparer ¶

func (client ContainersClient) GetPreparer(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ContainersClient) GetResponder ¶

func (client ContainersClient) GetResponder(resp *http.Response) (result Container, err error)

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

func (ContainersClient) GetSender ¶

func (client ContainersClient) 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 (ContainersClient) ListByStorageAccount ¶

func (client ContainersClient) ListByStorageAccount(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result ContainerListPage, err error)

ListByStorageAccount sends the list by storage account request. Parameters: deviceName - the device name. storageAccountName - the storage Account name. resourceGroupName - the resource group name.

func (ContainersClient) ListByStorageAccountComplete ¶

func (client ContainersClient) ListByStorageAccountComplete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result ContainerListIterator, err error)

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

func (ContainersClient) ListByStorageAccountPreparer ¶

func (client ContainersClient) ListByStorageAccountPreparer(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (*http.Request, error)

ListByStorageAccountPreparer prepares the ListByStorageAccount request.

func (ContainersClient) ListByStorageAccountResponder ¶

func (client ContainersClient) ListByStorageAccountResponder(resp *http.Response) (result ContainerList, err error)

ListByStorageAccountResponder handles the response to the ListByStorageAccount request. The method always closes the http.Response Body.

func (ContainersClient) ListByStorageAccountSender ¶

func (client ContainersClient) ListByStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (ContainersClient) Refresh ¶

func (client ContainersClient) Refresh(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result ContainersRefreshFuture, err error)

Refresh sends the refresh request. Parameters: deviceName - the device name. storageAccountName - the Storage Account Name containerName - the container name. resourceGroupName - the resource group name.

func (ContainersClient) RefreshPreparer ¶

func (client ContainersClient) RefreshPreparer(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (*http.Request, error)

RefreshPreparer prepares the Refresh request.

func (ContainersClient) RefreshResponder ¶

func (client ContainersClient) RefreshResponder(resp *http.Response) (result autorest.Response, err error)

RefreshResponder handles the response to the Refresh request. The method always closes the http.Response Body.

func (ContainersClient) RefreshSender ¶

func (client ContainersClient) RefreshSender(req *http.Request) (future ContainersRefreshFuture, err error)

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

type ContainersCreateOrUpdateFuture ¶

type ContainersCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*ContainersCreateOrUpdateFuture) Result ¶

func (future *ContainersCreateOrUpdateFuture) Result(client ContainersClient) (c Container, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ContainersDeleteFuture ¶

type ContainersDeleteFuture struct {
	azure.Future
}

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

func (*ContainersDeleteFuture) Result ¶

func (future *ContainersDeleteFuture) Result(client ContainersClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ContainersRefreshFuture ¶

type ContainersRefreshFuture struct {
	azure.Future
}

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

func (*ContainersRefreshFuture) Result ¶

func (future *ContainersRefreshFuture) Result(client ContainersClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DataPolicy ¶

type DataPolicy string

DataPolicy enumerates the values for data policy.

const (
	// Cloud ...
	Cloud DataPolicy = "Cloud"
	// Local ...
	Local DataPolicy = "Local"
)

func PossibleDataPolicyValues ¶

func PossibleDataPolicyValues() []DataPolicy

PossibleDataPolicyValues returns an array of possible values for the DataPolicy const type.

type DayOfWeek ¶

type DayOfWeek string

DayOfWeek enumerates the values for day of week.

const (
	// Friday ...
	Friday DayOfWeek = "Friday"
	// Monday ...
	Monday DayOfWeek = "Monday"
	// Saturday ...
	Saturday DayOfWeek = "Saturday"
	// Sunday ...
	Sunday DayOfWeek = "Sunday"
	// Thursday ...
	Thursday DayOfWeek = "Thursday"
	// Tuesday ...
	Tuesday DayOfWeek = "Tuesday"
	// Wednesday ...
	Wednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues ¶

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.

type Device ¶

type Device struct {
	autorest.Response `json:"-"`
	// Location - The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
	Tags map[string]*string `json:"tags"`
	// Sku - The SKU type.
	Sku *Sku `json:"sku,omitempty"`
	// Etag - The etag for the devices.
	Etag *string `json:"etag,omitempty"`
	// DeviceProperties - The properties of the Data Box Edge/Gateway device.
	*DeviceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Device the Data Box Edge/Gateway device.

func (Device) MarshalJSON ¶

func (d Device) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Device.

func (*Device) UnmarshalJSON ¶

func (d *Device) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Device struct.

type DeviceExtendedInfo ¶

type DeviceExtendedInfo struct {
	autorest.Response `json:"-"`
	// DeviceExtendedInfoProperties - The extended info properties.
	*DeviceExtendedInfoProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

DeviceExtendedInfo the extended Info of the Data Box Edge/Gateway device.

func (DeviceExtendedInfo) MarshalJSON ¶

func (dei DeviceExtendedInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceExtendedInfo.

func (*DeviceExtendedInfo) UnmarshalJSON ¶

func (dei *DeviceExtendedInfo) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DeviceExtendedInfo struct.

type DeviceExtendedInfoProperties ¶

type DeviceExtendedInfoProperties struct {
	// EncryptionKeyThumbprint - The digital signature of encrypted certificate.
	EncryptionKeyThumbprint *string `json:"encryptionKeyThumbprint,omitempty"`
	// EncryptionKey - The public part of the encryption certificate. Client uses this to encrypt any secret.
	EncryptionKey *string `json:"encryptionKey,omitempty"`
	// ResourceKey - READ-ONLY; The Resource ID of the Resource.
	ResourceKey *string `json:"resourceKey,omitempty"`
}

DeviceExtendedInfoProperties the properties of the Data Box Edge/Gateway device extended info.

func (DeviceExtendedInfoProperties) MarshalJSON ¶

func (deip DeviceExtendedInfoProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceExtendedInfoProperties.

type DeviceList ¶

type DeviceList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of Data Box Edge/Gateway devices.
	Value *[]Device `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceList the collection of Data Box Edge/Gateway devices.

func (DeviceList) IsEmpty ¶

func (dl DeviceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceListIterator ¶

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

DeviceListIterator provides access to a complete listing of Device values.

func NewDeviceListIterator ¶

func NewDeviceListIterator(page DeviceListPage) DeviceListIterator

Creates a new instance of the DeviceListIterator type.

func (*DeviceListIterator) Next ¶

func (iter *DeviceListIterator) 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 (*DeviceListIterator) NextWithContext ¶

func (iter *DeviceListIterator) 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 (DeviceListIterator) NotDone ¶

func (iter DeviceListIterator) NotDone() bool

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

func (DeviceListIterator) Response ¶

func (iter DeviceListIterator) Response() DeviceList

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

func (DeviceListIterator) Value ¶

func (iter DeviceListIterator) Value() Device

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

type DeviceListPage ¶

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

DeviceListPage contains a page of Device values.

func NewDeviceListPage ¶

func NewDeviceListPage(cur DeviceList, getNextPage func(context.Context, DeviceList) (DeviceList, error)) DeviceListPage

Creates a new instance of the DeviceListPage type.

func (*DeviceListPage) Next ¶

func (page *DeviceListPage) 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 (*DeviceListPage) NextWithContext ¶

func (page *DeviceListPage) 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 (DeviceListPage) NotDone ¶

func (page DeviceListPage) NotDone() bool

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

func (DeviceListPage) Response ¶

func (page DeviceListPage) Response() DeviceList

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

func (DeviceListPage) Values ¶

func (page DeviceListPage) Values() []Device

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

type DevicePatch ¶

type DevicePatch struct {
	// Tags - The tags attached to the Data Box Edge/Gateway resource.
	Tags map[string]*string `json:"tags"`
}

DevicePatch the Data Box Edge/Gateway device patch.

func (DevicePatch) MarshalJSON ¶

func (dp DevicePatch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DevicePatch.

type DeviceProperties ¶

type DeviceProperties struct {
	// DataBoxEdgeDeviceStatus - The status of the Data Box Edge/Gateway device. Possible values include: 'DeviceStatusReadyToSetup', 'DeviceStatusOnline', 'DeviceStatusOffline', 'DeviceStatusNeedsAttention', 'DeviceStatusDisconnected', 'DeviceStatusPartiallyDisconnected', 'DeviceStatusMaintenance'
	DataBoxEdgeDeviceStatus DeviceStatus `json:"dataBoxEdgeDeviceStatus,omitempty"`
	// SerialNumber - READ-ONLY; The Serial Number of Data Box Edge/Gateway device.
	SerialNumber *string `json:"serialNumber,omitempty"`
	// Description - The Description of the Data Box Edge/Gateway device.
	Description *string `json:"description,omitempty"`
	// ModelDescription - The description of the Data Box Edge/Gateway device model.
	ModelDescription *string `json:"modelDescription,omitempty"`
	// DeviceType - READ-ONLY; The type of the Data Box Edge/Gateway device. Possible values include: 'DataBoxEdgeDevice'
	DeviceType DeviceType `json:"deviceType,omitempty"`
	// FriendlyName - The Data Box Edge/Gateway device name.
	FriendlyName *string `json:"friendlyName,omitempty"`
	// Culture - READ-ONLY; The Data Box Edge/Gateway device culture.
	Culture *string `json:"culture,omitempty"`
	// DeviceModel - READ-ONLY; The Data Box Edge/Gateway device model.
	DeviceModel *string `json:"deviceModel,omitempty"`
	// DeviceSoftwareVersion - READ-ONLY; The Data Box Edge/Gateway device software version.
	DeviceSoftwareVersion *string `json:"deviceSoftwareVersion,omitempty"`
	// DeviceLocalCapacity - READ-ONLY; The Data Box Edge/Gateway device local capacity in MB.
	DeviceLocalCapacity *int64 `json:"deviceLocalCapacity,omitempty"`
	// TimeZone - READ-ONLY; The Data Box Edge/Gateway device timezone.
	TimeZone *string `json:"timeZone,omitempty"`
	// DeviceHcsVersion - READ-ONLY; The device software version number of the device (eg: 1.2.18105.6).
	DeviceHcsVersion *string `json:"deviceHcsVersion,omitempty"`
	// ConfiguredRoleTypes - READ-ONLY; Type of compute roles configured.
	ConfiguredRoleTypes *[]RoleTypes `json:"configuredRoleTypes,omitempty"`
	// NodeCount - READ-ONLY; The number of nodes in the cluster.
	NodeCount *int32 `json:"nodeCount,omitempty"`
}

DeviceProperties the properties of the Data Box Edge/Gateway device.

func (DeviceProperties) MarshalJSON ¶

func (dp DeviceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceProperties.

type DeviceStatus ¶

type DeviceStatus string

DeviceStatus enumerates the values for device status.

const (
	// DeviceStatusDisconnected ...
	DeviceStatusDisconnected DeviceStatus = "Disconnected"
	// DeviceStatusMaintenance ...
	DeviceStatusMaintenance DeviceStatus = "Maintenance"
	// DeviceStatusNeedsAttention ...
	DeviceStatusNeedsAttention DeviceStatus = "NeedsAttention"
	// DeviceStatusOffline ...
	DeviceStatusOffline DeviceStatus = "Offline"
	// DeviceStatusOnline ...
	DeviceStatusOnline DeviceStatus = "Online"
	// DeviceStatusPartiallyDisconnected ...
	DeviceStatusPartiallyDisconnected DeviceStatus = "PartiallyDisconnected"
	// DeviceStatusReadyToSetup ...
	DeviceStatusReadyToSetup DeviceStatus = "ReadyToSetup"
)

func PossibleDeviceStatusValues ¶

func PossibleDeviceStatusValues() []DeviceStatus

PossibleDeviceStatusValues returns an array of possible values for the DeviceStatus const type.

type DeviceType ¶

type DeviceType string

DeviceType enumerates the values for device type.

const (
	// DataBoxEdgeDevice ...
	DataBoxEdgeDevice DeviceType = "DataBoxEdgeDevice"
)

func PossibleDeviceTypeValues ¶

func PossibleDeviceTypeValues() []DeviceType

PossibleDeviceTypeValues returns an array of possible values for the DeviceType const type.

type DevicesClient ¶

type DevicesClient struct {
	BaseClient
}

DevicesClient is the client for the Devices methods of the Databoxedge service.

func NewDevicesClient ¶

func NewDevicesClient(subscriptionID string) DevicesClient

NewDevicesClient creates an instance of the DevicesClient client.

func NewDevicesClientWithBaseURI ¶

func NewDevicesClientWithBaseURI(baseURI string, subscriptionID string) DevicesClient

NewDevicesClientWithBaseURI creates an instance of the DevicesClient 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 (DevicesClient) CreateOrUpdate ¶

func (client DevicesClient) CreateOrUpdate(ctx context.Context, deviceName string, dataBoxEdgeDevice Device, resourceGroupName string) (result DevicesCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a Data Box Edge/Data Box Gateway resource. Parameters: deviceName - the device name. dataBoxEdgeDevice - the resource object. resourceGroupName - the resource group name.

func (DevicesClient) CreateOrUpdatePreparer ¶

func (client DevicesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, dataBoxEdgeDevice Device, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DevicesClient) CreateOrUpdateResponder ¶

func (client DevicesClient) CreateOrUpdateResponder(resp *http.Response) (result Device, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DevicesClient) CreateOrUpdateSecuritySettings ¶

func (client DevicesClient) CreateOrUpdateSecuritySettings(ctx context.Context, deviceName string, securitySettings SecuritySettings, resourceGroupName string) (result DevicesCreateOrUpdateSecuritySettingsFuture, err error)

CreateOrUpdateSecuritySettings updates the security settings on a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. securitySettings - the security settings. resourceGroupName - the resource group name.

func (DevicesClient) CreateOrUpdateSecuritySettingsPreparer ¶

func (client DevicesClient) CreateOrUpdateSecuritySettingsPreparer(ctx context.Context, deviceName string, securitySettings SecuritySettings, resourceGroupName string) (*http.Request, error)

CreateOrUpdateSecuritySettingsPreparer prepares the CreateOrUpdateSecuritySettings request.

func (DevicesClient) CreateOrUpdateSecuritySettingsResponder ¶

func (client DevicesClient) CreateOrUpdateSecuritySettingsResponder(resp *http.Response) (result autorest.Response, err error)

CreateOrUpdateSecuritySettingsResponder handles the response to the CreateOrUpdateSecuritySettings request. The method always closes the http.Response Body.

func (DevicesClient) CreateOrUpdateSecuritySettingsSender ¶

func (client DevicesClient) CreateOrUpdateSecuritySettingsSender(req *http.Request) (future DevicesCreateOrUpdateSecuritySettingsFuture, err error)

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

func (DevicesClient) CreateOrUpdateSender ¶

func (client DevicesClient) CreateOrUpdateSender(req *http.Request) (future DevicesCreateOrUpdateFuture, err error)

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

func (DevicesClient) Delete ¶

func (client DevicesClient) Delete(ctx context.Context, deviceName string, resourceGroupName string) (result DevicesDeleteFuture, err error)

Delete deletes the Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) DeletePreparer ¶

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

DeletePreparer prepares the Delete request.

func (DevicesClient) DeleteResponder ¶

func (client DevicesClient) 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 (DevicesClient) DeleteSender ¶

func (client DevicesClient) DeleteSender(req *http.Request) (future DevicesDeleteFuture, err error)

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

func (DevicesClient) DownloadUpdates ¶

func (client DevicesClient) DownloadUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result DevicesDownloadUpdatesFuture, err error)

DownloadUpdates sends the download updates request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) DownloadUpdatesPreparer ¶

func (client DevicesClient) DownloadUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

DownloadUpdatesPreparer prepares the DownloadUpdates request.

func (DevicesClient) DownloadUpdatesResponder ¶

func (client DevicesClient) DownloadUpdatesResponder(resp *http.Response) (result autorest.Response, err error)

DownloadUpdatesResponder handles the response to the DownloadUpdates request. The method always closes the http.Response Body.

func (DevicesClient) DownloadUpdatesSender ¶

func (client DevicesClient) DownloadUpdatesSender(req *http.Request) (future DevicesDownloadUpdatesFuture, err error)

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

func (DevicesClient) Get ¶

func (client DevicesClient) Get(ctx context.Context, deviceName string, resourceGroupName string) (result Device, err error)

Get gets the properties of the Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) GetExtendedInformation ¶

func (client DevicesClient) GetExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string) (result DeviceExtendedInfo, err error)

GetExtendedInformation gets additional information for the specified Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) GetExtendedInformationPreparer ¶

func (client DevicesClient) GetExtendedInformationPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

GetExtendedInformationPreparer prepares the GetExtendedInformation request.

func (DevicesClient) GetExtendedInformationResponder ¶

func (client DevicesClient) GetExtendedInformationResponder(resp *http.Response) (result DeviceExtendedInfo, err error)

GetExtendedInformationResponder handles the response to the GetExtendedInformation request. The method always closes the http.Response Body.

func (DevicesClient) GetExtendedInformationSender ¶

func (client DevicesClient) GetExtendedInformationSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetNetworkSettings ¶

func (client DevicesClient) GetNetworkSettings(ctx context.Context, deviceName string, resourceGroupName string) (result NetworkSettings, err error)

GetNetworkSettings gets the network settings of the specified Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) GetNetworkSettingsPreparer ¶

func (client DevicesClient) GetNetworkSettingsPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

GetNetworkSettingsPreparer prepares the GetNetworkSettings request.

func (DevicesClient) GetNetworkSettingsResponder ¶

func (client DevicesClient) GetNetworkSettingsResponder(resp *http.Response) (result NetworkSettings, err error)

GetNetworkSettingsResponder handles the response to the GetNetworkSettings request. The method always closes the http.Response Body.

func (DevicesClient) GetNetworkSettingsSender ¶

func (client DevicesClient) GetNetworkSettingsSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetPreparer ¶

func (client DevicesClient) GetPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DevicesClient) GetResponder ¶

func (client DevicesClient) GetResponder(resp *http.Response) (result Device, err error)

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

func (DevicesClient) GetSender ¶

func (client DevicesClient) 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 (DevicesClient) GetUpdateSummary ¶

func (client DevicesClient) GetUpdateSummary(ctx context.Context, deviceName string, resourceGroupName string) (result UpdateSummary, err error)

GetUpdateSummary sends the get update summary request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) GetUpdateSummaryPreparer ¶

func (client DevicesClient) GetUpdateSummaryPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

GetUpdateSummaryPreparer prepares the GetUpdateSummary request.

func (DevicesClient) GetUpdateSummaryResponder ¶

func (client DevicesClient) GetUpdateSummaryResponder(resp *http.Response) (result UpdateSummary, err error)

GetUpdateSummaryResponder handles the response to the GetUpdateSummary request. The method always closes the http.Response Body.

func (DevicesClient) GetUpdateSummarySender ¶

func (client DevicesClient) GetUpdateSummarySender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) InstallUpdates ¶

func (client DevicesClient) InstallUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result DevicesInstallUpdatesFuture, err error)

InstallUpdates sends the install updates request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) InstallUpdatesPreparer ¶

func (client DevicesClient) InstallUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

InstallUpdatesPreparer prepares the InstallUpdates request.

func (DevicesClient) InstallUpdatesResponder ¶

func (client DevicesClient) InstallUpdatesResponder(resp *http.Response) (result autorest.Response, err error)

InstallUpdatesResponder handles the response to the InstallUpdates request. The method always closes the http.Response Body.

func (DevicesClient) InstallUpdatesSender ¶

func (client DevicesClient) InstallUpdatesSender(req *http.Request) (future DevicesInstallUpdatesFuture, err error)

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

func (DevicesClient) ListByResourceGroup ¶

func (client DevicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string) (result DeviceListPage, err error)

ListByResourceGroup gets all the Data Box Edge/Data Box Gateway devices in a resource group. Parameters: resourceGroupName - the resource group name. expand - specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.

func (DevicesClient) ListByResourceGroupComplete ¶

func (client DevicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand string) (result DeviceListIterator, err error)

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

func (DevicesClient) ListByResourceGroupPreparer ¶

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DevicesClient) ListByResourceGroupResponder ¶

func (client DevicesClient) ListByResourceGroupResponder(resp *http.Response) (result DeviceList, err error)

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

func (DevicesClient) ListByResourceGroupSender ¶

func (client DevicesClient) 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 (DevicesClient) ListBySubscription ¶

func (client DevicesClient) ListBySubscription(ctx context.Context, expand string) (result DeviceListPage, err error)

ListBySubscription gets all the Data Box Edge/Data Box Gateway devices in a subscription. Parameters: expand - specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.

func (DevicesClient) ListBySubscriptionComplete ¶

func (client DevicesClient) ListBySubscriptionComplete(ctx context.Context, expand string) (result DeviceListIterator, err error)

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

func (DevicesClient) ListBySubscriptionPreparer ¶

func (client DevicesClient) ListBySubscriptionPreparer(ctx context.Context, expand string) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (DevicesClient) ListBySubscriptionResponder ¶

func (client DevicesClient) ListBySubscriptionResponder(resp *http.Response) (result DeviceList, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (DevicesClient) ListBySubscriptionSender ¶

func (client DevicesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ScanForUpdates ¶

func (client DevicesClient) ScanForUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result DevicesScanForUpdatesFuture, err error)

ScanForUpdates sends the scan for updates request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) ScanForUpdatesPreparer ¶

func (client DevicesClient) ScanForUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ScanForUpdatesPreparer prepares the ScanForUpdates request.

func (DevicesClient) ScanForUpdatesResponder ¶

func (client DevicesClient) ScanForUpdatesResponder(resp *http.Response) (result autorest.Response, err error)

ScanForUpdatesResponder handles the response to the ScanForUpdates request. The method always closes the http.Response Body.

func (DevicesClient) ScanForUpdatesSender ¶

func (client DevicesClient) ScanForUpdatesSender(req *http.Request) (future DevicesScanForUpdatesFuture, err error)

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

func (DevicesClient) Update ¶

func (client DevicesClient) Update(ctx context.Context, deviceName string, parameters DevicePatch, resourceGroupName string) (result Device, err error)

Update modifies a Data Box Edge/Data Box Gateway resource. Parameters: deviceName - the device name. parameters - the resource parameters. resourceGroupName - the resource group name.

func (DevicesClient) UpdatePreparer ¶

func (client DevicesClient) UpdatePreparer(ctx context.Context, deviceName string, parameters DevicePatch, resourceGroupName string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DevicesClient) UpdateResponder ¶

func (client DevicesClient) UpdateResponder(resp *http.Response) (result Device, err error)

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

func (DevicesClient) UpdateSender ¶

func (client DevicesClient) UpdateSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UploadCertificate ¶

func (client DevicesClient) UploadCertificate(ctx context.Context, deviceName string, parameters UploadCertificateRequest, resourceGroupName string) (result UploadCertificateResponse, err error)

UploadCertificate uploads registration certificate for the device. Parameters: deviceName - the device name. parameters - the upload certificate request. resourceGroupName - the resource group name.

func (DevicesClient) UploadCertificatePreparer ¶

func (client DevicesClient) UploadCertificatePreparer(ctx context.Context, deviceName string, parameters UploadCertificateRequest, resourceGroupName string) (*http.Request, error)

UploadCertificatePreparer prepares the UploadCertificate request.

func (DevicesClient) UploadCertificateResponder ¶

func (client DevicesClient) UploadCertificateResponder(resp *http.Response) (result UploadCertificateResponse, err error)

UploadCertificateResponder handles the response to the UploadCertificate request. The method always closes the http.Response Body.

func (DevicesClient) UploadCertificateSender ¶

func (client DevicesClient) UploadCertificateSender(req *http.Request) (*http.Response, error)

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

type DevicesCreateOrUpdateFuture ¶

type DevicesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*DevicesCreateOrUpdateFuture) Result ¶

func (future *DevicesCreateOrUpdateFuture) Result(client DevicesClient) (d Device, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DevicesCreateOrUpdateSecuritySettingsFuture ¶

type DevicesCreateOrUpdateSecuritySettingsFuture struct {
	azure.Future
}

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

func (*DevicesCreateOrUpdateSecuritySettingsFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DevicesDeleteFuture ¶

type DevicesDeleteFuture struct {
	azure.Future
}

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

func (*DevicesDeleteFuture) Result ¶

func (future *DevicesDeleteFuture) Result(client DevicesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DevicesDownloadUpdatesFuture ¶

type DevicesDownloadUpdatesFuture struct {
	azure.Future
}

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

func (*DevicesDownloadUpdatesFuture) Result ¶

func (future *DevicesDownloadUpdatesFuture) Result(client DevicesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DevicesInstallUpdatesFuture ¶

type DevicesInstallUpdatesFuture struct {
	azure.Future
}

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

func (*DevicesInstallUpdatesFuture) Result ¶

func (future *DevicesInstallUpdatesFuture) Result(client DevicesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DevicesScanForUpdatesFuture ¶

type DevicesScanForUpdatesFuture struct {
	azure.Future
}

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

func (*DevicesScanForUpdatesFuture) Result ¶

func (future *DevicesScanForUpdatesFuture) Result(client DevicesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DownloadPhase ¶

type DownloadPhase string

DownloadPhase enumerates the values for download phase.

const (
	// DownloadPhaseDownloading ...
	DownloadPhaseDownloading DownloadPhase = "Downloading"
	// DownloadPhaseInitializing ...
	DownloadPhaseInitializing DownloadPhase = "Initializing"
	// DownloadPhaseUnknown ...
	DownloadPhaseUnknown DownloadPhase = "Unknown"
	// DownloadPhaseVerifying ...
	DownloadPhaseVerifying DownloadPhase = "Verifying"
)

func PossibleDownloadPhaseValues ¶

func PossibleDownloadPhaseValues() []DownloadPhase

PossibleDownloadPhaseValues returns an array of possible values for the DownloadPhase const type.

type EncryptionAlgorithm ¶

type EncryptionAlgorithm string

EncryptionAlgorithm enumerates the values for encryption algorithm.

const (
	// AES256 ...
	AES256 EncryptionAlgorithm = "AES256"
	// None ...
	None EncryptionAlgorithm = "None"
	// RSAESPKCS1V15 ...
	RSAESPKCS1V15 EncryptionAlgorithm = "RSAES_PKCS1_v_1_5"
)

func PossibleEncryptionAlgorithmValues ¶

func PossibleEncryptionAlgorithmValues() []EncryptionAlgorithm

PossibleEncryptionAlgorithmValues returns an array of possible values for the EncryptionAlgorithm const type.

type FileEventTrigger ¶

type FileEventTrigger struct {
	// FileTriggerProperties - File trigger properties.
	*FileTriggerProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
	// Kind - Possible values include: 'KindTrigger', 'KindFileEvent', 'KindPeriodicTimerEvent'
	Kind KindBasicTrigger `json:"kind,omitempty"`
}

FileEventTrigger trigger details.

func (FileEventTrigger) AsBasicTrigger ¶

func (fet FileEventTrigger) AsBasicTrigger() (BasicTrigger, bool)

AsBasicTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsFileEventTrigger ¶

func (fet FileEventTrigger) AsFileEventTrigger() (*FileEventTrigger, bool)

AsFileEventTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsPeriodicTimerEventTrigger ¶

func (fet FileEventTrigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsTrigger ¶

func (fet FileEventTrigger) AsTrigger() (*Trigger, bool)

AsTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) MarshalJSON ¶

func (fet FileEventTrigger) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileEventTrigger.

func (*FileEventTrigger) UnmarshalJSON ¶

func (fet *FileEventTrigger) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileEventTrigger struct.

type FileSourceInfo ¶

type FileSourceInfo struct {
	// ShareID - File share ID.
	ShareID *string `json:"shareId,omitempty"`
}

FileSourceInfo file source details.

type FileTriggerProperties ¶

type FileTriggerProperties struct {
	// SourceInfo - File event source details.
	SourceInfo *FileSourceInfo `json:"sourceInfo,omitempty"`
	// SinkInfo - Role sink info.
	SinkInfo *RoleSinkInfo `json:"sinkInfo,omitempty"`
	// CustomContextTag - A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.
	CustomContextTag *string `json:"customContextTag,omitempty"`
}

FileTriggerProperties file trigger properties.

type InstallRebootBehavior ¶

type InstallRebootBehavior string

InstallRebootBehavior enumerates the values for install reboot behavior.

const (
	// NeverReboots ...
	NeverReboots InstallRebootBehavior = "NeverReboots"
	// RequestReboot ...
	RequestReboot InstallRebootBehavior = "RequestReboot"
	// RequiresReboot ...
	RequiresReboot InstallRebootBehavior = "RequiresReboot"
)

func PossibleInstallRebootBehaviorValues ¶

func PossibleInstallRebootBehaviorValues() []InstallRebootBehavior

PossibleInstallRebootBehaviorValues returns an array of possible values for the InstallRebootBehavior const type.

type IoTDeviceInfo ¶

type IoTDeviceInfo struct {
	// DeviceID - ID of the IoT device/edge device.
	DeviceID *string `json:"deviceId,omitempty"`
	// IoTHostHub - Host name for the IoT hub associated to the device.
	IoTHostHub *string `json:"ioTHostHub,omitempty"`
	// IoTHostHubID - Id for the IoT hub associated to the device.
	IoTHostHubID *string `json:"ioTHostHubId,omitempty"`
	// Authentication - IoT device authentication info.
	Authentication *Authentication `json:"authentication,omitempty"`
}

IoTDeviceInfo metadata of IoT device/IoT Edge device to be configured.

type IoTRole ¶

type IoTRole struct {
	// IoTRoleProperties - Properties specific to IoT role.
	*IoTRoleProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
	// Kind - Possible values include: 'KindRole', 'KindIOT'
	Kind Kind `json:"kind,omitempty"`
}

IoTRole compute role.

func (IoTRole) AsBasicRole ¶

func (itr IoTRole) AsBasicRole() (BasicRole, bool)

AsBasicRole is the BasicRole implementation for IoTRole.

func (IoTRole) AsIoTRole ¶

func (itr IoTRole) AsIoTRole() (*IoTRole, bool)

AsIoTRole is the BasicRole implementation for IoTRole.

func (IoTRole) AsRole ¶

func (itr IoTRole) AsRole() (*Role, bool)

AsRole is the BasicRole implementation for IoTRole.

func (IoTRole) MarshalJSON ¶

func (itr IoTRole) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IoTRole.

func (*IoTRole) UnmarshalJSON ¶

func (itr *IoTRole) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IoTRole struct.

type IoTRoleProperties ¶

type IoTRoleProperties struct {
	// HostPlatform - Host OS supported by the IoT role. Possible values include: 'Windows', 'Linux'
	HostPlatform PlatformType `json:"hostPlatform,omitempty"`
	// IoTDeviceDetails - IoT device metadata to which data box edge device needs to be connected.
	IoTDeviceDetails *IoTDeviceInfo `json:"ioTDeviceDetails,omitempty"`
	// IoTEdgeDeviceDetails - IoT edge device to which the IoT role needs to be configured.
	IoTEdgeDeviceDetails *IoTDeviceInfo `json:"ioTEdgeDeviceDetails,omitempty"`
	// ShareMappings - Mount points of shares in role(s).
	ShareMappings *[]MountPointMap `json:"shareMappings,omitempty"`
	// RoleStatus - Role status. Possible values include: 'RoleStatusEnabled', 'RoleStatusDisabled'
	RoleStatus RoleStatus `json:"roleStatus,omitempty"`
}

IoTRoleProperties ioT role properties.

type Ipv4Config ¶

type Ipv4Config struct {
	// IPAddress - READ-ONLY; The IPv4 address of the network adapter.
	IPAddress *string `json:"ipAddress,omitempty"`
	// Subnet - READ-ONLY; The IPv4 subnet of the network adapter.
	Subnet *string `json:"subnet,omitempty"`
	// Gateway - READ-ONLY; The IPv4 gateway of the network adapter.
	Gateway *string `json:"gateway,omitempty"`
}

Ipv4Config details related to the IPv4 address configuration.

type Ipv6Config ¶

type Ipv6Config struct {
	// IPAddress - READ-ONLY; The IPv6 address of the network adapter.
	IPAddress *string `json:"ipAddress,omitempty"`
	// PrefixLength - READ-ONLY; The IPv6 prefix of the network adapter.
	PrefixLength *int32 `json:"prefixLength,omitempty"`
	// Gateway - READ-ONLY; The IPv6 gateway of the network adapter.
	Gateway *string `json:"gateway,omitempty"`
}

Ipv6Config details related to the IPv6 address configuration.

type Job ¶

type Job struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the object.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
	// Status - READ-ONLY; The current status of the job. Possible values include: 'JobStatusInvalid', 'JobStatusRunning', 'JobStatusSucceeded', 'JobStatusFailed', 'JobStatusCanceled', 'JobStatusPaused', 'JobStatusScheduled'
	Status JobStatus `json:"status,omitempty"`
	// StartTime - READ-ONLY; The UTC date and time at which the job started.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; The UTC date and time at which the job completed.
	EndTime *date.Time `json:"endTime,omitempty"`
	// PercentComplete - READ-ONLY; The percentage of the job that is complete.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// Error - READ-ONLY; The error details.
	Error *JobErrorDetails `json:"error,omitempty"`
	// JobProperties - READ-ONLY; The properties of the job.
	*JobProperties `json:"properties,omitempty"`
}

Job a device job.

func (Job) MarshalJSON ¶

func (j Job) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Job.

func (*Job) UnmarshalJSON ¶

func (j *Job) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Job struct.

type JobErrorDetails ¶

type JobErrorDetails struct {
	// ErrorDetails - READ-ONLY; The error details.
	ErrorDetails *[]JobErrorItem `json:"errorDetails,omitempty"`
	// Code - READ-ONLY; The code intended for programmatic access.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The message that describes the error in detail.
	Message *string `json:"message,omitempty"`
}

JobErrorDetails the job error information containing the list of job errors.

type JobErrorItem ¶

type JobErrorItem struct {
	// Recommendations - READ-ONLY; The recommended actions.
	Recommendations *[]string `json:"recommendations,omitempty"`
	// Code - READ-ONLY; The code intended for programmatic access.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The message that describes the error in detail.
	Message *string `json:"message,omitempty"`
}

JobErrorItem the job error items.

type JobProperties ¶

type JobProperties struct {
	// JobType - READ-ONLY; The type of the job. Possible values include: 'JobTypeInvalid', 'JobTypeScanForUpdates', 'JobTypeDownloadUpdates', 'JobTypeInstallUpdates', 'JobTypeRefreshShare', 'JobTypeRefreshContainer'
	JobType JobType `json:"jobType,omitempty"`
	// CurrentStage - READ-ONLY; Current stage of the update operation. Possible values include: 'UpdateOperationStageUnknown', 'UpdateOperationStageInitial', 'UpdateOperationStageScanStarted', 'UpdateOperationStageScanComplete', 'UpdateOperationStageScanFailed', 'UpdateOperationStageDownloadStarted', 'UpdateOperationStageDownloadComplete', 'UpdateOperationStageDownloadFailed', 'UpdateOperationStageInstallStarted', 'UpdateOperationStageInstallComplete', 'UpdateOperationStageInstallFailed', 'UpdateOperationStageRebootInitiated', 'UpdateOperationStageSuccess', 'UpdateOperationStageFailure', 'UpdateOperationStageRescanStarted', 'UpdateOperationStageRescanComplete', 'UpdateOperationStageRescanFailed'
	CurrentStage UpdateOperationStage `json:"currentStage,omitempty"`
	// DownloadProgress - READ-ONLY; The download progress.
	DownloadProgress *UpdateDownloadProgress `json:"downloadProgress,omitempty"`
	// InstallProgress - READ-ONLY; The install progress.
	InstallProgress *UpdateInstallProgress `json:"installProgress,omitempty"`
	// TotalRefreshErrors - READ-ONLY; Total number of errors encountered during the refresh process.
	TotalRefreshErrors *int32 `json:"totalRefreshErrors,omitempty"`
	// ErrorManifestFile - READ-ONLY; Local share/remote container relative path to the error manifest file of the refresh.
	ErrorManifestFile *string `json:"errorManifestFile,omitempty"`
	// RefreshedEntityID - READ-ONLY; ARM ID of the entity that was refreshed.
	RefreshedEntityID *string `json:"refreshedEntityId,omitempty"`
	// Folder - If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)
	Folder *string `json:"folder,omitempty"`
}

JobProperties the properties for the job.

func (JobProperties) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for JobProperties.

type JobStatus ¶

type JobStatus string

JobStatus enumerates the values for job status.

const (
	// JobStatusCanceled ...
	JobStatusCanceled JobStatus = "Canceled"
	// JobStatusFailed ...
	JobStatusFailed JobStatus = "Failed"
	// JobStatusInvalid ...
	JobStatusInvalid JobStatus = "Invalid"
	// JobStatusPaused ...
	JobStatusPaused JobStatus = "Paused"
	// JobStatusRunning ...
	JobStatusRunning JobStatus = "Running"
	// JobStatusScheduled ...
	JobStatusScheduled JobStatus = "Scheduled"
	// JobStatusSucceeded ...
	JobStatusSucceeded JobStatus = "Succeeded"
)

func PossibleJobStatusValues ¶

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns an array of possible values for the JobStatus const type.

type JobType ¶

type JobType string

JobType enumerates the values for job type.

const (
	// JobTypeDownloadUpdates ...
	JobTypeDownloadUpdates JobType = "DownloadUpdates"
	// JobTypeInstallUpdates ...
	JobTypeInstallUpdates JobType = "InstallUpdates"
	// JobTypeInvalid ...
	JobTypeInvalid JobType = "Invalid"
	// JobTypeRefreshContainer ...
	JobTypeRefreshContainer JobType = "RefreshContainer"
	// JobTypeRefreshShare ...
	JobTypeRefreshShare JobType = "RefreshShare"
	// JobTypeScanForUpdates ...
	JobTypeScanForUpdates JobType = "ScanForUpdates"
)

func PossibleJobTypeValues ¶

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns an array of possible values for the JobType const type.

type JobsClient ¶

type JobsClient struct {
	BaseClient
}

JobsClient is the client for the Jobs methods of the Databoxedge 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) Get ¶

func (client JobsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result Job, err error)

Get sends the get request. Parameters: deviceName - the device name. name - the job name. resourceGroupName - the resource group name.

func (JobsClient) GetPreparer ¶

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder ¶

func (client JobsClient) GetResponder(resp *http.Response) (result Job, 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.

type Kind ¶

type Kind string

Kind enumerates the values for kind.

const (
	// KindIOT ...
	KindIOT Kind = "IOT"
	// KindRole ...
	KindRole Kind = "Role"
)

func PossibleKindValues ¶

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type KindBasicTrigger ¶

type KindBasicTrigger string

KindBasicTrigger enumerates the values for kind basic trigger.

const (
	// KindFileEvent ...
	KindFileEvent KindBasicTrigger = "FileEvent"
	// KindPeriodicTimerEvent ...
	KindPeriodicTimerEvent KindBasicTrigger = "PeriodicTimerEvent"
	// KindTrigger ...
	KindTrigger KindBasicTrigger = "Trigger"
)

func PossibleKindBasicTriggerValues ¶

func PossibleKindBasicTriggerValues() []KindBasicTrigger

PossibleKindBasicTriggerValues returns an array of possible values for the KindBasicTrigger const type.

type MetricAggregationType ¶

type MetricAggregationType string

MetricAggregationType enumerates the values for metric aggregation type.

const (
	// MetricAggregationTypeAverage ...
	MetricAggregationTypeAverage MetricAggregationType = "Average"
	// MetricAggregationTypeCount ...
	MetricAggregationTypeCount MetricAggregationType = "Count"
	// MetricAggregationTypeMaximum ...
	MetricAggregationTypeMaximum MetricAggregationType = "Maximum"
	// MetricAggregationTypeMinimum ...
	MetricAggregationTypeMinimum MetricAggregationType = "Minimum"
	// MetricAggregationTypeNone ...
	MetricAggregationTypeNone MetricAggregationType = "None"
	// MetricAggregationTypeNotSpecified ...
	MetricAggregationTypeNotSpecified MetricAggregationType = "NotSpecified"
	// MetricAggregationTypeTotal ...
	MetricAggregationTypeTotal MetricAggregationType = "Total"
)

func PossibleMetricAggregationTypeValues ¶

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns an array of possible values for the MetricAggregationType const type.

type MetricCategory ¶

type MetricCategory string

MetricCategory enumerates the values for metric category.

const (
	// Capacity ...
	Capacity MetricCategory = "Capacity"
	// Transaction ...
	Transaction MetricCategory = "Transaction"
)

func PossibleMetricCategoryValues ¶

func PossibleMetricCategoryValues() []MetricCategory

PossibleMetricCategoryValues returns an array of possible values for the MetricCategory const type.

type MetricDimensionV1 ¶

type MetricDimensionV1 struct {
	// Name - Name of the metrics dimension.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of the metrics dimension.
	DisplayName *string `json:"displayName,omitempty"`
	// ToBeExportedForShoebox - To be exported to shoe box.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

MetricDimensionV1 metric Dimension v1.

type MetricSpecificationV1 ¶

type MetricSpecificationV1 struct {
	// Name - Name of the metric.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of the metric.
	DisplayName *string `json:"displayName,omitempty"`
	// DisplayDescription - Description of the metric to be displayed.
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// Unit - Metric units. Possible values include: 'NotSpecified', 'Percent', 'Count', 'Seconds', 'Milliseconds', 'Bytes', 'BytesPerSecond', 'CountPerSecond'
	Unit MetricUnit `json:"unit,omitempty"`
	// AggregationType - Metric aggregation type. Possible values include: 'MetricAggregationTypeNotSpecified', 'MetricAggregationTypeNone', 'MetricAggregationTypeAverage', 'MetricAggregationTypeMinimum', 'MetricAggregationTypeMaximum', 'MetricAggregationTypeTotal', 'MetricAggregationTypeCount'
	AggregationType MetricAggregationType `json:"aggregationType,omitempty"`
	// Dimensions - Metric dimensions, other than default dimension which is resource.
	Dimensions *[]MetricDimensionV1 `json:"dimensions,omitempty"`
	// FillGapWithZero - Set true to fill the gaps with zero.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`
	// Category - Metric category. Possible values include: 'Capacity', 'Transaction'
	Category MetricCategory `json:"category,omitempty"`
	// ResourceIDDimensionNameOverride - Resource name override.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`
	// SupportedTimeGrainTypes - Support granularity of metrics.
	SupportedTimeGrainTypes *[]TimeGrain `json:"supportedTimeGrainTypes,omitempty"`
	// SupportedAggregationTypes - Support metric aggregation type.
	SupportedAggregationTypes *[]MetricAggregationType `json:"supportedAggregationTypes,omitempty"`
}

MetricSpecificationV1 metric specification version 1.

type MetricUnit ¶

type MetricUnit string

MetricUnit enumerates the values for metric unit.

const (
	// Bytes ...
	Bytes MetricUnit = "Bytes"
	// BytesPerSecond ...
	BytesPerSecond MetricUnit = "BytesPerSecond"
	// Count ...
	Count MetricUnit = "Count"
	// CountPerSecond ...
	CountPerSecond MetricUnit = "CountPerSecond"
	// Milliseconds ...
	Milliseconds MetricUnit = "Milliseconds"
	// NotSpecified ...
	NotSpecified MetricUnit = "NotSpecified"
	// Percent ...
	Percent MetricUnit = "Percent"
	// Seconds ...
	Seconds MetricUnit = "Seconds"
)

func PossibleMetricUnitValues ¶

func PossibleMetricUnitValues() []MetricUnit

PossibleMetricUnitValues returns an array of possible values for the MetricUnit const type.

type MonitoringStatus ¶

type MonitoringStatus string

MonitoringStatus enumerates the values for monitoring status.

const (
	// Disabled ...
	Disabled MonitoringStatus = "Disabled"
	// Enabled ...
	Enabled MonitoringStatus = "Enabled"
)

func PossibleMonitoringStatusValues ¶

func PossibleMonitoringStatusValues() []MonitoringStatus

PossibleMonitoringStatusValues returns an array of possible values for the MonitoringStatus const type.

type MountPointMap ¶

type MountPointMap struct {
	// ShareID - ID of the share mounted to the role VM.
	ShareID *string `json:"shareId,omitempty"`
	// RoleID - READ-ONLY; ID of the role to which share is mounted.
	RoleID *string `json:"roleId,omitempty"`
	// MountPoint - READ-ONLY; Mount point for the share.
	MountPoint *string `json:"mountPoint,omitempty"`
	// RoleType - READ-ONLY; Role type. Possible values include: 'IOT', 'ASA', 'Functions', 'Cognitive'
	RoleType RoleTypes `json:"roleType,omitempty"`
}

MountPointMap the share mount point.

func (MountPointMap) MarshalJSON ¶

func (mpm MountPointMap) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MountPointMap.

type NetworkAdapter ¶

type NetworkAdapter struct {
	// AdapterID - READ-ONLY; Instance ID of network adapter.
	AdapterID *string `json:"adapterId,omitempty"`
	// AdapterPosition - READ-ONLY; Hardware position of network adapter.
	AdapterPosition *NetworkAdapterPosition `json:"adapterPosition,omitempty"`
	// Index - READ-ONLY; Logical index of the adapter.
	Index *int32 `json:"index,omitempty"`
	// NodeID - READ-ONLY; Node ID of the network adapter.
	NodeID *string `json:"nodeId,omitempty"`
	// NetworkAdapterName - READ-ONLY; Network adapter name.
	NetworkAdapterName *string `json:"networkAdapterName,omitempty"`
	// Label - READ-ONLY; Hardware label for the adapter.
	Label *string `json:"label,omitempty"`
	// MacAddress - READ-ONLY; MAC address.
	MacAddress *string `json:"macAddress,omitempty"`
	// LinkSpeed - READ-ONLY; Link speed.
	LinkSpeed *int64 `json:"linkSpeed,omitempty"`
	// Status - READ-ONLY; Value indicating whether this adapter is valid. Possible values include: 'Inactive', 'Active'
	Status NetworkAdapterStatus `json:"status,omitempty"`
	// RdmaStatus - Value indicating whether this adapter is RDMA capable. Possible values include: 'Incapable', 'Capable'
	RdmaStatus NetworkAdapterRDMAStatus `json:"rdmaStatus,omitempty"`
	// DhcpStatus - Value indicating whether this adapter has DHCP enabled. Possible values include: 'NetworkAdapterDHCPStatusDisabled', 'NetworkAdapterDHCPStatusEnabled'
	DhcpStatus NetworkAdapterDHCPStatus `json:"dhcpStatus,omitempty"`
	// Ipv4Configuration - READ-ONLY; The IPv4 configuration of the network adapter.
	Ipv4Configuration *Ipv4Config `json:"ipv4Configuration,omitempty"`
	// Ipv6Configuration - READ-ONLY; The IPv6 configuration of the network adapter.
	Ipv6Configuration *Ipv6Config `json:"ipv6Configuration,omitempty"`
	// Ipv6LinkLocalAddress - READ-ONLY; The IPv6 local address.
	Ipv6LinkLocalAddress *string `json:"ipv6LinkLocalAddress,omitempty"`
	// DNSServers - READ-ONLY; The list of DNS Servers of the device.
	DNSServers *[]string `json:"dnsServers,omitempty"`
}

NetworkAdapter represents the networkAdapter on a device.

func (NetworkAdapter) MarshalJSON ¶

func (na NetworkAdapter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NetworkAdapter.

type NetworkAdapterDHCPStatus ¶

type NetworkAdapterDHCPStatus string

NetworkAdapterDHCPStatus enumerates the values for network adapter dhcp status.

const (
	// NetworkAdapterDHCPStatusDisabled ...
	NetworkAdapterDHCPStatusDisabled NetworkAdapterDHCPStatus = "Disabled"
	// NetworkAdapterDHCPStatusEnabled ...
	NetworkAdapterDHCPStatusEnabled NetworkAdapterDHCPStatus = "Enabled"
)

func PossibleNetworkAdapterDHCPStatusValues ¶

func PossibleNetworkAdapterDHCPStatusValues() []NetworkAdapterDHCPStatus

PossibleNetworkAdapterDHCPStatusValues returns an array of possible values for the NetworkAdapterDHCPStatus const type.

type NetworkAdapterPosition ¶

type NetworkAdapterPosition struct {
	// NetworkGroup - READ-ONLY; The network group. Possible values include: 'NetworkGroupNone', 'NetworkGroupNonRDMA', 'NetworkGroupRDMA'
	NetworkGroup NetworkGroup `json:"networkGroup,omitempty"`
	// Port - READ-ONLY; The port.
	Port *int32 `json:"port,omitempty"`
}

NetworkAdapterPosition the network adapter position.

type NetworkAdapterRDMAStatus ¶

type NetworkAdapterRDMAStatus string

NetworkAdapterRDMAStatus enumerates the values for network adapter rdma status.

const (
	// Capable ...
	Capable NetworkAdapterRDMAStatus = "Capable"
	// Incapable ...
	Incapable NetworkAdapterRDMAStatus = "Incapable"
)

func PossibleNetworkAdapterRDMAStatusValues ¶

func PossibleNetworkAdapterRDMAStatusValues() []NetworkAdapterRDMAStatus

PossibleNetworkAdapterRDMAStatusValues returns an array of possible values for the NetworkAdapterRDMAStatus const type.

type NetworkAdapterStatus ¶

type NetworkAdapterStatus string

NetworkAdapterStatus enumerates the values for network adapter status.

const (
	// Active ...
	Active NetworkAdapterStatus = "Active"
	// Inactive ...
	Inactive NetworkAdapterStatus = "Inactive"
)

func PossibleNetworkAdapterStatusValues ¶

func PossibleNetworkAdapterStatusValues() []NetworkAdapterStatus

PossibleNetworkAdapterStatusValues returns an array of possible values for the NetworkAdapterStatus const type.

type NetworkGroup ¶

type NetworkGroup string

NetworkGroup enumerates the values for network group.

const (
	// NetworkGroupNone ...
	NetworkGroupNone NetworkGroup = "None"
	// NetworkGroupNonRDMA ...
	NetworkGroupNonRDMA NetworkGroup = "NonRDMA"
	// NetworkGroupRDMA ...
	NetworkGroupRDMA NetworkGroup = "RDMA"
)

func PossibleNetworkGroupValues ¶

func PossibleNetworkGroupValues() []NetworkGroup

PossibleNetworkGroupValues returns an array of possible values for the NetworkGroup const type.

type NetworkSettings ¶

type NetworkSettings struct {
	autorest.Response `json:"-"`
	// NetworkSettingsProperties - READ-ONLY; The properties of network settings of a device.
	*NetworkSettingsProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

NetworkSettings the network settings of a device.

func (NetworkSettings) MarshalJSON ¶

func (ns NetworkSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NetworkSettings.

func (*NetworkSettings) UnmarshalJSON ¶

func (ns *NetworkSettings) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NetworkSettings struct.

type NetworkSettingsProperties ¶

type NetworkSettingsProperties struct {
	// NetworkAdapters - READ-ONLY; The network adapter list on the device.
	NetworkAdapters *[]NetworkAdapter `json:"networkAdapters,omitempty"`
}

NetworkSettingsProperties the properties of network settings.

type Node ¶

type Node struct {
	// NodeProperties - READ-ONLY; The properties of the node
	*NodeProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Node represents a single node in a Data box Edge/Gateway device Gateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node Multi-node Edge devices will have more than 1 nodes

func (Node) MarshalJSON ¶

func (n Node) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Node.

func (*Node) UnmarshalJSON ¶

func (n *Node) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Node struct.

type NodeList ¶

type NodeList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of Nodes.
	Value *[]Node `json:"value,omitempty"`
}

NodeList collection of Nodes.

type NodeProperties ¶

type NodeProperties struct {
	// NodeStatus - READ-ONLY; The current status of the individual node. Possible values include: 'NodeStatusUnknown', 'NodeStatusUp', 'NodeStatusDown', 'NodeStatusRebooting', 'NodeStatusShuttingDown'
	NodeStatus NodeStatus `json:"nodeStatus,omitempty"`
	// NodeChassisSerialNumber - READ-ONLY; Serial number of the Chassis
	NodeChassisSerialNumber *string `json:"nodeChassisSerialNumber,omitempty"`
	// NodeSerialNumber - READ-ONLY; Serial number of the individual node
	NodeSerialNumber *string `json:"nodeSerialNumber,omitempty"`
	// NodeDisplayName - READ-ONLY; Display Name of the individual node
	NodeDisplayName *string `json:"nodeDisplayName,omitempty"`
	// NodeFriendlySoftwareVersion - READ-ONLY; Friendly software version name that is currently installed on the node
	NodeFriendlySoftwareVersion *string `json:"nodeFriendlySoftwareVersion,omitempty"`
	// NodeHcsVersion - READ-ONLY; HCS version that is currently installed on the node
	NodeHcsVersion *string `json:"nodeHcsVersion,omitempty"`
	// NodeInstanceID - READ-ONLY; Guid instance id of the node
	NodeInstanceID *string `json:"nodeInstanceId,omitempty"`
}

NodeProperties this class represents the nodes in a highly available cluster

type NodeStatus ¶

type NodeStatus string

NodeStatus enumerates the values for node status.

const (
	// NodeStatusDown ...
	NodeStatusDown NodeStatus = "Down"
	// NodeStatusRebooting ...
	NodeStatusRebooting NodeStatus = "Rebooting"
	// NodeStatusShuttingDown ...
	NodeStatusShuttingDown NodeStatus = "ShuttingDown"
	// NodeStatusUnknown ...
	NodeStatusUnknown NodeStatus = "Unknown"
	// NodeStatusUp ...
	NodeStatusUp NodeStatus = "Up"
)

func PossibleNodeStatusValues ¶

func PossibleNodeStatusValues() []NodeStatus

PossibleNodeStatusValues returns an array of possible values for the NodeStatus const type.

type NodesClient ¶

type NodesClient struct {
	BaseClient
}

NodesClient is the client for the Nodes methods of the Databoxedge service.

func NewNodesClient ¶

func NewNodesClient(subscriptionID string) NodesClient

NewNodesClient creates an instance of the NodesClient client.

func NewNodesClientWithBaseURI ¶

func NewNodesClientWithBaseURI(baseURI string, subscriptionID string) NodesClient

NewNodesClientWithBaseURI creates an instance of the NodesClient 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 (NodesClient) ListByDataBoxEdgeDevice ¶

func (client NodesClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result NodeList, err error)

ListByDataBoxEdgeDevice gets all the nodes currently configured under this Data Box Edge device Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (NodesClient) ListByDataBoxEdgeDevicePreparer ¶

func (client NodesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (NodesClient) ListByDataBoxEdgeDeviceResponder ¶

func (client NodesClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result NodeList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (NodesClient) ListByDataBoxEdgeDeviceSender ¶

func (client NodesClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type Operation ¶

type Operation struct {
	// Name - Name of the operation.
	Name *string `json:"name,omitempty"`
	// Display - Properties displayed for the operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - Origin of the operation.
	Origin *string `json:"origin,omitempty"`
	// OperationProperties - Operation properties.
	*OperationProperties `json:"properties,omitempty"`
}

Operation operations.

func (Operation) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON ¶

func (o *Operation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay ¶

type OperationDisplay struct {
	// Provider - Provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - The type of resource in which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation to be performed on the resource.
	Operation *string `json:"operation,omitempty"`
	// Description - Description of the operation to be performed.
	Description *string `json:"description,omitempty"`
}

OperationDisplay operation display properties.

type OperationProperties ¶

type OperationProperties struct {
	// ServiceSpecification - Service specification.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties operation properties.

type OperationsClient ¶

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Databoxedge 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 OperationsListPage, err error)

List sends the list request.

func (OperationsClient) ListComplete ¶

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationsListIterator, 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 OperationsList, 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 OperationsList ¶

type OperationsList struct {
	autorest.Response `json:"-"`
	// Value - The value.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationsList the list of operations used for the discovery of available provider operations.

func (OperationsList) IsEmpty ¶

func (ol OperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListIterator ¶

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

OperationsListIterator provides access to a complete listing of Operation values.

func NewOperationsListIterator ¶

func NewOperationsListIterator(page OperationsListPage) OperationsListIterator

Creates a new instance of the OperationsListIterator type.

func (*OperationsListIterator) Next ¶

func (iter *OperationsListIterator) 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 (*OperationsListIterator) NextWithContext ¶

func (iter *OperationsListIterator) 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 (OperationsListIterator) NotDone ¶

func (iter OperationsListIterator) NotDone() bool

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

func (OperationsListIterator) Response ¶

func (iter OperationsListIterator) Response() OperationsList

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

func (OperationsListIterator) Value ¶

func (iter OperationsListIterator) Value() Operation

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

type OperationsListPage ¶

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

OperationsListPage contains a page of Operation values.

func NewOperationsListPage ¶

func NewOperationsListPage(cur OperationsList, getNextPage func(context.Context, OperationsList) (OperationsList, error)) OperationsListPage

Creates a new instance of the OperationsListPage type.

func (*OperationsListPage) Next ¶

func (page *OperationsListPage) 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 (*OperationsListPage) NextWithContext ¶

func (page *OperationsListPage) 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 (OperationsListPage) NotDone ¶

func (page OperationsListPage) NotDone() bool

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

func (OperationsListPage) Response ¶

func (page OperationsListPage) Response() OperationsList

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

func (OperationsListPage) Values ¶

func (page OperationsListPage) Values() []Operation

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

type OperationsStatusClient ¶

type OperationsStatusClient struct {
	BaseClient
}

OperationsStatusClient is the client for the OperationsStatus methods of the Databoxedge service.

func NewOperationsStatusClient ¶

func NewOperationsStatusClient(subscriptionID string) OperationsStatusClient

NewOperationsStatusClient creates an instance of the OperationsStatusClient client.

func NewOperationsStatusClientWithBaseURI ¶

func NewOperationsStatusClientWithBaseURI(baseURI string, subscriptionID string) OperationsStatusClient

NewOperationsStatusClientWithBaseURI creates an instance of the OperationsStatusClient 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 (OperationsStatusClient) Get ¶

func (client OperationsStatusClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result Job, err error)

Get sends the get request. Parameters: deviceName - the device name. name - the job name. resourceGroupName - the resource group name.

func (OperationsStatusClient) GetPreparer ¶

func (client OperationsStatusClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OperationsStatusClient) GetResponder ¶

func (client OperationsStatusClient) GetResponder(resp *http.Response) (result Job, err error)

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

func (OperationsStatusClient) GetSender ¶

func (client OperationsStatusClient) 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.

type Order ¶

type Order struct {
	autorest.Response `json:"-"`
	// OrderProperties - The order properties.
	*OrderProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Order the order details.

func (Order) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for Order.

func (*Order) UnmarshalJSON ¶

func (o *Order) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Order struct.

type OrderList ¶

type OrderList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of orders.
	Value *[]Order `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

OrderList list of order entities.

func (OrderList) IsEmpty ¶

func (ol OrderList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OrderListIterator ¶

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

OrderListIterator provides access to a complete listing of Order values.

func NewOrderListIterator ¶

func NewOrderListIterator(page OrderListPage) OrderListIterator

Creates a new instance of the OrderListIterator type.

func (*OrderListIterator) Next ¶

func (iter *OrderListIterator) 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 (*OrderListIterator) NextWithContext ¶

func (iter *OrderListIterator) 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 (OrderListIterator) NotDone ¶

func (iter OrderListIterator) NotDone() bool

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

func (OrderListIterator) Response ¶

func (iter OrderListIterator) Response() OrderList

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

func (OrderListIterator) Value ¶

func (iter OrderListIterator) Value() Order

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

type OrderListPage ¶

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

OrderListPage contains a page of Order values.

func NewOrderListPage ¶

func NewOrderListPage(cur OrderList, getNextPage func(context.Context, OrderList) (OrderList, error)) OrderListPage

Creates a new instance of the OrderListPage type.

func (*OrderListPage) Next ¶

func (page *OrderListPage) 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 (*OrderListPage) NextWithContext ¶

func (page *OrderListPage) 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 (OrderListPage) NotDone ¶

func (page OrderListPage) NotDone() bool

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

func (OrderListPage) Response ¶

func (page OrderListPage) Response() OrderList

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

func (OrderListPage) Values ¶

func (page OrderListPage) Values() []Order

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

type OrderProperties ¶

type OrderProperties struct {
	// ContactInformation - The contact details.
	ContactInformation *ContactDetails `json:"contactInformation,omitempty"`
	// ShippingAddress - The shipping address.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// CurrentStatus - Current status of the order.
	CurrentStatus *OrderStatus `json:"currentStatus,omitempty"`
	// OrderHistory - READ-ONLY; List of status changes in the order.
	OrderHistory *[]OrderStatus `json:"orderHistory,omitempty"`
	// SerialNumber - READ-ONLY; Serial number of the device.
	SerialNumber *string `json:"serialNumber,omitempty"`
	// DeliveryTrackingInfo - READ-ONLY; Tracking information for the package delivered to the customer whether it has an original or a replacement device.
	DeliveryTrackingInfo *[]TrackingInfo `json:"deliveryTrackingInfo,omitempty"`
	// ReturnTrackingInfo - READ-ONLY; Tracking information for the package returned from the customer whether it has an original or a replacement device.
	ReturnTrackingInfo *[]TrackingInfo `json:"returnTrackingInfo,omitempty"`
}

OrderProperties order properties.

func (OrderProperties) MarshalJSON ¶

func (op OrderProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderProperties.

type OrderState ¶

type OrderState string

OrderState enumerates the values for order state.

const (
	// Arriving ...
	Arriving OrderState = "Arriving"
	// AwaitingFulfilment ...
	AwaitingFulfilment OrderState = "AwaitingFulfilment"
	// AwaitingPreparation ...
	AwaitingPreparation OrderState = "AwaitingPreparation"
	// AwaitingReturnShipment ...
	AwaitingReturnShipment OrderState = "AwaitingReturnShipment"
	// AwaitingShipment ...
	AwaitingShipment OrderState = "AwaitingShipment"
	// CollectedAtMicrosoft ...
	CollectedAtMicrosoft OrderState = "CollectedAtMicrosoft"
	// Declined ...
	Declined OrderState = "Declined"
	// Delivered ...
	Delivered OrderState = "Delivered"
	// LostDevice ...
	LostDevice OrderState = "LostDevice"
	// ReplacementRequested ...
	ReplacementRequested OrderState = "ReplacementRequested"
	// ReturnInitiated ...
	ReturnInitiated OrderState = "ReturnInitiated"
	// Shipped ...
	Shipped OrderState = "Shipped"
	// ShippedBack ...
	ShippedBack OrderState = "ShippedBack"
	// Untracked ...
	Untracked OrderState = "Untracked"
)

func PossibleOrderStateValues ¶

func PossibleOrderStateValues() []OrderState

PossibleOrderStateValues returns an array of possible values for the OrderState const type.

type OrderStatus ¶

type OrderStatus struct {
	// Status - Status of the order as per the allowed status types. Possible values include: 'Untracked', 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', 'CollectedAtMicrosoft'
	Status OrderState `json:"status,omitempty"`
	// UpdateDateTime - READ-ONLY; Time of status update.
	UpdateDateTime *date.Time `json:"updateDateTime,omitempty"`
	// Comments - Comments related to this status change.
	Comments *string `json:"comments,omitempty"`
	// AdditionalOrderDetails - READ-ONLY; Dictionary to hold generic information which is not stored
	// by the already existing properties
	AdditionalOrderDetails map[string]*string `json:"additionalOrderDetails"`
}

OrderStatus represents a single status change.

func (OrderStatus) MarshalJSON ¶

func (osVar OrderStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OrderStatus.

type OrdersClient ¶

type OrdersClient struct {
	BaseClient
}

OrdersClient is the client for the Orders methods of the Databoxedge service.

func NewOrdersClient ¶

func NewOrdersClient(subscriptionID string) OrdersClient

NewOrdersClient creates an instance of the OrdersClient client.

func NewOrdersClientWithBaseURI ¶

func NewOrdersClientWithBaseURI(baseURI string, subscriptionID string) OrdersClient

NewOrdersClientWithBaseURI creates an instance of the OrdersClient 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 (OrdersClient) CreateOrUpdate ¶

func (client OrdersClient) CreateOrUpdate(ctx context.Context, deviceName string, order Order, resourceGroupName string) (result OrdersCreateOrUpdateFuture, err error)

CreateOrUpdate sends the create or update request. Parameters: deviceName - the order details of a device. order - the order to be created or updated. resourceGroupName - the resource group name.

func (OrdersClient) CreateOrUpdatePreparer ¶

func (client OrdersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, order Order, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OrdersClient) CreateOrUpdateResponder ¶

func (client OrdersClient) CreateOrUpdateResponder(resp *http.Response) (result Order, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (OrdersClient) CreateOrUpdateSender ¶

func (client OrdersClient) CreateOrUpdateSender(req *http.Request) (future OrdersCreateOrUpdateFuture, err error)

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

func (OrdersClient) Delete ¶

func (client OrdersClient) Delete(ctx context.Context, deviceName string, resourceGroupName string) (result OrdersDeleteFuture, err error)

Delete sends the delete request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (OrdersClient) DeletePreparer ¶

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

DeletePreparer prepares the Delete request.

func (OrdersClient) DeleteResponder ¶

func (client OrdersClient) 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 (OrdersClient) DeleteSender ¶

func (client OrdersClient) DeleteSender(req *http.Request) (future OrdersDeleteFuture, err error)

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

func (OrdersClient) Get ¶

func (client OrdersClient) Get(ctx context.Context, deviceName string, resourceGroupName string) (result Order, err error)

Get sends the get request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (OrdersClient) GetPreparer ¶

func (client OrdersClient) GetPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OrdersClient) GetResponder ¶

func (client OrdersClient) GetResponder(resp *http.Response) (result Order, err error)

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

func (OrdersClient) GetSender ¶

func (client OrdersClient) 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 (OrdersClient) ListByDataBoxEdgeDevice ¶

func (client OrdersClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result OrderListPage, err error)

ListByDataBoxEdgeDevice sends the list by data box edge device request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (OrdersClient) ListByDataBoxEdgeDeviceComplete ¶

func (client OrdersClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result OrderListIterator, err error)

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

func (OrdersClient) ListByDataBoxEdgeDevicePreparer ¶

func (client OrdersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (OrdersClient) ListByDataBoxEdgeDeviceResponder ¶

func (client OrdersClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result OrderList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (OrdersClient) ListByDataBoxEdgeDeviceSender ¶

func (client OrdersClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type OrdersCreateOrUpdateFuture ¶

type OrdersCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*OrdersCreateOrUpdateFuture) Result ¶

func (future *OrdersCreateOrUpdateFuture) Result(client OrdersClient) (o Order, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type OrdersDeleteFuture ¶

type OrdersDeleteFuture struct {
	azure.Future
}

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

func (*OrdersDeleteFuture) Result ¶

func (future *OrdersDeleteFuture) Result(client OrdersClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PeriodicTimerEventTrigger ¶

type PeriodicTimerEventTrigger struct {
	// PeriodicTimerProperties - Periodic timer trigger properties.
	*PeriodicTimerProperties `json:"properties,omitempty"`
	// Kind - Possible values include: 'KindTrigger', 'KindFileEvent', 'KindPeriodicTimerEvent'
	Kind KindBasicTrigger `json:"kind,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

PeriodicTimerEventTrigger trigger details.

func (PeriodicTimerEventTrigger) AsBasicTrigger ¶

func (ptet PeriodicTimerEventTrigger) AsBasicTrigger() (BasicTrigger, bool)

AsBasicTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsFileEventTrigger ¶

func (ptet PeriodicTimerEventTrigger) AsFileEventTrigger() (*FileEventTrigger, bool)

AsFileEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsPeriodicTimerEventTrigger ¶

func (ptet PeriodicTimerEventTrigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsTrigger ¶

func (ptet PeriodicTimerEventTrigger) AsTrigger() (*Trigger, bool)

AsTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) MarshalJSON ¶

func (ptet PeriodicTimerEventTrigger) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PeriodicTimerEventTrigger.

func (*PeriodicTimerEventTrigger) UnmarshalJSON ¶

func (ptet *PeriodicTimerEventTrigger) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PeriodicTimerEventTrigger struct.

type PeriodicTimerProperties ¶

type PeriodicTimerProperties struct {
	// SourceInfo - Periodic timer details.
	SourceInfo *PeriodicTimerSourceInfo `json:"sourceInfo,omitempty"`
	// SinkInfo - Role Sink information.
	SinkInfo *RoleSinkInfo `json:"sinkInfo,omitempty"`
	// CustomContextTag - A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.
	CustomContextTag *string `json:"customContextTag,omitempty"`
}

PeriodicTimerProperties periodic timer trigger properties.

type PeriodicTimerSourceInfo ¶

type PeriodicTimerSourceInfo struct {
	// StartTime - The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.
	StartTime *date.Time `json:"startTime,omitempty"`
	// Schedule - Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.
	Schedule *string `json:"schedule,omitempty"`
	// Topic - Topic where periodic events are published to IoT device.
	Topic *string `json:"topic,omitempty"`
}

PeriodicTimerSourceInfo periodic timer event source.

type PlatformType ¶

type PlatformType string

PlatformType enumerates the values for platform type.

const (
	// Linux ...
	Linux PlatformType = "Linux"
	// Windows ...
	Windows PlatformType = "Windows"
)

func PossiblePlatformTypeValues ¶

func PossiblePlatformTypeValues() []PlatformType

PossiblePlatformTypeValues returns an array of possible values for the PlatformType const type.

type RawCertificateData ¶

type RawCertificateData struct {
	// AuthenticationType - The authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Certificate - The base64 encoded certificate raw data.
	Certificate *string `json:"certificate,omitempty"`
}

RawCertificateData raw Certificate Data.

type RefreshDetails ¶

type RefreshDetails struct {
	// InProgressRefreshJobID - If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
	InProgressRefreshJobID *string `json:"inProgressRefreshJobId,omitempty"`
	// LastCompletedRefreshJobTimeInUTC - Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
	LastCompletedRefreshJobTimeInUTC *date.Time `json:"lastCompletedRefreshJobTimeInUTC,omitempty"`
	// ErrorManifestFile - Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
	ErrorManifestFile *string `json:"errorManifestFile,omitempty"`
	// LastJob - Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
	LastJob *string `json:"lastJob,omitempty"`
}

RefreshDetails fields for tracking refresh job on the share or container.

type ResourceTypeSku ¶

type ResourceTypeSku struct {
	// ResourceType - READ-ONLY; The type of the resource
	ResourceType *string `json:"resourceType,omitempty"`
	// Name - READ-ONLY; The Sku name. Possible values include: 'Gateway', 'Edge', 'TEA1Node', 'TEA1NodeUPS', 'TEA1NodeHeater', 'TEA1NodeUPSHeater', 'TEA4NodeHeater', 'TEA4NodeUPSHeater', 'TMA'
	Name SkuName `json:"name,omitempty"`
	// Kind - READ-ONLY; The Sku kind
	Kind *string `json:"kind,omitempty"`
	// Tier - READ-ONLY; The Sku tier. Possible values include: 'Standard'
	Tier SkuTier `json:"tier,omitempty"`
	// Family - READ-ONLY; The Sku family
	Family *string `json:"family,omitempty"`
	// Locations - READ-ONLY; Availability of the SKU for the region
	Locations *[]string `json:"locations,omitempty"`
	// APIVersions - READ-ONLY; The API versions in which SKU is available
	APIVersions *[]string `json:"apiVersions,omitempty"`
	// LocationInfo - READ-ONLY; Availability of the SKU for the location/zone
	LocationInfo *[]SkuLocationInfo `json:"locationInfo,omitempty"`
	// Costs - READ-ONLY; The pricing info of the Sku.
	Costs *[]SkuCost `json:"costs,omitempty"`
	// Restrictions - READ-ONLY; Restrictions of the SKU availability.
	Restrictions *[]SkuRestriction `json:"restrictions,omitempty"`
}

ResourceTypeSku skuInformation object

type Role ¶

type Role struct {
	autorest.Response `json:"-"`
	// Kind - Possible values include: 'KindRole', 'KindIOT'
	Kind Kind `json:"kind,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Role compute role.

func (Role) AsBasicRole ¶

func (r Role) AsBasicRole() (BasicRole, bool)

AsBasicRole is the BasicRole implementation for Role.

func (Role) AsIoTRole ¶

func (r Role) AsIoTRole() (*IoTRole, bool)

AsIoTRole is the BasicRole implementation for Role.

func (Role) AsRole ¶

func (r Role) AsRole() (*Role, bool)

AsRole is the BasicRole implementation for Role.

func (Role) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for Role.

type RoleList ¶

type RoleList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The Value.
	Value *[]BasicRole `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleList collection of all the roles on the Data Box Edge device.

func (RoleList) IsEmpty ¶

func (rl RoleList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*RoleList) UnmarshalJSON ¶

func (rl *RoleList) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleList struct.

type RoleListIterator ¶

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

RoleListIterator provides access to a complete listing of Role values.

func NewRoleListIterator ¶

func NewRoleListIterator(page RoleListPage) RoleListIterator

Creates a new instance of the RoleListIterator type.

func (*RoleListIterator) Next ¶

func (iter *RoleListIterator) 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 (*RoleListIterator) NextWithContext ¶

func (iter *RoleListIterator) 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 (RoleListIterator) NotDone ¶

func (iter RoleListIterator) NotDone() bool

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

func (RoleListIterator) Response ¶

func (iter RoleListIterator) Response() RoleList

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

func (RoleListIterator) Value ¶

func (iter RoleListIterator) Value() BasicRole

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

type RoleListPage ¶

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

RoleListPage contains a page of BasicRole values.

func NewRoleListPage ¶

func NewRoleListPage(cur RoleList, getNextPage func(context.Context, RoleList) (RoleList, error)) RoleListPage

Creates a new instance of the RoleListPage type.

func (*RoleListPage) Next ¶

func (page *RoleListPage) 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 (*RoleListPage) NextWithContext ¶

func (page *RoleListPage) 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 (RoleListPage) NotDone ¶

func (page RoleListPage) NotDone() bool

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

func (RoleListPage) Response ¶

func (page RoleListPage) Response() RoleList

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

func (RoleListPage) Values ¶

func (page RoleListPage) Values() []BasicRole

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

type RoleModel ¶

type RoleModel struct {
	autorest.Response `json:"-"`
	Value             BasicRole `json:"value,omitempty"`
}

RoleModel ...

func (*RoleModel) UnmarshalJSON ¶

func (rm *RoleModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleModel struct.

type RoleSinkInfo ¶

type RoleSinkInfo struct {
	// RoleID - Compute role ID.
	RoleID *string `json:"roleId,omitempty"`
}

RoleSinkInfo compute role against which events will be raised.

type RoleStatus ¶

type RoleStatus string

RoleStatus enumerates the values for role status.

const (
	// RoleStatusDisabled ...
	RoleStatusDisabled RoleStatus = "Disabled"
	// RoleStatusEnabled ...
	RoleStatusEnabled RoleStatus = "Enabled"
)

func PossibleRoleStatusValues ¶

func PossibleRoleStatusValues() []RoleStatus

PossibleRoleStatusValues returns an array of possible values for the RoleStatus const type.

type RoleTypes ¶

type RoleTypes string

RoleTypes enumerates the values for role types.

const (
	// ASA ...
	ASA RoleTypes = "ASA"
	// Cognitive ...
	Cognitive RoleTypes = "Cognitive"
	// Functions ...
	Functions RoleTypes = "Functions"
	// IOT ...
	IOT RoleTypes = "IOT"
)

func PossibleRoleTypesValues ¶

func PossibleRoleTypesValues() []RoleTypes

PossibleRoleTypesValues returns an array of possible values for the RoleTypes const type.

type RolesClient ¶

type RolesClient struct {
	BaseClient
}

RolesClient is the client for the Roles methods of the Databoxedge service.

func NewRolesClient ¶

func NewRolesClient(subscriptionID string) RolesClient

NewRolesClient creates an instance of the RolesClient client.

func NewRolesClientWithBaseURI ¶

func NewRolesClientWithBaseURI(baseURI string, subscriptionID string) RolesClient

NewRolesClientWithBaseURI creates an instance of the RolesClient 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 (RolesClient) CreateOrUpdate ¶

func (client RolesClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, role BasicRole, resourceGroupName string) (result RolesCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a role. Parameters: deviceName - the device name. name - the role name. role - the role properties. resourceGroupName - the resource group name.

func (RolesClient) CreateOrUpdatePreparer ¶

func (client RolesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, role BasicRole, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RolesClient) CreateOrUpdateResponder ¶

func (client RolesClient) CreateOrUpdateResponder(resp *http.Response) (result RoleModel, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (RolesClient) CreateOrUpdateSender ¶

func (client RolesClient) CreateOrUpdateSender(req *http.Request) (future RolesCreateOrUpdateFuture, err error)

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

func (RolesClient) Delete ¶

func (client RolesClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result RolesDeleteFuture, err error)

Delete deletes the role on the device. Parameters: deviceName - the device name. name - the role name. resourceGroupName - the resource group name.

func (RolesClient) DeletePreparer ¶

func (client RolesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RolesClient) DeleteResponder ¶

func (client RolesClient) 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 (RolesClient) DeleteSender ¶

func (client RolesClient) DeleteSender(req *http.Request) (future RolesDeleteFuture, err error)

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

func (RolesClient) Get ¶

func (client RolesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result RoleModel, err error)

Get gets a specific role by name. Parameters: deviceName - the device name. name - the role name. resourceGroupName - the resource group name.

func (RolesClient) GetPreparer ¶

func (client RolesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RolesClient) GetResponder ¶

func (client RolesClient) GetResponder(resp *http.Response) (result RoleModel, err error)

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

func (RolesClient) GetSender ¶

func (client RolesClient) 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 (RolesClient) ListByDataBoxEdgeDevice ¶

func (client RolesClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result RoleListPage, err error)

ListByDataBoxEdgeDevice lists all the roles configured in a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (RolesClient) ListByDataBoxEdgeDeviceComplete ¶

func (client RolesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result RoleListIterator, err error)

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

func (RolesClient) ListByDataBoxEdgeDevicePreparer ¶

func (client RolesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (RolesClient) ListByDataBoxEdgeDeviceResponder ¶

func (client RolesClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result RoleList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (RolesClient) ListByDataBoxEdgeDeviceSender ¶

func (client RolesClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type RolesCreateOrUpdateFuture ¶

type RolesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*RolesCreateOrUpdateFuture) Result ¶

func (future *RolesCreateOrUpdateFuture) Result(client RolesClient) (rm RoleModel, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type RolesDeleteFuture ¶

type RolesDeleteFuture struct {
	azure.Future
}

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

func (*RolesDeleteFuture) Result ¶

func (future *RolesDeleteFuture) Result(client RolesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SSLStatus ¶

type SSLStatus string

SSLStatus enumerates the values for ssl status.

const (
	// SSLStatusDisabled ...
	SSLStatusDisabled SSLStatus = "Disabled"
	// SSLStatusEnabled ...
	SSLStatusEnabled SSLStatus = "Enabled"
)

func PossibleSSLStatusValues ¶

func PossibleSSLStatusValues() []SSLStatus

PossibleSSLStatusValues returns an array of possible values for the SSLStatus const type.

type SecuritySettings ¶

type SecuritySettings struct {
	// SecuritySettingsProperties - Properties of the security settings.
	*SecuritySettingsProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

SecuritySettings the security settings of a device.

func (SecuritySettings) MarshalJSON ¶

func (ss SecuritySettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SecuritySettings.

func (*SecuritySettings) UnmarshalJSON ¶

func (ss *SecuritySettings) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SecuritySettings struct.

type SecuritySettingsProperties ¶

type SecuritySettingsProperties struct {
	// DeviceAdminPassword - Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the  local web UI of the device. The Actual password should have at least 8 characters that are a combination of  uppercase, lowercase, numeric, and special characters.
	DeviceAdminPassword *AsymmetricEncryptedSecret `json:"deviceAdminPassword,omitempty"`
}

SecuritySettingsProperties the properties of security settings.

type ServiceSpecification ¶

type ServiceSpecification struct {
	// MetricSpecifications - Metric specification as defined by shoebox.
	MetricSpecifications *[]MetricSpecificationV1 `json:"metricSpecifications,omitempty"`
}

ServiceSpecification service specification.

type Share ¶

type Share struct {
	autorest.Response `json:"-"`
	// ShareProperties - The share properties.
	*ShareProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Share represents a share on the Data Box Edge/Gateway device.

func (Share) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for Share.

func (*Share) UnmarshalJSON ¶

func (s *Share) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Share struct.

type ShareAccessProtocol ¶

type ShareAccessProtocol string

ShareAccessProtocol enumerates the values for share access protocol.

const (
	// NFS ...
	NFS ShareAccessProtocol = "NFS"
	// SMB ...
	SMB ShareAccessProtocol = "SMB"
)

func PossibleShareAccessProtocolValues ¶

func PossibleShareAccessProtocolValues() []ShareAccessProtocol

PossibleShareAccessProtocolValues returns an array of possible values for the ShareAccessProtocol const type.

type ShareAccessRight ¶

type ShareAccessRight struct {
	// ShareID - The share ID.
	ShareID *string `json:"shareId,omitempty"`
	// AccessType - Type of access to be allowed on the share for this user. Possible values include: 'Change', 'Read', 'Custom'
	AccessType ShareAccessType `json:"accessType,omitempty"`
}

ShareAccessRight specifies the mapping between this particular user and the type of access he has on shares on this device.

type ShareAccessType ¶

type ShareAccessType string

ShareAccessType enumerates the values for share access type.

const (
	// Change ...
	Change ShareAccessType = "Change"
	// Custom ...
	Custom ShareAccessType = "Custom"
	// Read ...
	Read ShareAccessType = "Read"
)

func PossibleShareAccessTypeValues ¶

func PossibleShareAccessTypeValues() []ShareAccessType

PossibleShareAccessTypeValues returns an array of possible values for the ShareAccessType const type.

type ShareList ¶

type ShareList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of shares.
	Value *[]Share `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ShareList collection of all the shares on the Data Box Edge/Gateway device.

func (ShareList) IsEmpty ¶

func (sl ShareList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ShareListIterator ¶

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

ShareListIterator provides access to a complete listing of Share values.

func NewShareListIterator ¶

func NewShareListIterator(page ShareListPage) ShareListIterator

Creates a new instance of the ShareListIterator type.

func (*ShareListIterator) Next ¶

func (iter *ShareListIterator) 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 (*ShareListIterator) NextWithContext ¶

func (iter *ShareListIterator) 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 (ShareListIterator) NotDone ¶

func (iter ShareListIterator) NotDone() bool

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

func (ShareListIterator) Response ¶

func (iter ShareListIterator) Response() ShareList

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

func (ShareListIterator) Value ¶

func (iter ShareListIterator) Value() Share

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

type ShareListPage ¶

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

ShareListPage contains a page of Share values.

func NewShareListPage ¶

func NewShareListPage(cur ShareList, getNextPage func(context.Context, ShareList) (ShareList, error)) ShareListPage

Creates a new instance of the ShareListPage type.

func (*ShareListPage) Next ¶

func (page *ShareListPage) 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 (*ShareListPage) NextWithContext ¶

func (page *ShareListPage) 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 (ShareListPage) NotDone ¶

func (page ShareListPage) NotDone() bool

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

func (ShareListPage) Response ¶

func (page ShareListPage) Response() ShareList

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

func (ShareListPage) Values ¶

func (page ShareListPage) Values() []Share

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

type ShareProperties ¶

type ShareProperties struct {
	// Description - Description for the share.
	Description *string `json:"description,omitempty"`
	// ShareStatus - Current status of the share. Possible values include: 'ShareStatusOffline', 'ShareStatusUnknown', 'ShareStatusOK', 'ShareStatusUpdating', 'ShareStatusNeedsAttention'
	ShareStatus ShareStatus `json:"shareStatus,omitempty"`
	// MonitoringStatus - Current monitoring status of the share. Possible values include: 'Enabled', 'Disabled'
	MonitoringStatus MonitoringStatus `json:"monitoringStatus,omitempty"`
	// AzureContainerInfo - Azure container mapping for the share.
	AzureContainerInfo *AzureContainerInfo `json:"azureContainerInfo,omitempty"`
	// AccessProtocol - Access protocol to be used by the share. Possible values include: 'SMB', 'NFS'
	AccessProtocol ShareAccessProtocol `json:"accessProtocol,omitempty"`
	// UserAccessRights - Mapping of users and corresponding access rights on the share (required for SMB protocol).
	UserAccessRights *[]UserAccessRight `json:"userAccessRights,omitempty"`
	// ClientAccessRights - List of IP addresses and corresponding access rights on the share(required for NFS protocol).
	ClientAccessRights *[]ClientAccessRight `json:"clientAccessRights,omitempty"`
	// RefreshDetails - Details of the refresh job on this share.
	RefreshDetails *RefreshDetails `json:"refreshDetails,omitempty"`
	// ShareMappings - READ-ONLY; Share mount point to the role.
	ShareMappings *[]MountPointMap `json:"shareMappings,omitempty"`
	// DataPolicy - Data policy of the share. Possible values include: 'Cloud', 'Local'
	DataPolicy DataPolicy `json:"dataPolicy,omitempty"`
}

ShareProperties the share properties.

func (ShareProperties) MarshalJSON ¶

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

MarshalJSON is the custom marshaler for ShareProperties.

type ShareStatus ¶

type ShareStatus string

ShareStatus enumerates the values for share status.

const (
	// ShareStatusNeedsAttention ...
	ShareStatusNeedsAttention ShareStatus = "NeedsAttention"
	// ShareStatusOffline ...
	ShareStatusOffline ShareStatus = "Offline"
	// ShareStatusOK ...
	ShareStatusOK ShareStatus = "OK"
	// ShareStatusUnknown ...
	ShareStatusUnknown ShareStatus = "Unknown"
	// ShareStatusUpdating ...
	ShareStatusUpdating ShareStatus = "Updating"
)

func PossibleShareStatusValues ¶

func PossibleShareStatusValues() []ShareStatus

PossibleShareStatusValues returns an array of possible values for the ShareStatus const type.

type SharesClient ¶

type SharesClient struct {
	BaseClient
}

SharesClient is the client for the Shares methods of the Databoxedge service.

func NewSharesClient ¶

func NewSharesClient(subscriptionID string) SharesClient

NewSharesClient creates an instance of the SharesClient client.

func NewSharesClientWithBaseURI ¶

func NewSharesClientWithBaseURI(baseURI string, subscriptionID string) SharesClient

NewSharesClientWithBaseURI creates an instance of the SharesClient 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 (SharesClient) CreateOrUpdate ¶

func (client SharesClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, share Share, resourceGroupName string) (result SharesCreateOrUpdateFuture, err error)

CreateOrUpdate sends the create or update request. Parameters: deviceName - the device name. name - the share name. share - the share properties. resourceGroupName - the resource group name.

func (SharesClient) CreateOrUpdatePreparer ¶

func (client SharesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, share Share, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SharesClient) CreateOrUpdateResponder ¶

func (client SharesClient) CreateOrUpdateResponder(resp *http.Response) (result Share, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SharesClient) CreateOrUpdateSender ¶

func (client SharesClient) CreateOrUpdateSender(req *http.Request) (future SharesCreateOrUpdateFuture, err error)

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

func (SharesClient) Delete ¶

func (client SharesClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result SharesDeleteFuture, err error)

Delete deletes the share on the Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. name - the share name. resourceGroupName - the resource group name.

func (SharesClient) DeletePreparer ¶

func (client SharesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SharesClient) DeleteResponder ¶

func (client SharesClient) 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 (SharesClient) DeleteSender ¶

func (client SharesClient) DeleteSender(req *http.Request) (future SharesDeleteFuture, err error)

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

func (SharesClient) Get ¶

func (client SharesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result Share, err error)

Get sends the get request. Parameters: deviceName - the device name. name - the share name. resourceGroupName - the resource group name.

func (SharesClient) GetPreparer ¶

func (client SharesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SharesClient) GetResponder ¶

func (client SharesClient) GetResponder(resp *http.Response) (result Share, err error)

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

func (SharesClient) GetSender ¶

func (client SharesClient) 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 (SharesClient) ListByDataBoxEdgeDevice ¶

func (client SharesClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result ShareListPage, err error)

ListByDataBoxEdgeDevice sends the list by data box edge device request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (SharesClient) ListByDataBoxEdgeDeviceComplete ¶

func (client SharesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result ShareListIterator, err error)

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

func (SharesClient) ListByDataBoxEdgeDevicePreparer ¶

func (client SharesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (SharesClient) ListByDataBoxEdgeDeviceResponder ¶

func (client SharesClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result ShareList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (SharesClient) ListByDataBoxEdgeDeviceSender ¶

func (client SharesClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

func (SharesClient) Refresh ¶

func (client SharesClient) Refresh(ctx context.Context, deviceName string, name string, resourceGroupName string) (result SharesRefreshFuture, err error)

Refresh sends the refresh request. Parameters: deviceName - the device name. name - the share name. resourceGroupName - the resource group name.

func (SharesClient) RefreshPreparer ¶

func (client SharesClient) RefreshPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

RefreshPreparer prepares the Refresh request.

func (SharesClient) RefreshResponder ¶

func (client SharesClient) RefreshResponder(resp *http.Response) (result autorest.Response, err error)

RefreshResponder handles the response to the Refresh request. The method always closes the http.Response Body.

func (SharesClient) RefreshSender ¶

func (client SharesClient) RefreshSender(req *http.Request) (future SharesRefreshFuture, err error)

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

type SharesCreateOrUpdateFuture ¶

type SharesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*SharesCreateOrUpdateFuture) Result ¶

func (future *SharesCreateOrUpdateFuture) Result(client SharesClient) (s Share, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SharesDeleteFuture ¶

type SharesDeleteFuture struct {
	azure.Future
}

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

func (*SharesDeleteFuture) Result ¶

func (future *SharesDeleteFuture) Result(client SharesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SharesRefreshFuture ¶

type SharesRefreshFuture struct {
	azure.Future
}

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

func (*SharesRefreshFuture) Result ¶

func (future *SharesRefreshFuture) Result(client SharesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Sku ¶

type Sku struct {
	// Name - SKU name. Possible values include: 'Gateway', 'Edge', 'TEA1Node', 'TEA1NodeUPS', 'TEA1NodeHeater', 'TEA1NodeUPSHeater', 'TEA4NodeHeater', 'TEA4NodeUPSHeater', 'TMA'
	Name SkuName `json:"name,omitempty"`
	// Tier - The SKU tier. This is based on the SKU name. Possible values include: 'Standard'
	Tier SkuTier `json:"tier,omitempty"`
}

Sku the SKU type.

type SkuCost ¶

type SkuCost struct {
	// MeterID - READ-ONLY; Used for querying price from commerce.
	MeterID *string `json:"meterId,omitempty"`
	// Quantity - READ-ONLY; The cost quantity.
	Quantity *int64 `json:"quantity,omitempty"`
	// ExtendedUnit - READ-ONLY; Restriction of the SKU for the location/zone
	ExtendedUnit *string `json:"extendedUnit,omitempty"`
}

SkuCost the metadata for retrieving price info.

type SkuInformationList ¶

type SkuInformationList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of ResourceType Sku
	Value *[]ResourceTypeSku `json:"value,omitempty"`
	// NextLink - READ-ONLY; Links to the next set of results
	NextLink *string `json:"nextLink,omitempty"`
}

SkuInformationList list of SKU Information objects

type SkuLocationInfo ¶

type SkuLocationInfo struct {
	// Location - READ-ONLY; The location.
	Location *string `json:"location,omitempty"`
	// Zones - READ-ONLY; The zones.
	Zones *[]string `json:"zones,omitempty"`
	// Sites - READ-ONLY; The sites.
	Sites *[]string `json:"sites,omitempty"`
}

SkuLocationInfo the location info.

type SkuName ¶

type SkuName string

SkuName enumerates the values for sku name.

const (
	// Edge ...
	Edge SkuName = "Edge"
	// Gateway ...
	Gateway SkuName = "Gateway"
	// TEA1Node ...
	TEA1Node SkuName = "TEA_1Node"
	// TEA1NodeHeater ...
	TEA1NodeHeater SkuName = "TEA_1Node_Heater"
	// TEA1NodeUPS ...
	TEA1NodeUPS SkuName = "TEA_1Node_UPS"
	// TEA1NodeUPSHeater ...
	TEA1NodeUPSHeater SkuName = "TEA_1Node_UPS_Heater"
	// TEA4NodeHeater ...
	TEA4NodeHeater SkuName = "TEA_4Node_Heater"
	// TEA4NodeUPSHeater ...
	TEA4NodeUPSHeater SkuName = "TEA_4Node_UPS_Heater"
	// TMA ...
	TMA SkuName = "TMA"
)

func PossibleSkuNameValues ¶

func PossibleSkuNameValues() []SkuName

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

type SkuRestriction ¶

type SkuRestriction struct {
	// Type - READ-ONLY; The type of the restriction.
	Type *string `json:"type,omitempty"`
	// Values - READ-ONLY; The locations where sku is restricted.
	Values *[]string `json:"values,omitempty"`
	// ReasonCode - READ-ONLY; The SKU restriction reason. Possible values include: 'NotAvailableForSubscription', 'QuotaID'
	ReasonCode SkuRestrictionReasonCode `json:"reasonCode,omitempty"`
	// RestrictionInfo - READ-ONLY; Restriction of the SKU for the location/zone
	RestrictionInfo *SkuRestrictionInfo `json:"restrictionInfo,omitempty"`
}

SkuRestriction the restrictions because of which SKU cannot be used.

type SkuRestrictionInfo ¶

type SkuRestrictionInfo struct {
	// Locations - READ-ONLY; The locations.
	Locations *[]string `json:"locations,omitempty"`
	// Zones - READ-ONLY; The zones.
	Zones *[]string `json:"zones,omitempty"`
}

SkuRestrictionInfo the restriction info with locations and zones.

type SkuRestrictionReasonCode ¶

type SkuRestrictionReasonCode string

SkuRestrictionReasonCode enumerates the values for sku restriction reason code.

const (
	// NotAvailableForSubscription ...
	NotAvailableForSubscription SkuRestrictionReasonCode = "NotAvailableForSubscription"
	// QuotaID ...
	QuotaID SkuRestrictionReasonCode = "QuotaId"
)

func PossibleSkuRestrictionReasonCodeValues ¶

func PossibleSkuRestrictionReasonCodeValues() []SkuRestrictionReasonCode

PossibleSkuRestrictionReasonCodeValues returns an array of possible values for the SkuRestrictionReasonCode const type.

type SkuTier ¶

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
	// Standard ...
	Standard SkuTier = "Standard"
)

func PossibleSkuTierValues ¶

func PossibleSkuTierValues() []SkuTier

PossibleSkuTierValues returns an array of possible values for the SkuTier const type.

type SkusClient ¶

type SkusClient struct {
	BaseClient
}

SkusClient is the client for the Skus methods of the Databoxedge service.

func NewSkusClient ¶

func NewSkusClient(subscriptionID string) SkusClient

NewSkusClient creates an instance of the SkusClient client.

func NewSkusClientWithBaseURI ¶

func NewSkusClientWithBaseURI(baseURI string, subscriptionID string) SkusClient

NewSkusClientWithBaseURI creates an instance of the SkusClient 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 (SkusClient) List ¶

func (client SkusClient) List(ctx context.Context, filter string) (result SkuInformationList, err error)

List sends the list request. Parameters: filter - specify $filter='location eq <location>' to filter on location.

func (SkusClient) ListPreparer ¶

func (client SkusClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (SkusClient) ListResponder ¶

func (client SkusClient) ListResponder(resp *http.Response) (result SkuInformationList, err error)

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

func (SkusClient) ListSender ¶

func (client SkusClient) 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 StorageAccount ¶

type StorageAccount struct {
	autorest.Response `json:"-"`
	// StorageAccountProperties - The Storage Account properties.
	*StorageAccountProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

StorageAccount represents a Storage Account on the Data Box Edge/Gateway device.

func (StorageAccount) MarshalJSON ¶

func (sa StorageAccount) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccount.

func (*StorageAccount) UnmarshalJSON ¶

func (sa *StorageAccount) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for StorageAccount struct.

type StorageAccountCredential ¶

type StorageAccountCredential struct {
	autorest.Response `json:"-"`
	// StorageAccountCredentialProperties - The storage account credential properties.
	*StorageAccountCredentialProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

StorageAccountCredential the storage account credential.

func (StorageAccountCredential) MarshalJSON ¶

func (sac StorageAccountCredential) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccountCredential.

func (*StorageAccountCredential) UnmarshalJSON ¶

func (sac *StorageAccountCredential) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for StorageAccountCredential struct.

type StorageAccountCredentialList ¶

type StorageAccountCredentialList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The value.
	Value *[]StorageAccountCredential `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

StorageAccountCredentialList the collection of storage account credentials.

func (StorageAccountCredentialList) IsEmpty ¶

func (sacl StorageAccountCredentialList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageAccountCredentialListIterator ¶

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

StorageAccountCredentialListIterator provides access to a complete listing of StorageAccountCredential values.

func NewStorageAccountCredentialListIterator ¶

func NewStorageAccountCredentialListIterator(page StorageAccountCredentialListPage) StorageAccountCredentialListIterator

Creates a new instance of the StorageAccountCredentialListIterator type.

func (*StorageAccountCredentialListIterator) Next ¶

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 (*StorageAccountCredentialListIterator) NextWithContext ¶

func (iter *StorageAccountCredentialListIterator) 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 (StorageAccountCredentialListIterator) NotDone ¶

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

func (StorageAccountCredentialListIterator) Response ¶

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

func (StorageAccountCredentialListIterator) Value ¶

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

type StorageAccountCredentialListPage ¶

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

StorageAccountCredentialListPage contains a page of StorageAccountCredential values.

func NewStorageAccountCredentialListPage ¶

Creates a new instance of the StorageAccountCredentialListPage type.

func (*StorageAccountCredentialListPage) Next ¶

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 (*StorageAccountCredentialListPage) NextWithContext ¶

func (page *StorageAccountCredentialListPage) 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 (StorageAccountCredentialListPage) NotDone ¶

func (page StorageAccountCredentialListPage) NotDone() bool

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

func (StorageAccountCredentialListPage) Response ¶

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

func (StorageAccountCredentialListPage) Values ¶

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

type StorageAccountCredentialProperties ¶

type StorageAccountCredentialProperties struct {
	// Alias - Alias for the storage account.
	Alias *string `json:"alias,omitempty"`
	// UserName - Username for the storage account.
	UserName *string `json:"userName,omitempty"`
	// AccountKey - Encrypted storage key.
	AccountKey *AsymmetricEncryptedSecret `json:"accountKey,omitempty"`
	// ConnectionString - Connection string for the storage account. Use this string if username and account key are not specified.
	ConnectionString *string `json:"connectionString,omitempty"`
	// SslStatus - Signifies whether SSL needs to be enabled or not. Possible values include: 'SSLStatusEnabled', 'SSLStatusDisabled'
	SslStatus SSLStatus `json:"sslStatus,omitempty"`
	// BlobDomainName - Blob end point for private clouds.
	BlobDomainName *string `json:"blobDomainName,omitempty"`
	// AccountType - Type of storage accessed on the storage account. Possible values include: 'GeneralPurposeStorage', 'BlobStorage'
	AccountType AccountType `json:"accountType,omitempty"`
	// StorageAccountID - Id of the storage account.
	StorageAccountID *string `json:"storageAccountId,omitempty"`
}

StorageAccountCredentialProperties the storage account credential properties.

type StorageAccountCredentialsClient ¶

type StorageAccountCredentialsClient struct {
	BaseClient
}

StorageAccountCredentialsClient is the client for the StorageAccountCredentials methods of the Databoxedge service.

func NewStorageAccountCredentialsClient ¶

func NewStorageAccountCredentialsClient(subscriptionID string) StorageAccountCredentialsClient

NewStorageAccountCredentialsClient creates an instance of the StorageAccountCredentialsClient client.

func NewStorageAccountCredentialsClientWithBaseURI ¶

func NewStorageAccountCredentialsClientWithBaseURI(baseURI string, subscriptionID string) StorageAccountCredentialsClient

NewStorageAccountCredentialsClientWithBaseURI creates an instance of the StorageAccountCredentialsClient 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 (StorageAccountCredentialsClient) CreateOrUpdate ¶

func (client StorageAccountCredentialsClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, storageAccountCredential StorageAccountCredential, resourceGroupName string) (result StorageAccountCredentialsCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates the storage account credential. Parameters: deviceName - the device name. name - the storage account credential name. storageAccountCredential - the storage account credential. resourceGroupName - the resource group name.

func (StorageAccountCredentialsClient) CreateOrUpdatePreparer ¶

func (client StorageAccountCredentialsClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, storageAccountCredential StorageAccountCredential, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StorageAccountCredentialsClient) CreateOrUpdateResponder ¶

func (client StorageAccountCredentialsClient) CreateOrUpdateResponder(resp *http.Response) (result StorageAccountCredential, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (StorageAccountCredentialsClient) CreateOrUpdateSender ¶

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

func (StorageAccountCredentialsClient) Delete ¶

func (client StorageAccountCredentialsClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result StorageAccountCredentialsDeleteFuture, err error)

Delete deletes the storage account credential. Parameters: deviceName - the device name. name - the storage account credential name. resourceGroupName - the resource group name.

func (StorageAccountCredentialsClient) DeletePreparer ¶

func (client StorageAccountCredentialsClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (StorageAccountCredentialsClient) DeleteResponder ¶

func (client StorageAccountCredentialsClient) 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 (StorageAccountCredentialsClient) DeleteSender ¶

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

func (StorageAccountCredentialsClient) Get ¶

func (client StorageAccountCredentialsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result StorageAccountCredential, err error)

Get gets the properties of the specified storage account credential. Parameters: deviceName - the device name. name - the storage account credential name. resourceGroupName - the resource group name.

func (StorageAccountCredentialsClient) GetPreparer ¶

func (client StorageAccountCredentialsClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (StorageAccountCredentialsClient) GetResponder ¶

func (client StorageAccountCredentialsClient) GetResponder(resp *http.Response) (result StorageAccountCredential, err error)

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

func (StorageAccountCredentialsClient) GetSender ¶

func (client StorageAccountCredentialsClient) 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 (StorageAccountCredentialsClient) ListByDataBoxEdgeDevice ¶

func (client StorageAccountCredentialsClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result StorageAccountCredentialListPage, err error)

ListByDataBoxEdgeDevice sends the list by data box edge device request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceComplete ¶

func (client StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result StorageAccountCredentialListIterator, err error)

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

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDevicePreparer ¶

func (client StorageAccountCredentialsClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceResponder ¶

func (client StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result StorageAccountCredentialList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceSender ¶

func (client StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type StorageAccountCredentialsCreateOrUpdateFuture ¶

type StorageAccountCredentialsCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*StorageAccountCredentialsCreateOrUpdateFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type StorageAccountCredentialsDeleteFuture ¶

type StorageAccountCredentialsDeleteFuture struct {
	azure.Future
}

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

func (*StorageAccountCredentialsDeleteFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type StorageAccountList ¶

type StorageAccountList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of storageAccounts.
	Value *[]StorageAccount `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

StorageAccountList collection of all the Storage Accounts on the Data Box Edge/Gateway device.

func (StorageAccountList) IsEmpty ¶

func (sal StorageAccountList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageAccountListIterator ¶

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

StorageAccountListIterator provides access to a complete listing of StorageAccount values.

func NewStorageAccountListIterator ¶

func NewStorageAccountListIterator(page StorageAccountListPage) StorageAccountListIterator

Creates a new instance of the StorageAccountListIterator type.

func (*StorageAccountListIterator) Next ¶

func (iter *StorageAccountListIterator) 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 (*StorageAccountListIterator) NextWithContext ¶

func (iter *StorageAccountListIterator) 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 (StorageAccountListIterator) NotDone ¶

func (iter StorageAccountListIterator) NotDone() bool

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

func (StorageAccountListIterator) Response ¶

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

func (StorageAccountListIterator) Value ¶

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

type StorageAccountListPage ¶

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

StorageAccountListPage contains a page of StorageAccount values.

func NewStorageAccountListPage ¶

func NewStorageAccountListPage(cur StorageAccountList, getNextPage func(context.Context, StorageAccountList) (StorageAccountList, error)) StorageAccountListPage

Creates a new instance of the StorageAccountListPage type.

func (*StorageAccountListPage) Next ¶

func (page *StorageAccountListPage) 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 (*StorageAccountListPage) NextWithContext ¶

func (page *StorageAccountListPage) 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 (StorageAccountListPage) NotDone ¶

func (page StorageAccountListPage) NotDone() bool

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

func (StorageAccountListPage) Response ¶

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

func (StorageAccountListPage) Values ¶

func (page StorageAccountListPage) Values() []StorageAccount

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

type StorageAccountProperties ¶

type StorageAccountProperties struct {
	// Description - Description for the storage Account.
	Description *string `json:"description,omitempty"`
	// StorageAccountStatus - Current status of the storage account. Possible values include: 'StorageAccountStatusOK', 'StorageAccountStatusOffline', 'StorageAccountStatusUnknown', 'StorageAccountStatusUpdating', 'StorageAccountStatusNeedsAttention'
	StorageAccountStatus StorageAccountStatus `json:"storageAccountStatus,omitempty"`
	// DataPolicy - Data policy of the storage Account. Possible values include: 'Cloud', 'Local'
	DataPolicy DataPolicy `json:"dataPolicy,omitempty"`
	// StorageAccountCredentialID - Storage Account Credential Id
	StorageAccountCredentialID *string `json:"storageAccountCredentialId,omitempty"`
	// BlobEndpoint - READ-ONLY; BlobEndpoint of Storage Account
	BlobEndpoint *string `json:"blobEndpoint,omitempty"`
	// ContainerCount - READ-ONLY; The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.
	ContainerCount *int32 `json:"containerCount,omitempty"`
}

StorageAccountProperties the storage account properties.

func (StorageAccountProperties) MarshalJSON ¶

func (sap StorageAccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccountProperties.

type StorageAccountStatus ¶

type StorageAccountStatus string

StorageAccountStatus enumerates the values for storage account status.

const (
	// StorageAccountStatusNeedsAttention ...
	StorageAccountStatusNeedsAttention StorageAccountStatus = "NeedsAttention"
	// StorageAccountStatusOffline ...
	StorageAccountStatusOffline StorageAccountStatus = "Offline"
	// StorageAccountStatusOK ...
	StorageAccountStatusOK StorageAccountStatus = "OK"
	// StorageAccountStatusUnknown ...
	StorageAccountStatusUnknown StorageAccountStatus = "Unknown"
	// StorageAccountStatusUpdating ...
	StorageAccountStatusUpdating StorageAccountStatus = "Updating"
)

func PossibleStorageAccountStatusValues ¶

func PossibleStorageAccountStatusValues() []StorageAccountStatus

PossibleStorageAccountStatusValues returns an array of possible values for the StorageAccountStatus const type.

type StorageAccountsClient ¶

type StorageAccountsClient struct {
	BaseClient
}

StorageAccountsClient is the client for the StorageAccounts methods of the Databoxedge service.

func NewStorageAccountsClient ¶

func NewStorageAccountsClient(subscriptionID string) StorageAccountsClient

NewStorageAccountsClient creates an instance of the StorageAccountsClient client.

func NewStorageAccountsClientWithBaseURI ¶

func NewStorageAccountsClientWithBaseURI(baseURI string, subscriptionID string) StorageAccountsClient

NewStorageAccountsClientWithBaseURI creates an instance of the StorageAccountsClient 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 (StorageAccountsClient) CreateOrUpdate ¶

func (client StorageAccountsClient) CreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, storageAccount StorageAccount, resourceGroupName string) (result StorageAccountsCreateOrUpdateFuture, err error)

CreateOrUpdate sends the create or update request. Parameters: deviceName - the device name. storageAccountName - the StorageAccount name. storageAccount - the StorageAccount properties. resourceGroupName - the resource group name.

func (StorageAccountsClient) CreateOrUpdatePreparer ¶

func (client StorageAccountsClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, storageAccountName string, storageAccount StorageAccount, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StorageAccountsClient) CreateOrUpdateResponder ¶

func (client StorageAccountsClient) CreateOrUpdateResponder(resp *http.Response) (result StorageAccount, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (StorageAccountsClient) CreateOrUpdateSender ¶

func (client StorageAccountsClient) CreateOrUpdateSender(req *http.Request) (future StorageAccountsCreateOrUpdateFuture, err error)

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

func (StorageAccountsClient) Delete ¶

func (client StorageAccountsClient) Delete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result StorageAccountsDeleteFuture, err error)

Delete deletes the StorageAccount on the Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. storageAccountName - the StorageAccount name. resourceGroupName - the resource group name.

func (StorageAccountsClient) DeletePreparer ¶

func (client StorageAccountsClient) DeletePreparer(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (StorageAccountsClient) DeleteResponder ¶

func (client StorageAccountsClient) 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 (StorageAccountsClient) DeleteSender ¶

func (client StorageAccountsClient) DeleteSender(req *http.Request) (future StorageAccountsDeleteFuture, err error)

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

func (StorageAccountsClient) Get ¶

func (client StorageAccountsClient) Get(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result StorageAccount, err error)

Get sends the get request. Parameters: deviceName - the device name. storageAccountName - the storage account name. resourceGroupName - the resource group name.

func (StorageAccountsClient) GetPreparer ¶

func (client StorageAccountsClient) GetPreparer(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (StorageAccountsClient) GetResponder ¶

func (client StorageAccountsClient) GetResponder(resp *http.Response) (result StorageAccount, err error)

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

func (StorageAccountsClient) GetSender ¶

func (client StorageAccountsClient) 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 (StorageAccountsClient) ListByDataBoxEdgeDevice ¶

func (client StorageAccountsClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result StorageAccountListPage, err error)

ListByDataBoxEdgeDevice sends the list by data box edge device request. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (StorageAccountsClient) ListByDataBoxEdgeDeviceComplete ¶

func (client StorageAccountsClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result StorageAccountListIterator, err error)

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

func (StorageAccountsClient) ListByDataBoxEdgeDevicePreparer ¶

func (client StorageAccountsClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (StorageAccountsClient) ListByDataBoxEdgeDeviceResponder ¶

func (client StorageAccountsClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result StorageAccountList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (StorageAccountsClient) ListByDataBoxEdgeDeviceSender ¶

func (client StorageAccountsClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type StorageAccountsCreateOrUpdateFuture ¶

type StorageAccountsCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*StorageAccountsCreateOrUpdateFuture) Result ¶

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type StorageAccountsDeleteFuture ¶

type StorageAccountsDeleteFuture struct {
	azure.Future
}

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

func (*StorageAccountsDeleteFuture) Result ¶

func (future *StorageAccountsDeleteFuture) Result(client StorageAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SymmetricKey ¶

type SymmetricKey struct {
	// ConnectionString - Connection string based on the symmetric key.
	ConnectionString *AsymmetricEncryptedSecret `json:"connectionString,omitempty"`
}

SymmetricKey symmetric key for authentication.

type TimeGrain ¶

type TimeGrain string

TimeGrain enumerates the values for time grain.

const (
	// PT12H ...
	PT12H TimeGrain = "PT12H"
	// PT15M ...
	PT15M TimeGrain = "PT15M"
	// PT1D ...
	PT1D TimeGrain = "PT1D"
	// PT1H ...
	PT1H TimeGrain = "PT1H"
	// PT1M ...
	PT1M TimeGrain = "PT1M"
	// PT30M ...
	PT30M TimeGrain = "PT30M"
	// PT5M ...
	PT5M TimeGrain = "PT5M"
	// PT6H ...
	PT6H TimeGrain = "PT6H"
)

func PossibleTimeGrainValues ¶

func PossibleTimeGrainValues() []TimeGrain

PossibleTimeGrainValues returns an array of possible values for the TimeGrain const type.

type TrackingInfo ¶

type TrackingInfo struct {
	// SerialNumber - Serial number of the device being tracked.
	SerialNumber *string `json:"serialNumber,omitempty"`
	// CarrierName - Name of the carrier used in the delivery.
	CarrierName *string `json:"carrierName,omitempty"`
	// TrackingID - Tracking ID of the shipment.
	TrackingID *string `json:"trackingId,omitempty"`
	// TrackingURL - Tracking URL of the shipment.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

TrackingInfo tracking courier information.

type Trigger ¶

type Trigger struct {
	autorest.Response `json:"-"`
	// Kind - Possible values include: 'KindTrigger', 'KindFileEvent', 'KindPeriodicTimerEvent'
	Kind KindBasicTrigger `json:"kind,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

Trigger trigger details.

func (Trigger) AsBasicTrigger ¶

func (t Trigger) AsBasicTrigger() (BasicTrigger, bool)

AsBasicTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsFileEventTrigger ¶

func (t Trigger) AsFileEventTrigger() (*FileEventTrigger, bool)

AsFileEventTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsPeriodicTimerEventTrigger ¶

func (t Trigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsTrigger ¶

func (t Trigger) AsTrigger() (*Trigger, bool)

AsTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) MarshalJSON ¶

func (t Trigger) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Trigger.

type TriggerList ¶

type TriggerList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of triggers.
	Value *[]BasicTrigger `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

TriggerList collection of all trigger on the data box edge device.

func (TriggerList) IsEmpty ¶

func (tl TriggerList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*TriggerList) UnmarshalJSON ¶

func (tl *TriggerList) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TriggerList struct.

type TriggerListIterator ¶

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

TriggerListIterator provides access to a complete listing of Trigger values.

func NewTriggerListIterator ¶

func NewTriggerListIterator(page TriggerListPage) TriggerListIterator

Creates a new instance of the TriggerListIterator type.

func (*TriggerListIterator) Next ¶

func (iter *TriggerListIterator) 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 (*TriggerListIterator) NextWithContext ¶

func (iter *TriggerListIterator) 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 (TriggerListIterator) NotDone ¶

func (iter TriggerListIterator) NotDone() bool

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

func (TriggerListIterator) Response ¶

func (iter TriggerListIterator) Response() TriggerList

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

func (TriggerListIterator) Value ¶

func (iter TriggerListIterator) Value() BasicTrigger

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

type TriggerListPage ¶

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

TriggerListPage contains a page of BasicTrigger values.

func NewTriggerListPage ¶

func NewTriggerListPage(cur TriggerList, getNextPage func(context.Context, TriggerList) (TriggerList, error)) TriggerListPage

Creates a new instance of the TriggerListPage type.

func (*TriggerListPage) Next ¶

func (page *TriggerListPage) 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 (*TriggerListPage) NextWithContext ¶

func (page *TriggerListPage) 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 (TriggerListPage) NotDone ¶

func (page TriggerListPage) NotDone() bool

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

func (TriggerListPage) Response ¶

func (page TriggerListPage) Response() TriggerList

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

func (TriggerListPage) Values ¶

func (page TriggerListPage) Values() []BasicTrigger

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

type TriggerModel ¶

type TriggerModel struct {
	autorest.Response `json:"-"`
	Value             BasicTrigger `json:"value,omitempty"`
}

TriggerModel ...

func (*TriggerModel) UnmarshalJSON ¶

func (tm *TriggerModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TriggerModel struct.

type TriggersClient ¶

type TriggersClient struct {
	BaseClient
}

TriggersClient is the client for the Triggers methods of the Databoxedge service.

func NewTriggersClient ¶

func NewTriggersClient(subscriptionID string) TriggersClient

NewTriggersClient creates an instance of the TriggersClient client.

func NewTriggersClientWithBaseURI ¶

func NewTriggersClientWithBaseURI(baseURI string, subscriptionID string) TriggersClient

NewTriggersClientWithBaseURI creates an instance of the TriggersClient 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 (TriggersClient) CreateOrUpdate ¶

func (client TriggersClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, trigger BasicTrigger, resourceGroupName string) (result TriggersCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a trigger. Parameters: deviceName - creates or updates a trigger name - the trigger name. trigger - the trigger. resourceGroupName - the resource group name.

func (TriggersClient) CreateOrUpdatePreparer ¶

func (client TriggersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, trigger BasicTrigger, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TriggersClient) CreateOrUpdateResponder ¶

func (client TriggersClient) CreateOrUpdateResponder(resp *http.Response) (result TriggerModel, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (TriggersClient) CreateOrUpdateSender ¶

func (client TriggersClient) CreateOrUpdateSender(req *http.Request) (future TriggersCreateOrUpdateFuture, err error)

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

func (TriggersClient) Delete ¶

func (client TriggersClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result TriggersDeleteFuture, err error)

Delete deletes the trigger on the gateway device. Parameters: deviceName - the device name. name - the trigger name. resourceGroupName - the resource group name.

func (TriggersClient) DeletePreparer ¶

func (client TriggersClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TriggersClient) DeleteResponder ¶

func (client TriggersClient) 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 (TriggersClient) DeleteSender ¶

func (client TriggersClient) DeleteSender(req *http.Request) (future TriggersDeleteFuture, err error)

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

func (TriggersClient) Get ¶

func (client TriggersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result TriggerModel, err error)

Get get a specific trigger by name. Parameters: deviceName - the device name. name - the trigger name. resourceGroupName - the resource group name.

func (TriggersClient) GetPreparer ¶

func (client TriggersClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TriggersClient) GetResponder ¶

func (client TriggersClient) GetResponder(resp *http.Response) (result TriggerModel, err error)

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

func (TriggersClient) GetSender ¶

func (client TriggersClient) 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 (TriggersClient) ListByDataBoxEdgeDevice ¶

func (client TriggersClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result TriggerListPage, err error)

ListByDataBoxEdgeDevice lists all the triggers configured in the device. Parameters: deviceName - the device name. resourceGroupName - the resource group name. filter - specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property

func (TriggersClient) ListByDataBoxEdgeDeviceComplete ¶

func (client TriggersClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result TriggerListIterator, err error)

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

func (TriggersClient) ListByDataBoxEdgeDevicePreparer ¶

func (client TriggersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string, filter string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (TriggersClient) ListByDataBoxEdgeDeviceResponder ¶

func (client TriggersClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result TriggerList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (TriggersClient) ListByDataBoxEdgeDeviceSender ¶

func (client TriggersClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type TriggersCreateOrUpdateFuture ¶

type TriggersCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*TriggersCreateOrUpdateFuture) Result ¶

func (future *TriggersCreateOrUpdateFuture) Result(client TriggersClient) (tm TriggerModel, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TriggersDeleteFuture ¶

type TriggersDeleteFuture struct {
	azure.Future
}

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

func (*TriggersDeleteFuture) Result ¶

func (future *TriggersDeleteFuture) Result(client TriggersClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type UpdateDownloadProgress ¶

type UpdateDownloadProgress struct {
	// DownloadPhase - READ-ONLY; The download phase. Possible values include: 'DownloadPhaseUnknown', 'DownloadPhaseInitializing', 'DownloadPhaseDownloading', 'DownloadPhaseVerifying'
	DownloadPhase DownloadPhase `json:"downloadPhase,omitempty"`
	// PercentComplete - READ-ONLY; Percentage of completion.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// TotalBytesToDownload - READ-ONLY; Total bytes to download.
	TotalBytesToDownload *float64 `json:"totalBytesToDownload,omitempty"`
	// TotalBytesDownloaded - READ-ONLY; Total bytes downloaded.
	TotalBytesDownloaded *float64 `json:"totalBytesDownloaded,omitempty"`
	// NumberOfUpdatesToDownload - READ-ONLY; Number of updates to download.
	NumberOfUpdatesToDownload *int32 `json:"numberOfUpdatesToDownload,omitempty"`
	// NumberOfUpdatesDownloaded - READ-ONLY; Number of updates downloaded.
	NumberOfUpdatesDownloaded *int32 `json:"numberOfUpdatesDownloaded,omitempty"`
}

UpdateDownloadProgress details about the download progress of update.

type UpdateInstallProgress ¶

type UpdateInstallProgress struct {
	// PercentComplete - READ-ONLY; Percentage completed.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// NumberOfUpdatesToInstall - READ-ONLY; Number of updates to install.
	NumberOfUpdatesToInstall *int32 `json:"numberOfUpdatesToInstall,omitempty"`
	// NumberOfUpdatesInstalled - READ-ONLY; Number of updates installed.
	NumberOfUpdatesInstalled *int32 `json:"numberOfUpdatesInstalled,omitempty"`
}

UpdateInstallProgress progress details during installation of updates.

type UpdateOperation ¶

type UpdateOperation string

UpdateOperation enumerates the values for update operation.

const (
	// UpdateOperationDownload ...
	UpdateOperationDownload UpdateOperation = "Download"
	// UpdateOperationInstall ...
	UpdateOperationInstall UpdateOperation = "Install"
	// UpdateOperationNone ...
	UpdateOperationNone UpdateOperation = "None"
	// UpdateOperationScan ...
	UpdateOperationScan UpdateOperation = "Scan"
)

func PossibleUpdateOperationValues ¶

func PossibleUpdateOperationValues() []UpdateOperation

PossibleUpdateOperationValues returns an array of possible values for the UpdateOperation const type.

type UpdateOperationStage ¶

type UpdateOperationStage string

UpdateOperationStage enumerates the values for update operation stage.

const (
	// UpdateOperationStageDownloadComplete ...
	UpdateOperationStageDownloadComplete UpdateOperationStage = "DownloadComplete"
	// UpdateOperationStageDownloadFailed ...
	UpdateOperationStageDownloadFailed UpdateOperationStage = "DownloadFailed"
	// UpdateOperationStageDownloadStarted ...
	UpdateOperationStageDownloadStarted UpdateOperationStage = "DownloadStarted"
	// UpdateOperationStageFailure ...
	UpdateOperationStageFailure UpdateOperationStage = "Failure"
	// UpdateOperationStageInitial ...
	UpdateOperationStageInitial UpdateOperationStage = "Initial"
	// UpdateOperationStageInstallComplete ...
	UpdateOperationStageInstallComplete UpdateOperationStage = "InstallComplete"
	// UpdateOperationStageInstallFailed ...
	UpdateOperationStageInstallFailed UpdateOperationStage = "InstallFailed"
	// UpdateOperationStageInstallStarted ...
	UpdateOperationStageInstallStarted UpdateOperationStage = "InstallStarted"
	// UpdateOperationStageRebootInitiated ...
	UpdateOperationStageRebootInitiated UpdateOperationStage = "RebootInitiated"
	// UpdateOperationStageRescanComplete ...
	UpdateOperationStageRescanComplete UpdateOperationStage = "RescanComplete"
	// UpdateOperationStageRescanFailed ...
	UpdateOperationStageRescanFailed UpdateOperationStage = "RescanFailed"
	// UpdateOperationStageRescanStarted ...
	UpdateOperationStageRescanStarted UpdateOperationStage = "RescanStarted"
	// UpdateOperationStageScanComplete ...
	UpdateOperationStageScanComplete UpdateOperationStage = "ScanComplete"
	// UpdateOperationStageScanFailed ...
	UpdateOperationStageScanFailed UpdateOperationStage = "ScanFailed"
	// UpdateOperationStageScanStarted ...
	UpdateOperationStageScanStarted UpdateOperationStage = "ScanStarted"
	// UpdateOperationStageSuccess ...
	UpdateOperationStageSuccess UpdateOperationStage = "Success"
	// UpdateOperationStageUnknown ...
	UpdateOperationStageUnknown UpdateOperationStage = "Unknown"
)

func PossibleUpdateOperationStageValues ¶

func PossibleUpdateOperationStageValues() []UpdateOperationStage

PossibleUpdateOperationStageValues returns an array of possible values for the UpdateOperationStage const type.

type UpdateSummary ¶

type UpdateSummary struct {
	autorest.Response `json:"-"`
	// UpdateSummaryProperties - The device update information summary.
	*UpdateSummaryProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

UpdateSummary details about ongoing updates and availability of updates on the device.

func (UpdateSummary) MarshalJSON ¶

func (us UpdateSummary) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateSummary.

func (*UpdateSummary) UnmarshalJSON ¶

func (us *UpdateSummary) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UpdateSummary struct.

type UpdateSummaryProperties ¶

type UpdateSummaryProperties struct {
	// DeviceVersionNumber - The current version of the device in format: 1.2.17312.13.",
	DeviceVersionNumber *string `json:"deviceVersionNumber,omitempty"`
	// FriendlyDeviceVersionName - The current version of the device in text format.
	FriendlyDeviceVersionName *string `json:"friendlyDeviceVersionName,omitempty"`
	// DeviceLastScannedDateTime - The last time when a scan was done on the device.
	DeviceLastScannedDateTime *date.Time `json:"deviceLastScannedDateTime,omitempty"`
	// LastCompletedScanJobDateTime - The time when the last scan job was completed (success/cancelled/failed) on the appliance.
	LastCompletedScanJobDateTime *date.Time `json:"lastCompletedScanJobDateTime,omitempty"`
	// LastCompletedDownloadJobDateTime - READ-ONLY; The time when the last Download job was completed (success/cancelled/failed) on the appliance.
	LastCompletedDownloadJobDateTime *date.Time `json:"lastCompletedDownloadJobDateTime,omitempty"`
	// LastCompletedInstallJobDateTime - READ-ONLY; The time when the last Install job was completed (success/cancelled/failed) on the appliance.
	LastCompletedInstallJobDateTime *date.Time `json:"lastCompletedInstallJobDateTime,omitempty"`
	// TotalNumberOfUpdatesAvailable - READ-ONLY; The number of updates available for the current device version as per the last device scan.
	TotalNumberOfUpdatesAvailable *int32 `json:"totalNumberOfUpdatesAvailable,omitempty"`
	// TotalNumberOfUpdatesPendingDownload - READ-ONLY; The total number of items pending download.
	TotalNumberOfUpdatesPendingDownload *int32 `json:"totalNumberOfUpdatesPendingDownload,omitempty"`
	// TotalNumberOfUpdatesPendingInstall - READ-ONLY; The total number of items pending install.
	TotalNumberOfUpdatesPendingInstall *int32 `json:"totalNumberOfUpdatesPendingInstall,omitempty"`
	// RebootBehavior - READ-ONLY; Indicates if updates are available and at least one of the updates needs a reboot. Possible values include: 'NeverReboots', 'RequiresReboot', 'RequestReboot'
	RebootBehavior InstallRebootBehavior `json:"rebootBehavior,omitempty"`
	// OngoingUpdateOperation - READ-ONLY; The current update operation. Possible values include: 'UpdateOperationNone', 'UpdateOperationScan', 'UpdateOperationDownload', 'UpdateOperationInstall'
	OngoingUpdateOperation UpdateOperation `json:"ongoingUpdateOperation,omitempty"`
	// InProgressDownloadJobID - READ-ONLY; The job ID of the download job in progress.
	InProgressDownloadJobID *string `json:"inProgressDownloadJobId,omitempty"`
	// InProgressInstallJobID - READ-ONLY; The job ID of the install job in progress.
	InProgressInstallJobID *string `json:"inProgressInstallJobId,omitempty"`
	// InProgressDownloadJobStartedDateTime - READ-ONLY; The time when the currently running download (if any) started.
	InProgressDownloadJobStartedDateTime *date.Time `json:"inProgressDownloadJobStartedDateTime,omitempty"`
	// InProgressInstallJobStartedDateTime - READ-ONLY; The time when the currently running install (if any) started.
	InProgressInstallJobStartedDateTime *date.Time `json:"inProgressInstallJobStartedDateTime,omitempty"`
	// UpdateTitles - READ-ONLY; The list of updates available for install.
	UpdateTitles *[]string `json:"updateTitles,omitempty"`
	// TotalUpdateSizeInBytes - READ-ONLY; The total size of updates available for download in bytes.
	TotalUpdateSizeInBytes *float64 `json:"totalUpdateSizeInBytes,omitempty"`
}

UpdateSummaryProperties the device update information summary.

func (UpdateSummaryProperties) MarshalJSON ¶

func (usp UpdateSummaryProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateSummaryProperties.

type UploadCertificateRequest ¶

type UploadCertificateRequest struct {
	// RawCertificateData - The Base 64 encoded certificate raw data.
	*RawCertificateData `json:"properties,omitempty"`
}

UploadCertificateRequest the upload certificate request.

func (UploadCertificateRequest) MarshalJSON ¶

func (ucr UploadCertificateRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UploadCertificateRequest.

func (*UploadCertificateRequest) UnmarshalJSON ¶

func (ucr *UploadCertificateRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UploadCertificateRequest struct.

type UploadCertificateResponse ¶

type UploadCertificateResponse struct {
	autorest.Response `json:"-"`
	// AuthType - Specifies authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory'
	AuthType AuthenticationType `json:"authType,omitempty"`
	// ResourceID - READ-ONLY; The resource ID of the Data Box Edge/Gateway device.
	ResourceID *string `json:"resourceId,omitempty"`
	// AadAuthority - READ-ONLY; Azure Active Directory tenant authority.
	AadAuthority *string `json:"aadAuthority,omitempty"`
	// AadTenantID - READ-ONLY; Azure Active Directory tenant ID.
	AadTenantID *string `json:"aadTenantId,omitempty"`
	// ServicePrincipalClientID - READ-ONLY; Azure Active Directory service principal client ID.
	ServicePrincipalClientID *string `json:"servicePrincipalClientId,omitempty"`
	// ServicePrincipalObjectID - READ-ONLY; Azure Active Directory service principal object ID.
	ServicePrincipalObjectID *string `json:"servicePrincipalObjectId,omitempty"`
	// AzureManagementEndpointAudience - READ-ONLY; The azure management endpoint audience.
	AzureManagementEndpointAudience *string `json:"azureManagementEndpointAudience,omitempty"`
	// AadAudience - READ-ONLY; Identifier of the target resource that is the recipient of the requested token.
	AadAudience *string `json:"aadAudience,omitempty"`
}

UploadCertificateResponse the upload registration certificate response.

func (UploadCertificateResponse) MarshalJSON ¶

func (ucr UploadCertificateResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UploadCertificateResponse.

type User ¶

type User struct {
	autorest.Response `json:"-"`
	// UserProperties - The storage account credential properties.
	*UserProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The object name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty"`
}

User represents a user who has access to one or more shares on the Data Box Edge/Gateway device.

func (User) MarshalJSON ¶

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for User.

func (*User) UnmarshalJSON ¶

func (u *User) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for User struct.

type UserAccessRight ¶

type UserAccessRight struct {
	// UserID - User ID (already existing in the device).
	UserID *string `json:"userId,omitempty"`
	// AccessType - Type of access to be allowed for the user. Possible values include: 'Change', 'Read', 'Custom'
	AccessType ShareAccessType `json:"accessType,omitempty"`
}

UserAccessRight the mapping between a particular user and the access type on the SMB share.

type UserList ¶

type UserList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of users.
	Value *[]User `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

UserList collection of users.

func (UserList) IsEmpty ¶

func (ul UserList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserListIterator ¶

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

UserListIterator provides access to a complete listing of User values.

func NewUserListIterator ¶

func NewUserListIterator(page UserListPage) UserListIterator

Creates a new instance of the UserListIterator type.

func (*UserListIterator) Next ¶

func (iter *UserListIterator) 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 (*UserListIterator) NextWithContext ¶

func (iter *UserListIterator) 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 (UserListIterator) NotDone ¶

func (iter UserListIterator) NotDone() bool

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

func (UserListIterator) Response ¶

func (iter UserListIterator) Response() UserList

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

func (UserListIterator) Value ¶

func (iter UserListIterator) Value() User

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

type UserListPage ¶

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

UserListPage contains a page of User values.

func NewUserListPage ¶

func NewUserListPage(cur UserList, getNextPage func(context.Context, UserList) (UserList, error)) UserListPage

Creates a new instance of the UserListPage type.

func (*UserListPage) Next ¶

func (page *UserListPage) 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 (*UserListPage) NextWithContext ¶

func (page *UserListPage) 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 (UserListPage) NotDone ¶

func (page UserListPage) NotDone() bool

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

func (UserListPage) Response ¶

func (page UserListPage) Response() UserList

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

func (UserListPage) Values ¶

func (page UserListPage) Values() []User

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

type UserProperties ¶

type UserProperties struct {
	// EncryptedPassword - The password details.
	EncryptedPassword *AsymmetricEncryptedSecret `json:"encryptedPassword,omitempty"`
	// ShareAccessRights - List of shares that the user has rights on. This field should not be specified during user creation.
	ShareAccessRights *[]ShareAccessRight `json:"shareAccessRights,omitempty"`
	// UserType - Type of the user. Possible values include: 'UserTypeShare', 'UserTypeLocalManagement', 'UserTypeARM'
	UserType UserType `json:"userType,omitempty"`
}

UserProperties the user properties.

type UserType ¶

type UserType string

UserType enumerates the values for user type.

const (
	// UserTypeARM ...
	UserTypeARM UserType = "ARM"
	// UserTypeLocalManagement ...
	UserTypeLocalManagement UserType = "LocalManagement"
	// UserTypeShare ...
	UserTypeShare UserType = "Share"
)

func PossibleUserTypeValues ¶

func PossibleUserTypeValues() []UserType

PossibleUserTypeValues returns an array of possible values for the UserType const type.

type UsersClient ¶

type UsersClient struct {
	BaseClient
}

UsersClient is the client for the Users methods of the Databoxedge service.

func NewUsersClient ¶

func NewUsersClient(subscriptionID string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func NewUsersClientWithBaseURI ¶

func NewUsersClientWithBaseURI(baseURI string, subscriptionID string) UsersClient

NewUsersClientWithBaseURI creates an instance of the UsersClient 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 (UsersClient) CreateOrUpdate ¶

func (client UsersClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, userParameter User, resourceGroupName string) (result UsersCreateOrUpdateFuture, err error)

CreateOrUpdate creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. name - the user name. userParameter - the user details. resourceGroupName - the resource group name.

func (UsersClient) CreateOrUpdatePreparer ¶

func (client UsersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, userParameter User, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UsersClient) CreateOrUpdateResponder ¶

func (client UsersClient) CreateOrUpdateResponder(resp *http.Response) (result User, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (UsersClient) CreateOrUpdateSender ¶

func (client UsersClient) CreateOrUpdateSender(req *http.Request) (future UsersCreateOrUpdateFuture, err error)

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

func (UsersClient) Delete ¶

func (client UsersClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result UsersDeleteFuture, err error)

Delete deletes the user on a databox edge/gateway device. Parameters: deviceName - the device name. name - the user name. resourceGroupName - the resource group name.

func (UsersClient) DeletePreparer ¶

func (client UsersClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UsersClient) DeleteResponder ¶

func (client UsersClient) 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 (UsersClient) DeleteSender ¶

func (client UsersClient) DeleteSender(req *http.Request) (future UsersDeleteFuture, err error)

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

func (UsersClient) Get ¶

func (client UsersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result User, err error)

Get gets the properties of the specified user. Parameters: deviceName - the device name. name - the user name. resourceGroupName - the resource group name.

func (UsersClient) GetPreparer ¶

func (client UsersClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsersClient) GetResponder ¶

func (client UsersClient) GetResponder(resp *http.Response) (result User, err error)

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

func (UsersClient) GetSender ¶

func (client UsersClient) 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 (UsersClient) ListByDataBoxEdgeDevice ¶

func (client UsersClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result UserListPage, err error)

ListByDataBoxEdgeDevice gets all the users registered on a Data Box Edge/Data Box Gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name. filter - specify $filter='UserType eq <type>' to filter on user type property

func (UsersClient) ListByDataBoxEdgeDeviceComplete ¶

func (client UsersClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result UserListIterator, err error)

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

func (UsersClient) ListByDataBoxEdgeDevicePreparer ¶

func (client UsersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string, filter string) (*http.Request, error)

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (UsersClient) ListByDataBoxEdgeDeviceResponder ¶

func (client UsersClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result UserList, err error)

ListByDataBoxEdgeDeviceResponder handles the response to the ListByDataBoxEdgeDevice request. The method always closes the http.Response Body.

func (UsersClient) ListByDataBoxEdgeDeviceSender ¶

func (client UsersClient) ListByDataBoxEdgeDeviceSender(req *http.Request) (*http.Response, error)

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

type UsersCreateOrUpdateFuture ¶

type UsersCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*UsersCreateOrUpdateFuture) Result ¶

func (future *UsersCreateOrUpdateFuture) Result(client UsersClient) (u User, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type UsersDeleteFuture ¶

type UsersDeleteFuture struct {
	azure.Future
}

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

func (*UsersDeleteFuture) Result ¶

func (future *UsersDeleteFuture) Result(client UsersClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

Directories ¶

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL