import "github.com/Azure/azure-sdk-for-go/services/databoxedge/mgmt/2019-03-01/databoxedge"
Package databoxedge implements the Azure ARM Databoxedge service API version 2019-03-01.
alerts.go bandwidthschedules.go client.go devices.go enums.go jobs.go models.go operations.go operationsstatus.go orders.go roles.go shares.go storageaccountcredentials.go triggers.go users.go version.go
const (
// DefaultBaseURI is the default URI used for the service Databoxedge
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
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.
AccountType enumerates the values for account type.
const (
// BlobStorage ...
BlobStorage AccountType = "BlobStorage"
// GeneralPurposeStorage ...
GeneralPurposeStorage AccountType = "GeneralPurposeStorage"
)func PossibleAccountTypeValues() []AccountType
PossibleAccountTypeValues returns an array of possible values for the AccountType const type.
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 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.
MarshalJSON is the custom marshaler for Alert.
UnmarshalJSON is the custom unmarshaler for Alert struct.
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 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.
IsEmpty returns true if the ListResult contains no values.
type AlertListIterator struct {
// contains filtered or unexported fields
}AlertListIterator provides access to a complete listing of Alert values.
func NewAlertListIterator(page AlertListPage) AlertListIterator
Creates a new instance of the AlertListIterator type.
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 (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 (iter AlertListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AlertListIterator) Response() AlertList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}AlertListPage contains a page of Alert values.
func NewAlertListPage(cur AlertList, getNextPage func(context.Context, AlertList) (AlertList, error)) AlertListPage
Creates a new instance of the AlertListPage type.
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 (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 (page AlertListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AlertListPage) Response() AlertList
Response returns the raw server response from the last page request.
func (page AlertListPage) Values() []Alert
Values returns the slice of values for the current page or nil if there are no values.
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 (ap AlertProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertProperties.
AlertSeverity enumerates the values for alert severity.
const (
// Critical ...
Critical AlertSeverity = "Critical"
// Informational ...
Informational AlertSeverity = "Informational"
// Warning ...
Warning AlertSeverity = "Warning"
)func PossibleAlertSeverityValues() []AlertSeverity
PossibleAlertSeverityValues returns an array of possible values for the AlertSeverity const type.
type AlertsClient struct {
BaseClient
}AlertsClient is the client for the Alerts methods of the Databoxedge service.
func NewAlertsClient(subscriptionID string) AlertsClient
NewAlertsClient creates an instance of the AlertsClient client.
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 (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 (client AlertsClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
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 (client AlertsClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 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 struct {
// SymmetricKey - Symmetric key for authentication.
SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
}Authentication authentication mechanism for IoT devices.
AuthenticationType enumerates the values for authentication type.
const (
// AzureActiveDirectory ...
AzureActiveDirectory AuthenticationType = "AzureActiveDirectory"
// Invalid ...
Invalid AuthenticationType = "Invalid"
)func PossibleAuthenticationTypeValues() []AuthenticationType
PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.
AzureContainerDataFormat enumerates the values for azure container data format.
const (
// AzureFile ...
AzureFile AzureContainerDataFormat = "AzureFile"
// BlockBlob ...
BlockBlob AzureContainerDataFormat = "BlockBlob"
// PageBlob ...
PageBlob AzureContainerDataFormat = "PageBlob"
)func PossibleAzureContainerDataFormatValues() []AzureContainerDataFormat
PossibleAzureContainerDataFormatValues returns an array of possible values for the AzureContainerDataFormat const type.
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 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 (bs BandwidthSchedule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BandwidthSchedule.
func (bs *BandwidthSchedule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BandwidthSchedule struct.
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 struct {
BaseClient
}BandwidthSchedulesClient is the client for the BandwidthSchedules methods of the Databoxedge service.
func NewBandwidthSchedulesClient(subscriptionID string) BandwidthSchedulesClient
NewBandwidthSchedulesClient creates an instance of the BandwidthSchedulesClient client.
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 (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 (client BandwidthSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, parameters BandwidthSchedule, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client BandwidthSchedulesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client BandwidthSchedulesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
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 (client BandwidthSchedulesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(BandwidthSchedulesClient) (BandwidthSchedule, error)
}BandwidthSchedulesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type BandwidthSchedulesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(BandwidthSchedulesClient) (autorest.Response, error)
}BandwidthSchedulesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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 (bsl BandwidthSchedulesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type BandwidthSchedulesListIterator struct {
// contains filtered or unexported fields
}BandwidthSchedulesListIterator provides access to a complete listing of BandwidthSchedule values.
func NewBandwidthSchedulesListIterator(page BandwidthSchedulesListPage) BandwidthSchedulesListIterator
Creates a new instance of the BandwidthSchedulesListIterator type.
func (iter *BandwidthSchedulesListIterator) 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 (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 (iter BandwidthSchedulesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter BandwidthSchedulesListIterator) Response() BandwidthSchedulesList
Response returns the raw server response from the last page request.
func (iter BandwidthSchedulesListIterator) Value() BandwidthSchedule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type BandwidthSchedulesListPage struct {
// contains filtered or unexported fields
}BandwidthSchedulesListPage contains a page of BandwidthSchedule values.
func NewBandwidthSchedulesListPage(cur BandwidthSchedulesList, getNextPage func(context.Context, BandwidthSchedulesList) (BandwidthSchedulesList, error)) BandwidthSchedulesListPage
Creates a new instance of the BandwidthSchedulesListPage type.
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 (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 (page BandwidthSchedulesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page BandwidthSchedulesListPage) Response() BandwidthSchedulesList
Response returns the raw server response from the last page request.
func (page BandwidthSchedulesListPage) Values() []BandwidthSchedule
Values returns the slice of values for the current page or nil if there are no values.
BaseClient is the base client for Databoxedge.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
BasicRole compute role.
type BasicTrigger interface {
AsFileEventTrigger() (*FileEventTrigger, bool)
AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)
AsTrigger() (*Trigger, bool)
}BasicTrigger trigger details.
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.
ClientPermissionType enumerates the values for client permission type.
const (
// NoAccess ...
NoAccess ClientPermissionType = "NoAccess"
// ReadOnly ...
ReadOnly ClientPermissionType = "ReadOnly"
// ReadWrite ...
ReadWrite ClientPermissionType = "ReadWrite"
)func PossibleClientPermissionTypeValues() []ClientPermissionType
PossibleClientPermissionTypeValues returns an array of possible values for the ClientPermissionType const type.
type CloudError struct {
// Error - The error details.
Error *CloudErrorBody `json:"error,omitempty"`
}CloudError an error response from the service.
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 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.
DataPolicy enumerates the values for data policy.
const (
// Cloud ...
Cloud DataPolicy = "Cloud"
// Local ...
Local DataPolicy = "Local"
)func PossibleDataPolicyValues() []DataPolicy
PossibleDataPolicyValues returns an array of possible values for the DataPolicy const type.
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"
)PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.
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.
MarshalJSON is the custom marshaler for Device.
UnmarshalJSON is the custom unmarshaler for Device struct.
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 (dei DeviceExtendedInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceExtendedInfo.
func (dei *DeviceExtendedInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DeviceExtendedInfo struct.
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 (deip DeviceExtendedInfoProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceExtendedInfoProperties.
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 (dl DeviceList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DeviceListIterator struct {
// contains filtered or unexported fields
}DeviceListIterator provides access to a complete listing of Device values.
func NewDeviceListIterator(page DeviceListPage) DeviceListIterator
Creates a new instance of the DeviceListIterator type.
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 (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 (iter DeviceListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DeviceListIterator) Response() DeviceList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}DeviceListPage contains a page of Device values.
func NewDeviceListPage(cur DeviceList, getNextPage func(context.Context, DeviceList) (DeviceList, error)) DeviceListPage
Creates a new instance of the DeviceListPage type.
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 (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 (page DeviceListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DeviceListPage) Response() DeviceList
Response returns the raw server response from the last page request.
func (page DeviceListPage) Values() []Device
Values returns the slice of values for the current page or nil if there are no values.
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 (dp DevicePatch) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DevicePatch.
type DeviceProperties struct {
// DataBoxEdgeDeviceStatus - The status of the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', 'Online', 'Offline', 'NeedsAttention', 'Disconnected', 'PartiallyDisconnected'
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"`
}DeviceProperties the properties of the Data Box Edge/Gateway device.
func (dp DeviceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceProperties.
DeviceStatus enumerates the values for device status.
const (
// Disconnected ...
Disconnected DeviceStatus = "Disconnected"
// NeedsAttention ...
NeedsAttention DeviceStatus = "NeedsAttention"
// Offline ...
Offline DeviceStatus = "Offline"
// Online ...
Online DeviceStatus = "Online"
// PartiallyDisconnected ...
PartiallyDisconnected DeviceStatus = "PartiallyDisconnected"
// ReadyToSetup ...
ReadyToSetup DeviceStatus = "ReadyToSetup"
)func PossibleDeviceStatusValues() []DeviceStatus
PossibleDeviceStatusValues returns an array of possible values for the DeviceStatus const type.
DeviceType enumerates the values for device type.
const (
// DataBoxEdgeDevice ...
DataBoxEdgeDevice DeviceType = "DataBoxEdgeDevice"
)func PossibleDeviceTypeValues() []DeviceType
PossibleDeviceTypeValues returns an array of possible values for the DeviceType const type.
type DevicesClient struct {
BaseClient
}DevicesClient is the client for the Devices methods of the Databoxedge service.
func NewDevicesClient(subscriptionID string) DevicesClient
NewDevicesClient creates an instance of the DevicesClient client.
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 (client DevicesClient) CreateOrUpdate(ctx context.Context, deviceName string, dataBoxEdgeDevice Device, resourceGroupName string) (result DevicesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a Data Box Edge/Gateway resource. Parameters: deviceName - the device name. dataBoxEdgeDevice - the resource object. resourceGroupName - the resource group name.
func (client DevicesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, dataBoxEdgeDevice Device, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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/gateway device. Parameters: deviceName - the device name. securitySettings - the security settings. resourceGroupName - the resource group name.
func (client DevicesClient) CreateOrUpdateSecuritySettingsPreparer(ctx context.Context, deviceName string, securitySettings SecuritySettings, resourceGroupName string) (*http.Request, error)
CreateOrUpdateSecuritySettingsPreparer prepares the CreateOrUpdateSecuritySettings request.
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 (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 (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 (client DevicesClient) Delete(ctx context.Context, deviceName string, resourceGroupName string) (result DevicesDeleteFuture, err error)
Delete deletes the data box edge/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
func (client DevicesClient) DeletePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client DevicesClient) DownloadUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
DownloadUpdatesPreparer prepares the DownloadUpdates request.
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 (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 (client DevicesClient) Get(ctx context.Context, deviceName string, resourceGroupName string) (result Device, err error)
Get gets the properties of the data box edge/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
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/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
func (client DevicesClient) GetExtendedInformationPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
GetExtendedInformationPreparer prepares the GetExtendedInformation request.
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 (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 (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/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
func (client DevicesClient) GetNetworkSettingsPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
GetNetworkSettingsPreparer prepares the GetNetworkSettings request.
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.
GetNetworkSettingsSender sends the GetNetworkSettings request. The method will close the http.Response Body if it receives an error.
func (client DevicesClient) GetPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client DevicesClient) GetUpdateSummaryPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
GetUpdateSummaryPreparer prepares the GetUpdateSummary request.
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.
GetUpdateSummarySender sends the GetUpdateSummary request. The method will close the http.Response Body if it receives an error.
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 (client DevicesClient) InstallUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
InstallUpdatesPreparer prepares the InstallUpdates request.
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 (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 (client DevicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string) (result DeviceListPage, err error)
ListByResourceGroup gets all the data box edge/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 (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 (client DevicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DevicesClient) ListBySubscription(ctx context.Context, expand string) (result DeviceListPage, err error)
ListBySubscription gets all the data box edge/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 (client DevicesClient) ListBySubscriptionComplete(ctx context.Context, expand string) (result DeviceListIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client DevicesClient) ListBySubscriptionPreparer(ctx context.Context, expand string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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.
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
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 (client DevicesClient) ScanForUpdatesPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ScanForUpdatesPreparer prepares the ScanForUpdates request.
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 (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 (client DevicesClient) Update(ctx context.Context, deviceName string, parameters DevicePatch, resourceGroupName string) (result Device, err error)
Update modifies a Data Box Edge/Gateway resource. Parameters: deviceName - the device name. parameters - the resource parameters. resourceGroupName - the resource group name.
func (client DevicesClient) UpdatePreparer(ctx context.Context, deviceName string, parameters DevicePatch, resourceGroupName string) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
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 (client DevicesClient) UploadCertificatePreparer(ctx context.Context, deviceName string, parameters UploadCertificateRequest, resourceGroupName string) (*http.Request, error)
UploadCertificatePreparer prepares the UploadCertificate request.
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.
UploadCertificateSender sends the UploadCertificate request. The method will close the http.Response Body if it receives an error.
type DevicesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (Device, error)
}DevicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DevicesCreateOrUpdateSecuritySettingsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (autorest.Response, error)
}DevicesCreateOrUpdateSecuritySettingsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DevicesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (autorest.Response, error)
}DevicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DevicesDownloadUpdatesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (autorest.Response, error)
}DevicesDownloadUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DevicesInstallUpdatesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (autorest.Response, error)
}DevicesInstallUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DevicesScanForUpdatesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DevicesClient) (autorest.Response, error)
}DevicesScanForUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DownloadPhase enumerates the values for download phase.
const (
// Downloading ...
Downloading DownloadPhase = "Downloading"
// Initializing ...
Initializing DownloadPhase = "Initializing"
// Unknown ...
Unknown DownloadPhase = "Unknown"
// Verifying ...
Verifying DownloadPhase = "Verifying"
)func PossibleDownloadPhaseValues() []DownloadPhase
PossibleDownloadPhaseValues returns an array of possible values for the DownloadPhase const type.
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() []EncryptionAlgorithm
PossibleEncryptionAlgorithmValues returns an array of possible values for the EncryptionAlgorithm const type.
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 (fet FileEventTrigger) AsBasicTrigger() (BasicTrigger, bool)
AsBasicTrigger is the BasicTrigger implementation for FileEventTrigger.
func (fet FileEventTrigger) AsFileEventTrigger() (*FileEventTrigger, bool)
AsFileEventTrigger is the BasicTrigger implementation for FileEventTrigger.
func (fet FileEventTrigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)
AsPeriodicTimerEventTrigger is the BasicTrigger implementation for FileEventTrigger.
func (fet FileEventTrigger) AsTrigger() (*Trigger, bool)
AsTrigger is the BasicTrigger implementation for FileEventTrigger.
func (fet FileEventTrigger) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FileEventTrigger.
func (fet *FileEventTrigger) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FileEventTrigger struct.
FileSourceInfo file source details.
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.
InstallRebootBehavior enumerates the values for install reboot behavior.
const (
// NeverReboots ...
NeverReboots InstallRebootBehavior = "NeverReboots"
// RequestReboot ...
RequestReboot InstallRebootBehavior = "RequestReboot"
// RequiresReboot ...
RequiresReboot InstallRebootBehavior = "RequiresReboot"
)func PossibleInstallRebootBehaviorValues() []InstallRebootBehavior
PossibleInstallRebootBehaviorValues returns an array of possible values for the InstallRebootBehavior const type.
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"`
// Authentication - IoT device authentication info.
Authentication *Authentication `json:"authentication,omitempty"`
}IoTDeviceInfo metadata of IoT device/IoT Edge device to be configured.
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.
AsBasicRole is the BasicRole implementation for IoTRole.
AsIoTRole is the BasicRole implementation for IoTRole.
AsRole is the BasicRole implementation for IoTRole.
MarshalJSON is the custom marshaler for IoTRole.
UnmarshalJSON is the custom unmarshaler for IoTRole struct.
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).
*[]MountPointMap `json:"shareMappings,omitempty"`
// RoleStatus - Role status. Possible values include: 'RoleStatusEnabled', 'RoleStatusDisabled'
RoleStatus RoleStatus `json:"roleStatus,omitempty"`
}IoTRoleProperties ioT role properties.
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 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 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.
MarshalJSON is the custom marshaler for Job.
UnmarshalJSON is the custom unmarshaler for Job struct.
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 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 struct {
// JobType - READ-ONLY; The type of the job. Possible values include: 'JobTypeInvalid', 'JobTypeScanForUpdates', 'JobTypeDownloadUpdates', 'JobTypeInstallUpdates', 'JobTypeRefreshShare'
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"`
// ShareID - READ-ONLY; ARM ID of the share that was refreshed.
*string `json:"shareId,omitempty"`
// Folder - If only subfolders need to be refreshed, then the subfolder path inside the share. (The path is empty if there are no subfolders.)
Folder *string `json:"folder,omitempty"`
}JobProperties the properties for the job.
func (jp JobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for JobProperties.
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"
)PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
JobType enumerates the values for job type.
const (
// JobTypeDownloadUpdates ...
JobTypeDownloadUpdates JobType = "DownloadUpdates"
// JobTypeInstallUpdates ...
JobTypeInstallUpdates JobType = "InstallUpdates"
// JobTypeInvalid ...
JobTypeInvalid JobType = "Invalid"
// JobTypeRefreshShare ...
JobType = "RefreshShare"
// JobTypeScanForUpdates ...
JobTypeScanForUpdates JobType = "ScanForUpdates"
)PossibleJobTypeValues returns an array of possible values for the JobType const type.
type JobsClient struct {
BaseClient
}JobsClient is the client for the Jobs methods of the Databoxedge service.
func NewJobsClient(subscriptionID string) JobsClient
NewJobsClient creates an instance of the JobsClient client.
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 (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 (client JobsClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
Kind enumerates the values for kind.
PossibleKindValues returns an array of possible values for the Kind const type.
KindBasicTrigger enumerates the values for kind basic trigger.
const (
// KindFileEvent ...
KindFileEvent KindBasicTrigger = "FileEvent"
// KindPeriodicTimerEvent ...
KindPeriodicTimerEvent KindBasicTrigger = "PeriodicTimerEvent"
// KindTrigger ...
KindTrigger KindBasicTrigger = "Trigger"
)func PossibleKindBasicTriggerValues() []KindBasicTrigger
PossibleKindBasicTriggerValues returns an array of possible values for the KindBasicTrigger const type.
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() []MetricAggregationType
PossibleMetricAggregationTypeValues returns an array of possible values for the MetricAggregationType const type.
MetricCategory enumerates the values for metric category.
const (
// Capacity ...
Capacity MetricCategory = "Capacity"
// Transaction ...
Transaction MetricCategory = "Transaction"
)func PossibleMetricCategoryValues() []MetricCategory
PossibleMetricCategoryValues returns an array of possible values for the MetricCategory const type.
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 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.
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() []MetricUnit
PossibleMetricUnitValues returns an array of possible values for the MetricUnit const type.
MonitoringStatus enumerates the values for monitoring status.
const (
// Disabled ...
Disabled MonitoringStatus = "Disabled"
// Enabled ...
Enabled MonitoringStatus = "Enabled"
)func PossibleMonitoringStatusValues() []MonitoringStatus
PossibleMonitoringStatusValues returns an array of possible values for the MonitoringStatus const type.
type MountPointMap struct {
// ShareID - ID of the share mounted to the role VM.
*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 (mpm MountPointMap) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MountPointMap.
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 (na NetworkAdapter) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NetworkAdapter.
NetworkAdapterDHCPStatus enumerates the values for network adapter dhcp status.
const (
// NetworkAdapterDHCPStatusDisabled ...
NetworkAdapterDHCPStatusDisabled NetworkAdapterDHCPStatus = "Disabled"
// NetworkAdapterDHCPStatusEnabled ...
NetworkAdapterDHCPStatusEnabled NetworkAdapterDHCPStatus = "Enabled"
)func PossibleNetworkAdapterDHCPStatusValues() []NetworkAdapterDHCPStatus
PossibleNetworkAdapterDHCPStatusValues returns an array of possible values for the NetworkAdapterDHCPStatus const type.
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.
NetworkAdapterRDMAStatus enumerates the values for network adapter rdma status.
const (
// Capable ...
Capable NetworkAdapterRDMAStatus = "Capable"
// Incapable ...
Incapable NetworkAdapterRDMAStatus = "Incapable"
)func PossibleNetworkAdapterRDMAStatusValues() []NetworkAdapterRDMAStatus
PossibleNetworkAdapterRDMAStatusValues returns an array of possible values for the NetworkAdapterRDMAStatus const type.
NetworkAdapterStatus enumerates the values for network adapter status.
const (
// Active ...
Active NetworkAdapterStatus = "Active"
// Inactive ...
Inactive NetworkAdapterStatus = "Inactive"
)func PossibleNetworkAdapterStatusValues() []NetworkAdapterStatus
PossibleNetworkAdapterStatusValues returns an array of possible values for the NetworkAdapterStatus const type.
NetworkGroup enumerates the values for network group.
const (
// NetworkGroupNone ...
NetworkGroupNone NetworkGroup = "None"
// NetworkGroupNonRDMA ...
NetworkGroupNonRDMA NetworkGroup = "NonRDMA"
// NetworkGroupRDMA ...
NetworkGroupRDMA NetworkGroup = "RDMA"
)func PossibleNetworkGroupValues() []NetworkGroup
PossibleNetworkGroupValues returns an array of possible values for the NetworkGroup const type.
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 (ns NetworkSettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NetworkSettings.
func (ns *NetworkSettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NetworkSettings struct.
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 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.
MarshalJSON is the custom marshaler for Operation.
UnmarshalJSON is the custom unmarshaler for Operation struct.
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 struct {
// ServiceSpecification - Service specification.
ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}OperationProperties operation properties.
type OperationsClient struct {
BaseClient
}OperationsClient is the client for the Operations methods of the Databoxedge service.
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationsListPage, err error)
List sends the list request.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationsListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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 (ol OperationsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationsListIterator struct {
// contains filtered or unexported fields
}OperationsListIterator provides access to a complete listing of Operation values.
func NewOperationsListIterator(page OperationsListPage) OperationsListIterator
Creates a new instance of the OperationsListIterator type.
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 (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 (iter OperationsListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationsListIterator) Response() OperationsList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}OperationsListPage contains a page of Operation values.
func NewOperationsListPage(cur OperationsList, getNextPage func(context.Context, OperationsList) (OperationsList, error)) OperationsListPage
Creates a new instance of the OperationsListPage type.
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 (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 (page OperationsListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationsListPage) Response() OperationsList
Response returns the raw server response from the last page request.
func (page OperationsListPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsStatusClient struct {
BaseClient
}OperationsStatusClient is the client for the OperationsStatus methods of the Databoxedge service.
func NewOperationsStatusClient(subscriptionID string) OperationsStatusClient
NewOperationsStatusClient creates an instance of the OperationsStatusClient client.
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 (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 (client OperationsStatusClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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.
MarshalJSON is the custom marshaler for Order.
UnmarshalJSON is the custom unmarshaler for Order struct.
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.
IsEmpty returns true if the ListResult contains no values.
type OrderListIterator struct {
// contains filtered or unexported fields
}OrderListIterator provides access to a complete listing of Order values.
func NewOrderListIterator(page OrderListPage) OrderListIterator
Creates a new instance of the OrderListIterator type.
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 (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 (iter OrderListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OrderListIterator) Response() OrderList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}OrderListPage contains a page of Order values.
func NewOrderListPage(cur OrderList, getNextPage func(context.Context, OrderList) (OrderList, error)) OrderListPage
Creates a new instance of the OrderListPage type.
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 (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 (page OrderListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OrderListPage) Response() OrderList
Response returns the raw server response from the last page request.
func (page OrderListPage) Values() []Order
Values returns the slice of values for the current page or nil if there are no values.
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 (op OrderProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OrderProperties.
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() []OrderState
PossibleOrderStateValues returns an array of possible values for the OrderState const type.
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"`
}OrderStatus represents a single status change.
func (osVar OrderStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OrderStatus.
type OrdersClient struct {
BaseClient
}OrdersClient is the client for the Orders methods of the Databoxedge service.
func NewOrdersClient(subscriptionID string) OrdersClient
NewOrdersClient creates an instance of the OrdersClient client.
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 (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 device name. order - the order to be created or updated. resourceGroupName - the resource group name.
func (client OrdersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, order Order, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
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 (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 (client OrdersClient) DeletePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client OrdersClient) GetPreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client OrdersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(OrdersClient) (Order, error)
}OrdersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type OrdersDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(OrdersClient) (autorest.Response, error)
}OrdersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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 (ptet PeriodicTimerEventTrigger) AsBasicTrigger() (BasicTrigger, bool)
AsBasicTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.
func (ptet PeriodicTimerEventTrigger) AsFileEventTrigger() (*FileEventTrigger, bool)
AsFileEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.
func (ptet PeriodicTimerEventTrigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)
AsPeriodicTimerEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.
func (ptet PeriodicTimerEventTrigger) AsTrigger() (*Trigger, bool)
AsTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.
func (ptet PeriodicTimerEventTrigger) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PeriodicTimerEventTrigger.
func (ptet *PeriodicTimerEventTrigger) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PeriodicTimerEventTrigger struct.
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 struct {
// StartTime - The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to 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.
PlatformType enumerates the values for platform type.
const (
// Linux ...
Linux PlatformType = "Linux"
// Windows ...
Windows PlatformType = "Windows"
)func PossiblePlatformTypeValues() []PlatformType
PossiblePlatformTypeValues returns an array of possible values for the PlatformType const type.
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 struct {
// InProgressRefreshJobID - If a refresh share job is currently in progress on this share, 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, 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, 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,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.
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.
AsBasicRole is the BasicRole implementation for Role.
AsIoTRole is the BasicRole implementation for Role.
AsRole is the BasicRole implementation for Role.
MarshalJSON is the custom marshaler for Role.
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.
IsEmpty returns true if the ListResult contains no values.
UnmarshalJSON is the custom unmarshaler for RoleList struct.
type RoleListIterator struct {
// contains filtered or unexported fields
}RoleListIterator provides access to a complete listing of Role values.
func NewRoleListIterator(page RoleListPage) RoleListIterator
Creates a new instance of the RoleListIterator type.
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 (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 (iter RoleListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RoleListIterator) Response() RoleList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}RoleListPage contains a page of BasicRole values.
func NewRoleListPage(cur RoleList, getNextPage func(context.Context, RoleList) (RoleList, error)) RoleListPage
Creates a new instance of the RoleListPage type.
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 (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 (page RoleListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RoleListPage) Response() RoleList
Response returns the raw server response from the last page request.
func (page RoleListPage) Values() []BasicRole
Values returns the slice of values for the current page or nil if there are no values.
RoleModel ...
UnmarshalJSON is the custom unmarshaler for RoleModel struct.
RoleSinkInfo compute role against which events will be raised.
RoleStatus enumerates the values for role status.
const (
// RoleStatusDisabled ...
RoleStatusDisabled RoleStatus = "Disabled"
// RoleStatusEnabled ...
RoleStatusEnabled RoleStatus = "Enabled"
)func PossibleRoleStatusValues() []RoleStatus
PossibleRoleStatusValues returns an array of possible values for the RoleStatus const type.
RoleTypes enumerates the values for role types.
const (
// ASA ...
ASA RoleTypes = "ASA"
// Cognitive ...
Cognitive RoleTypes = "Cognitive"
// Functions ...
Functions RoleTypes = "Functions"
// IOT ...
IOT RoleTypes = "IOT"
)PossibleRoleTypesValues returns an array of possible values for the RoleTypes const type.
type RolesClient struct {
BaseClient
}RolesClient is the client for the Roles methods of the Databoxedge service.
func NewRolesClient(subscriptionID string) RolesClient
NewRolesClient creates an instance of the RolesClient client.
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 (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 (client RolesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, role BasicRole, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (client RolesClient) Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result RolesDeleteFuture, err error)
Delete deletes the role on the data box edge device. Parameters: deviceName - the device name. name - the role name. resourceGroupName - the resource group name.
func (client RolesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client RolesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
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 (client RolesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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.
ListByDataBoxEdgeDeviceSender sends the ListByDataBoxEdgeDevice request. The method will close the http.Response Body if it receives an error.
type RolesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RolesClient) (RoleModel, error)
}RolesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RolesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RolesClient) (autorest.Response, error)
}RolesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
SSLStatus enumerates the values for ssl status.
const (
// SSLStatusDisabled ...
SSLStatusDisabled SSLStatus = "Disabled"
// SSLStatusEnabled ...
SSLStatusEnabled SSLStatus = "Enabled"
)PossibleSSLStatusValues returns an array of possible values for the SSLStatus const type.
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 (ss SecuritySettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SecuritySettings.
func (ss *SecuritySettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SecuritySettings struct.
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 struct {
// MetricSpecifications - Metric specification as defined by shoebox.
MetricSpecifications *[]MetricSpecificationV1 `json:"metricSpecifications,omitempty"`
}ServiceSpecification service specification.
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.
*string `json:"id,omitempty"`
// Name - READ-ONLY; The object name.
*string `json:"name,omitempty"`
// Type - READ-ONLY; The hierarchical type of the object.
*string `json:"type,omitempty"`
}Share represents a share on the Data Box Edge/Gateway device.
MarshalJSON is the custom marshaler for Share.
UnmarshalJSON is the custom unmarshaler for Share struct.
ShareAccessProtocol enumerates the values for share access protocol.
const (
// NFS ...
NFS ShareAccessProtocol = "NFS"
// SMB ...
SMB ShareAccessProtocol = "SMB"
)func PossibleShareAccessProtocolValues() []ShareAccessProtocol
PossibleShareAccessProtocolValues returns an array of possible values for the ShareAccessProtocol const type.
type ShareAccessRight struct {
// ShareID - The share ID.
*string `json:"shareId,omitempty"`
// AccessType - Type of access to be allowed on the share for this user. Possible values include: 'Change', 'Read', 'Custom'
ShareAccessType `json:"accessType,omitempty"`
}ShareAccessRight specifies the mapping between this particular user and the type of access he has on shares on this device.
ShareAccessType enumerates the values for share access type.
const (
// Change ...
Change ShareAccessType = "Change"
// Custom ...
Custom ShareAccessType = "Custom"
// Read ...
Read ShareAccessType = "Read"
)func PossibleShareAccessTypeValues() []ShareAccessType
PossibleShareAccessTypeValues returns an array of possible values for the ShareAccessType const type.
type ShareList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of shares.
*[]Share `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to the next set of results.
*string `json:"nextLink,omitempty"`
}ShareList collection of all the shares on the Data Box Edge/Gateway device.
IsEmpty returns true if the ListResult contains no values.
type ShareListIterator struct {
// contains filtered or unexported fields
}ShareListIterator provides access to a complete listing of Share values.
func NewShareListIterator(page ShareListPage) ShareListIterator
Creates a new instance of the ShareListIterator type.
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 (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 (iter ShareListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ShareListIterator) Response() ShareList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}ShareListPage contains a page of Share values.
func NewShareListPage(cur ShareList, getNextPage func(context.Context, ShareList) (ShareList, error)) ShareListPage
Creates a new instance of the ShareListPage type.
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 (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 (page ShareListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ShareListPage) Response() ShareList
Response returns the raw server response from the last page request.
func (page ShareListPage) Values() []Share
Values returns the slice of values for the current page or nil if there are no values.
type ShareProperties struct {
// Description - Description for the share.
*string `json:"description,omitempty"`
// ShareStatus - Current status of the share. Possible values include: 'ShareStatusOnline', 'ShareStatusOffline'
ShareStatus `json:"shareStatus,omitempty"`
// MonitoringStatus - Current monitoring status of the share. Possible values include: 'Enabled', 'Disabled'
MonitoringStatus `json:"monitoringStatus,omitempty"`
// AzureContainerInfo - Azure container mapping for the share.
*AzureContainerInfo `json:"azureContainerInfo,omitempty"`
// AccessProtocol - Access protocol to be used by the share. Possible values include: 'SMB', 'NFS'
ShareAccessProtocol `json:"accessProtocol,omitempty"`
// UserAccessRights - Mapping of users and corresponding access rights on the share (required for SMB protocol).
*[]UserAccessRight `json:"userAccessRights,omitempty"`
// ClientAccessRights - List of IP addresses and corresponding access rights on the share(required for NFS protocol).
*[]ClientAccessRight `json:"clientAccessRights,omitempty"`
// RefreshDetails - Details of the refresh job on this share.
*RefreshDetails `json:"refreshDetails,omitempty"`
// ShareMappings - READ-ONLY; Share mount point to the role.
*[]MountPointMap `json:"shareMappings,omitempty"`
// DataPolicy - Data policy of the share. Possible values include: 'Cloud', 'Local'
DataPolicy `json:"dataPolicy,omitempty"`
}ShareProperties the share properties.
func (sp ShareProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ShareProperties.
ShareStatus enumerates the values for share status.
const (
// ShareStatusOffline ...
ShareStatus = "Offline"
// ShareStatusOnline ...
ShareStatus = "Online"
)func PossibleShareStatusValues() []ShareStatus
PossibleShareStatusValues returns an array of possible values for the ShareStatus const type.
type SharesClient struct {
BaseClient
}SharesClient is the client for the Shares methods of the Databoxedge service.
func NewSharesClient(subscriptionID string) SharesClient
NewSharesClient creates an instance of the SharesClient client.
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 (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 (client SharesClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, share Share, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
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 (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/gateway device. Parameters: deviceName - the device name. name - the share name. resourceGroupName - the resource group name.
func (client SharesClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client SharesClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client SharesClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 (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 (client SharesClient) RefreshPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
RefreshPreparer prepares the Refresh request.
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 (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 struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func(SharesClient) (Share, error)
}SharesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SharesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func(SharesClient) (autorest.Response, error)
}SharesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SharesRefreshFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func(SharesClient) (autorest.Response, error)
}SharesRefreshFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Sku struct {
// Name - SKU name. Possible values include: 'Gateway', 'Edge'
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.
SkuName enumerates the values for sku name.
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
SkuTier enumerates the values for sku tier.
PossibleSkuTierValues returns an array of possible values for the SkuTier const type.
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 (sac StorageAccountCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for StorageAccountCredential.
func (sac *StorageAccountCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for StorageAccountCredential struct.
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 (sacl StorageAccountCredentialList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type StorageAccountCredentialListIterator struct {
// contains filtered or unexported fields
}StorageAccountCredentialListIterator provides access to a complete listing of StorageAccountCredential values.
func NewStorageAccountCredentialListIterator(page StorageAccountCredentialListPage) StorageAccountCredentialListIterator
Creates a new instance of the StorageAccountCredentialListIterator type.
func (iter *StorageAccountCredentialListIterator) 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 (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 (iter StorageAccountCredentialListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter StorageAccountCredentialListIterator) Response() StorageAccountCredentialList
Response returns the raw server response from the last page request.
func (iter StorageAccountCredentialListIterator) Value() StorageAccountCredential
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type StorageAccountCredentialListPage struct {
// contains filtered or unexported fields
}StorageAccountCredentialListPage contains a page of StorageAccountCredential values.
func NewStorageAccountCredentialListPage(cur StorageAccountCredentialList, getNextPage func(context.Context, StorageAccountCredentialList) (StorageAccountCredentialList, error)) StorageAccountCredentialListPage
Creates a new instance of the StorageAccountCredentialListPage type.
func (page *StorageAccountCredentialListPage) 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 (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 (page StorageAccountCredentialListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page StorageAccountCredentialListPage) Response() StorageAccountCredentialList
Response returns the raw server response from the last page request.
func (page StorageAccountCredentialListPage) Values() []StorageAccountCredential
Values returns the slice of values for the current page or nil if there are no values.
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"`
}StorageAccountCredentialProperties the storage account credential properties.
type StorageAccountCredentialsClient struct {
BaseClient
}StorageAccountCredentialsClient is the client for the StorageAccountCredentials methods of the Databoxedge service.
func NewStorageAccountCredentialsClient(subscriptionID string) StorageAccountCredentialsClient
NewStorageAccountCredentialsClient creates an instance of the StorageAccountCredentialsClient client.
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 (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 (client StorageAccountCredentialsClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, storageAccountCredential StorageAccountCredential, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (client StorageAccountCredentialsClient) CreateOrUpdateSender(req *http.Request) (future StorageAccountCredentialsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
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 (client StorageAccountCredentialsClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client StorageAccountCredentialsClient) DeleteSender(req *http.Request) (future StorageAccountCredentialsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
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 (client StorageAccountCredentialsClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client StorageAccountCredentialsClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(StorageAccountCredentialsClient) (StorageAccountCredential, error)
}StorageAccountCredentialsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type StorageAccountCredentialsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(StorageAccountCredentialsClient) (autorest.Response, error)
}StorageAccountCredentialsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SymmetricKey struct {
// ConnectionString - Connection string based on the symmetric key.
ConnectionString *AsymmetricEncryptedSecret `json:"connectionString,omitempty"`
}SymmetricKey symmetric key for authentication.
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"
)PossibleTimeGrainValues returns an array of possible values for the TimeGrain const type.
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 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 (t Trigger) AsBasicTrigger() (BasicTrigger, bool)
AsBasicTrigger is the BasicTrigger implementation for Trigger.
func (t Trigger) AsFileEventTrigger() (*FileEventTrigger, bool)
AsFileEventTrigger is the BasicTrigger implementation for Trigger.
func (t Trigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)
AsPeriodicTimerEventTrigger is the BasicTrigger implementation for Trigger.
AsTrigger is the BasicTrigger implementation for Trigger.
MarshalJSON is the custom marshaler for Trigger.
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 (tl TriggerList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (tl *TriggerList) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TriggerList struct.
type TriggerListIterator struct {
// contains filtered or unexported fields
}TriggerListIterator provides access to a complete listing of Trigger values.
func NewTriggerListIterator(page TriggerListPage) TriggerListIterator
Creates a new instance of the TriggerListIterator type.
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 (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 (iter TriggerListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TriggerListIterator) Response() TriggerList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}TriggerListPage contains a page of BasicTrigger values.
func NewTriggerListPage(cur TriggerList, getNextPage func(context.Context, TriggerList) (TriggerList, error)) TriggerListPage
Creates a new instance of the TriggerListPage type.
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 (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 (page TriggerListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TriggerListPage) Response() TriggerList
Response returns the raw server response from the last page request.
func (page TriggerListPage) Values() []BasicTrigger
Values returns the slice of values for the current page or nil if there are no values.
type TriggerModel struct {
autorest.Response `json:"-"`
Value BasicTrigger `json:"value,omitempty"`
}TriggerModel ...
func (tm *TriggerModel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TriggerModel struct.
type TriggersClient struct {
BaseClient
}TriggersClient is the client for the Triggers methods of the Databoxedge service.
func NewTriggersClient(subscriptionID string) TriggersClient
NewTriggersClient creates an instance of the TriggersClient client.
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 (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 (client TriggersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, trigger BasicTrigger, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client TriggersClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client TriggersClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client TriggersClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string, expand string) (result TriggerListPage, err error)
ListByDataBoxEdgeDevice lists all the triggers configured in the device. Parameters: deviceName - the device name. resourceGroupName - the resource group name. expand - specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property
func (client TriggersClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string, expand string) (result TriggerListIterator, err error)
ListByDataBoxEdgeDeviceComplete enumerates all values, automatically crossing page boundaries as required.
func (client TriggersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string, expand string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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 (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 struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TriggersClient) (TriggerModel, error)
}TriggersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TriggersDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TriggersClient) (autorest.Response, error)
}TriggersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UpdateDownloadProgress struct {
// DownloadPhase - READ-ONLY; The download phase. Possible values include: 'Unknown', 'Initializing', 'Downloading', 'Verifying'
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 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.
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() []UpdateOperation
PossibleUpdateOperationValues returns an array of possible values for the UpdateOperation const type.
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() []UpdateOperationStage
PossibleUpdateOperationStageValues returns an array of possible values for the UpdateOperationStage const type.
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 (us UpdateSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateSummary.
func (us *UpdateSummary) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UpdateSummary struct.
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 (usp UpdateSummaryProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateSummaryProperties.
type UploadCertificateRequest struct {
// RawCertificateData - The Base 64 encoded certificate raw data.
*RawCertificateData `json:"properties,omitempty"`
}UploadCertificateRequest the upload certificate request.
func (ucr UploadCertificateRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UploadCertificateRequest.
func (ucr *UploadCertificateRequest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UploadCertificateRequest struct.
type UploadCertificateResponse struct {
autorest.Response `json:"-"`
// AuthType - Specifies authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory'
AuthType AuthenticationType `json:"authType,omitempty"`
// ResourceID - The resource ID of the Data Box Edge/Gateway device.
ResourceID *string `json:"resourceId,omitempty"`
// AadAuthority - Azure Active Directory tenant authority.
AadAuthority *string `json:"aadAuthority,omitempty"`
// AadTenantID - Azure Active Directory tenant ID.
AadTenantID *string `json:"aadTenantId,omitempty"`
// ServicePrincipalClientID - Azure Active Directory service principal client ID.
ServicePrincipalClientID *string `json:"servicePrincipalClientId,omitempty"`
// ServicePrincipalObjectID - Azure Active Directory service principal object ID.
ServicePrincipalObjectID *string `json:"servicePrincipalObjectId,omitempty"`
// AzureManagementEndpointAudience - The azure management endpoint audience.
AzureManagementEndpointAudience *string `json:"azureManagementEndpointAudience,omitempty"`
}UploadCertificateResponse the upload registration certificate response.
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.
MarshalJSON is the custom marshaler for User.
UnmarshalJSON is the custom unmarshaler for User struct.
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 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.
IsEmpty returns true if the ListResult contains no values.
type UserListIterator struct {
// contains filtered or unexported fields
}UserListIterator provides access to a complete listing of User values.
func NewUserListIterator(page UserListPage) UserListIterator
Creates a new instance of the UserListIterator type.
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 (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 (iter UserListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter UserListIterator) Response() UserList
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}UserListPage contains a page of User values.
func NewUserListPage(cur UserList, getNextPage func(context.Context, UserList) (UserList, error)) UserListPage
Creates a new instance of the UserListPage type.
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 (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 (page UserListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page UserListPage) Response() UserList
Response returns the raw server response from the last page request.
func (page UserListPage) Values() []User
Values returns the slice of values for the current page or nil if there are no values.
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.
*[]ShareAccessRight `json:"shareAccessRights,omitempty"`
}UserProperties the user properties.
type UsersClient struct {
BaseClient
}UsersClient is the client for the Users methods of the Databoxedge service.
func NewUsersClient(subscriptionID string) UsersClient
NewUsersClient creates an instance of the UsersClient client.
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 (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/gateway device. Parameters: deviceName - the device name. name - the user name. userParameter - the user details. resourceGroupName - the resource group name.
func (client UsersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, userParameter User, resourceGroupName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
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 (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 (client UsersClient) DeletePreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client UsersClient) GetPreparer(ctx context.Context, deviceName string, name string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client UsersClient) ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result UserListPage, err error)
ListByDataBoxEdgeDevice gets all the users registered on a data box edge/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.
func (client UsersClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result UserListIterator, err error)
ListByDataBoxEdgeDeviceComplete enumerates all values, automatically crossing page boundaries as required.
func (client UsersClient) ListByDataBoxEdgeDevicePreparer(ctx context.Context, deviceName string, resourceGroupName string) (*http.Request, error)
ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.
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.
ListByDataBoxEdgeDeviceSender sends the ListByDataBoxEdgeDevice request. The method will close the http.Response Body if it receives an error.
type UsersCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(UsersClient) (User, error)
}UsersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UsersDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(UsersClient) (autorest.Response, error)
}UsersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
| Path | Synopsis |
|---|---|
| databoxedgeapi |
Package databoxedge imports 10 packages (graph) and is imported by 2 packages. Updated 2021-01-20. Refresh now. Tools for package owners.