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

package edgegateway

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

Package edgegateway implements the Azure ARM Edgegateway service API version 2019-03-01.

Index

Package Files

alerts.go bandwidthschedules.go client.go devices.go jobs.go models.go operations.go operationsstatus.go orders.go roles.go shares.go storageaccountcredentials.go triggers.go users.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type ARMBaseModel Uses

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

ARMBaseModel represents the base class for all object models.

type AccountType Uses

type AccountType string

AccountType enumerates the values for account type.

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

func PossibleAccountTypeValues Uses

func PossibleAccountTypeValues() []AccountType

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

type Address Uses

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 Uses

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

Alert alert on the data box edge/gateway device.

func (Alert) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Alert.

func (*Alert) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Alert struct.

type AlertErrorDetails Uses

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 Uses

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

AlertList collection of alerts.

func (AlertList) IsEmpty Uses

func (al AlertList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AlertListIterator Uses

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

AlertListIterator provides access to a complete listing of Alert values.

func NewAlertListIterator Uses

func NewAlertListIterator(page AlertListPage) AlertListIterator

Creates a new instance of the AlertListIterator type.

func (*AlertListIterator) Next Uses

func (iter *AlertListIterator) Next() error

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

func (*AlertListIterator) NextWithContext Uses

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

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

func (AlertListIterator) NotDone Uses

func (iter AlertListIterator) NotDone() bool

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

func (AlertListIterator) Response Uses

func (iter AlertListIterator) Response() AlertList

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

func (AlertListIterator) Value Uses

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 Uses

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

AlertListPage contains a page of Alert values.

func NewAlertListPage Uses

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

Creates a new instance of the AlertListPage type.

func (*AlertListPage) Next Uses

func (page *AlertListPage) Next() error

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

func (*AlertListPage) NextWithContext Uses

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

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

func (AlertListPage) NotDone Uses

func (page AlertListPage) NotDone() bool

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

func (AlertListPage) Response Uses

func (page AlertListPage) Response() AlertList

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

func (AlertListPage) Values Uses

func (page AlertListPage) Values() []Alert

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

type AlertProperties Uses

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

AlertProperties properties of alert.

func (AlertProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for AlertProperties.

type AlertSeverity Uses

type AlertSeverity string

AlertSeverity enumerates the values for alert severity.

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

func PossibleAlertSeverityValues Uses

func PossibleAlertSeverityValues() []AlertSeverity

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

type AlertsClient Uses

type AlertsClient struct {
    BaseClient
}

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

func NewAlertsClient Uses

func NewAlertsClient(subscriptionID string) AlertsClient

NewAlertsClient creates an instance of the AlertsClient client.

func NewAlertsClientWithBaseURI Uses

func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string) AlertsClient

NewAlertsClientWithBaseURI creates an instance of the AlertsClient client.

func (AlertsClient) Get Uses

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

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

func (AlertsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (AlertsClient) GetResponder Uses

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

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

func (AlertsClient) GetSender Uses

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

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

func (AlertsClient) ListByDataBoxEdgeDevice Uses

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 (AlertsClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (AlertsClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (AlertsClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (AlertsClient) ListByDataBoxEdgeDeviceSender Uses

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 Uses

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 Uses

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

Authentication authentication mechanism for IoT devices.

type AuthenticationType Uses

type AuthenticationType string

AuthenticationType enumerates the values for authentication type.

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

func PossibleAuthenticationTypeValues Uses

func PossibleAuthenticationTypeValues() []AuthenticationType

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

type AzureContainerDataFormat Uses

type AzureContainerDataFormat string

AzureContainerDataFormat enumerates the values for azure container data format.

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

func PossibleAzureContainerDataFormatValues Uses

func PossibleAzureContainerDataFormatValues() []AzureContainerDataFormat

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

type AzureContainerInfo Uses

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 Uses

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

BandwidthSchedule the bandwidth schedule details.

func (BandwidthSchedule) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for BandwidthSchedule.

func (*BandwidthSchedule) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for BandwidthSchedule struct.

type BandwidthScheduleProperties Uses

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 Uses

type BandwidthSchedulesClient struct {
    BaseClient
}

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

func NewBandwidthSchedulesClient Uses

func NewBandwidthSchedulesClient(subscriptionID string) BandwidthSchedulesClient

NewBandwidthSchedulesClient creates an instance of the BandwidthSchedulesClient client.

func NewBandwidthSchedulesClientWithBaseURI Uses

func NewBandwidthSchedulesClientWithBaseURI(baseURI string, subscriptionID string) BandwidthSchedulesClient

NewBandwidthSchedulesClientWithBaseURI creates an instance of the BandwidthSchedulesClient client.

func (BandwidthSchedulesClient) CreateOrUpdate Uses

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

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

func (BandwidthSchedulesClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BandwidthSchedulesClient) CreateOrUpdateResponder Uses

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

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

func (BandwidthSchedulesClient) CreateOrUpdateSender Uses

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

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

func (BandwidthSchedulesClient) Delete Uses

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

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

func (BandwidthSchedulesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (BandwidthSchedulesClient) DeleteResponder Uses

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

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

func (BandwidthSchedulesClient) DeleteSender Uses

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

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

func (BandwidthSchedulesClient) Get Uses

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

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

func (BandwidthSchedulesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (BandwidthSchedulesClient) GetResponder Uses

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

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

func (BandwidthSchedulesClient) GetSender Uses

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

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

func (BandwidthSchedulesClient) ListByDataBoxEdgeDevice Uses

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 (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (BandwidthSchedulesClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceSender Uses

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 Uses

type BandwidthSchedulesCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*BandwidthSchedulesCreateOrUpdateFuture) Result Uses

func (future *BandwidthSchedulesCreateOrUpdateFuture) Result(client BandwidthSchedulesClient) (bs BandwidthSchedule, err error)

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

type BandwidthSchedulesDeleteFuture Uses

type BandwidthSchedulesDeleteFuture struct {
    azure.Future
}

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

func (*BandwidthSchedulesDeleteFuture) Result Uses

func (future *BandwidthSchedulesDeleteFuture) Result(client BandwidthSchedulesClient) (ar autorest.Response, err error)

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

type BandwidthSchedulesList Uses

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

BandwidthSchedulesList the collection of bandwidth schedules.

func (BandwidthSchedulesList) IsEmpty Uses

func (bsl BandwidthSchedulesList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BandwidthSchedulesListIterator Uses

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

BandwidthSchedulesListIterator provides access to a complete listing of BandwidthSchedule values.

func NewBandwidthSchedulesListIterator Uses

func NewBandwidthSchedulesListIterator(page BandwidthSchedulesListPage) BandwidthSchedulesListIterator

Creates a new instance of the BandwidthSchedulesListIterator type.

func (*BandwidthSchedulesListIterator) Next Uses

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

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

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

func (BandwidthSchedulesListIterator) NotDone Uses

func (iter BandwidthSchedulesListIterator) NotDone() bool

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

func (BandwidthSchedulesListIterator) Response Uses

func (iter BandwidthSchedulesListIterator) Response() BandwidthSchedulesList

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

func (BandwidthSchedulesListIterator) Value Uses

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 Uses

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

BandwidthSchedulesListPage contains a page of BandwidthSchedule values.

func NewBandwidthSchedulesListPage Uses

func NewBandwidthSchedulesListPage(getNextPage func(context.Context, BandwidthSchedulesList) (BandwidthSchedulesList, error)) BandwidthSchedulesListPage

Creates a new instance of the BandwidthSchedulesListPage type.

func (*BandwidthSchedulesListPage) Next Uses

func (page *BandwidthSchedulesListPage) Next() error

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

func (*BandwidthSchedulesListPage) NextWithContext Uses

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

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

func (BandwidthSchedulesListPage) NotDone Uses

func (page BandwidthSchedulesListPage) NotDone() bool

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

func (BandwidthSchedulesListPage) Response Uses

func (page BandwidthSchedulesListPage) Response() BandwidthSchedulesList

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

func (BandwidthSchedulesListPage) Values Uses

func (page BandwidthSchedulesListPage) Values() []BandwidthSchedule

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

type BaseClient Uses

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

BaseClient is the base client for Edgegateway.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasicRole Uses

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

BasicRole compute role.

type BasicTrigger Uses

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

BasicTrigger trigger details.

type ClientAccessRight Uses

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

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

type ClientPermissionType Uses

type ClientPermissionType string

ClientPermissionType enumerates the values for client permission type.

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

func PossibleClientPermissionTypeValues Uses

func PossibleClientPermissionTypeValues() []ClientPermissionType

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

type CloudError Uses

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

CloudError an error response from the service.

type CloudErrorBody Uses

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 Uses

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

ContactDetails contains all the contact details of the customer.

type DataBoxEdgeDevice Uses

type DataBoxEdgeDevice 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"`
    // DataBoxEdgeDeviceProperties - The properties of the Data Box Edge/Gateway device.
    *DataBoxEdgeDeviceProperties `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"`
}

DataBoxEdgeDevice the Data Box Edge/Gateway device.

func (DataBoxEdgeDevice) MarshalJSON Uses

func (dbed DataBoxEdgeDevice) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataBoxEdgeDevice.

func (*DataBoxEdgeDevice) UnmarshalJSON Uses

func (dbed *DataBoxEdgeDevice) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DataBoxEdgeDevice struct.

type DataBoxEdgeDeviceExtendedInfo Uses

type DataBoxEdgeDeviceExtendedInfo struct {
    autorest.Response `json:"-"`
    // DataBoxEdgeDeviceExtendedInfoProperties - The extended info properties.
    *DataBoxEdgeDeviceExtendedInfoProperties `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"`
}

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

func (DataBoxEdgeDeviceExtendedInfo) MarshalJSON Uses

func (dbedei DataBoxEdgeDeviceExtendedInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataBoxEdgeDeviceExtendedInfo.

func (*DataBoxEdgeDeviceExtendedInfo) UnmarshalJSON Uses

func (dbedei *DataBoxEdgeDeviceExtendedInfo) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DataBoxEdgeDeviceExtendedInfo struct.

type DataBoxEdgeDeviceExtendedInfoProperties Uses

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

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

type DataBoxEdgeDeviceList Uses

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

DataBoxEdgeDeviceList the collection of Data Box Edge/Gateway devices.

func (DataBoxEdgeDeviceList) IsEmpty Uses

func (dbedl DataBoxEdgeDeviceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DataBoxEdgeDeviceListIterator Uses

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

DataBoxEdgeDeviceListIterator provides access to a complete listing of DataBoxEdgeDevice values.

func NewDataBoxEdgeDeviceListIterator Uses

func NewDataBoxEdgeDeviceListIterator(page DataBoxEdgeDeviceListPage) DataBoxEdgeDeviceListIterator

Creates a new instance of the DataBoxEdgeDeviceListIterator type.

func (*DataBoxEdgeDeviceListIterator) Next Uses

func (iter *DataBoxEdgeDeviceListIterator) 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 (*DataBoxEdgeDeviceListIterator) NextWithContext Uses

func (iter *DataBoxEdgeDeviceListIterator) 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 (DataBoxEdgeDeviceListIterator) NotDone Uses

func (iter DataBoxEdgeDeviceListIterator) NotDone() bool

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

func (DataBoxEdgeDeviceListIterator) Response Uses

func (iter DataBoxEdgeDeviceListIterator) Response() DataBoxEdgeDeviceList

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

func (DataBoxEdgeDeviceListIterator) Value Uses

func (iter DataBoxEdgeDeviceListIterator) Value() DataBoxEdgeDevice

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

type DataBoxEdgeDeviceListPage Uses

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

DataBoxEdgeDeviceListPage contains a page of DataBoxEdgeDevice values.

func NewDataBoxEdgeDeviceListPage Uses

func NewDataBoxEdgeDeviceListPage(getNextPage func(context.Context, DataBoxEdgeDeviceList) (DataBoxEdgeDeviceList, error)) DataBoxEdgeDeviceListPage

Creates a new instance of the DataBoxEdgeDeviceListPage type.

func (*DataBoxEdgeDeviceListPage) Next Uses

func (page *DataBoxEdgeDeviceListPage) 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 (*DataBoxEdgeDeviceListPage) NextWithContext Uses

func (page *DataBoxEdgeDeviceListPage) 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 (DataBoxEdgeDeviceListPage) NotDone Uses

func (page DataBoxEdgeDeviceListPage) NotDone() bool

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

func (DataBoxEdgeDeviceListPage) Response Uses

func (page DataBoxEdgeDeviceListPage) Response() DataBoxEdgeDeviceList

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

func (DataBoxEdgeDeviceListPage) Values Uses

func (page DataBoxEdgeDeviceListPage) Values() []DataBoxEdgeDevice

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

type DataBoxEdgeDevicePatch Uses

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

DataBoxEdgeDevicePatch the Data Box Edge/Gateway device patch.

func (DataBoxEdgeDevicePatch) MarshalJSON Uses

func (dbedp DataBoxEdgeDevicePatch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataBoxEdgeDevicePatch.

type DataBoxEdgeDeviceProperties Uses

type DataBoxEdgeDeviceProperties struct {
    // DataBoxEdgeDeviceStatus - The status of the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', 'Online', 'Offline', 'NeedsAttention', 'Disconnected', 'PartiallyDisconnected'
    DataBoxEdgeDeviceStatus DataBoxEdgeDeviceStatus `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: 'DeviceTypeDataBoxEdgeDevice'
    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"`
}

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

type DataBoxEdgeDeviceStatus Uses

type DataBoxEdgeDeviceStatus string

DataBoxEdgeDeviceStatus enumerates the values for data box edge device status.

const (
    // Disconnected ...
    Disconnected DataBoxEdgeDeviceStatus = "Disconnected"
    // NeedsAttention ...
    NeedsAttention DataBoxEdgeDeviceStatus = "NeedsAttention"
    // Offline ...
    Offline DataBoxEdgeDeviceStatus = "Offline"
    // Online ...
    Online DataBoxEdgeDeviceStatus = "Online"
    // PartiallyDisconnected ...
    PartiallyDisconnected DataBoxEdgeDeviceStatus = "PartiallyDisconnected"
    // ReadyToSetup ...
    ReadyToSetup DataBoxEdgeDeviceStatus = "ReadyToSetup"
)

func PossibleDataBoxEdgeDeviceStatusValues Uses

func PossibleDataBoxEdgeDeviceStatusValues() []DataBoxEdgeDeviceStatus

PossibleDataBoxEdgeDeviceStatusValues returns an array of possible values for the DataBoxEdgeDeviceStatus const type.

type DataPolicy Uses

type DataPolicy string

DataPolicy enumerates the values for data policy.

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

func PossibleDataPolicyValues Uses

func PossibleDataPolicyValues() []DataPolicy

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

type DayOfWeek Uses

type DayOfWeek string

DayOfWeek enumerates the values for day of week.

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

func PossibleDayOfWeekValues Uses

func PossibleDayOfWeekValues() []DayOfWeek

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

type DeviceType Uses

type DeviceType string

DeviceType enumerates the values for device type.

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

func PossibleDeviceTypeValues Uses

func PossibleDeviceTypeValues() []DeviceType

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

type DevicesClient Uses

type DevicesClient struct {
    BaseClient
}

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

func NewDevicesClient Uses

func NewDevicesClient(subscriptionID string) DevicesClient

NewDevicesClient creates an instance of the DevicesClient client.

func NewDevicesClientWithBaseURI Uses

func NewDevicesClientWithBaseURI(baseURI string, subscriptionID string) DevicesClient

NewDevicesClientWithBaseURI creates an instance of the DevicesClient client.

func (DevicesClient) CreateOrUpdate Uses

func (client DevicesClient) CreateOrUpdate(ctx context.Context, deviceName string, dataBoxEdgeDevice DataBoxEdgeDevice, 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 (DevicesClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DevicesClient) CreateOrUpdateResponder Uses

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

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

func (DevicesClient) CreateOrUpdateSecuritySettings Uses

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 (DevicesClient) CreateOrUpdateSecuritySettingsPreparer Uses

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

CreateOrUpdateSecuritySettingsPreparer prepares the CreateOrUpdateSecuritySettings request.

func (DevicesClient) CreateOrUpdateSecuritySettingsResponder Uses

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

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

func (DevicesClient) CreateOrUpdateSecuritySettingsSender Uses

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

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

func (DevicesClient) CreateOrUpdateSender Uses

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

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

func (DevicesClient) Delete Uses

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 (DevicesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (DevicesClient) DeleteResponder Uses

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

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

func (DevicesClient) DeleteSender Uses

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

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

func (DevicesClient) DownloadUpdates Uses

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

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

func (DevicesClient) DownloadUpdatesPreparer Uses

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

DownloadUpdatesPreparer prepares the DownloadUpdates request.

func (DevicesClient) DownloadUpdatesResponder Uses

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

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

func (DevicesClient) DownloadUpdatesSender Uses

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

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

func (DevicesClient) Get Uses

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

Get gets the properties of the data box edge/gateway device. Parameters: deviceName - the device name. resourceGroupName - the resource group name.

func (DevicesClient) GetExtendedInformation Uses

func (client DevicesClient) GetExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string) (result DataBoxEdgeDeviceExtendedInfo, 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 (DevicesClient) GetExtendedInformationPreparer Uses

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

GetExtendedInformationPreparer prepares the GetExtendedInformation request.

func (DevicesClient) GetExtendedInformationResponder Uses

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

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

func (DevicesClient) GetExtendedInformationSender Uses

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

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

func (DevicesClient) GetNetworkSettings Uses

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 (DevicesClient) GetNetworkSettingsPreparer Uses

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

GetNetworkSettingsPreparer prepares the GetNetworkSettings request.

func (DevicesClient) GetNetworkSettingsResponder Uses

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

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

func (DevicesClient) GetNetworkSettingsSender Uses

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

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

func (DevicesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (DevicesClient) GetResponder Uses

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

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

func (DevicesClient) GetSender Uses

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

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

func (DevicesClient) GetUpdateSummary Uses

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

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

func (DevicesClient) GetUpdateSummaryPreparer Uses

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

GetUpdateSummaryPreparer prepares the GetUpdateSummary request.

func (DevicesClient) GetUpdateSummaryResponder Uses

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

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

func (DevicesClient) GetUpdateSummarySender Uses

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

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

func (DevicesClient) InstallUpdates Uses

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

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

func (DevicesClient) InstallUpdatesPreparer Uses

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

InstallUpdatesPreparer prepares the InstallUpdates request.

func (DevicesClient) InstallUpdatesResponder Uses

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

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

func (DevicesClient) InstallUpdatesSender Uses

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

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

func (DevicesClient) ListByResourceGroup Uses

func (client DevicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string) (result DataBoxEdgeDeviceListPage, 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 (DevicesClient) ListByResourceGroupComplete Uses

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

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

func (DevicesClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DevicesClient) ListByResourceGroupResponder Uses

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

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

func (DevicesClient) ListByResourceGroupSender Uses

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

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

func (DevicesClient) ListBySubscription Uses

func (client DevicesClient) ListBySubscription(ctx context.Context, expand string) (result DataBoxEdgeDeviceListPage, 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 (DevicesClient) ListBySubscriptionComplete Uses

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

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

func (DevicesClient) ListBySubscriptionPreparer Uses

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (DevicesClient) ListBySubscriptionResponder Uses

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

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

func (DevicesClient) ListBySubscriptionSender Uses

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

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

func (DevicesClient) ScanForUpdates Uses

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

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

func (DevicesClient) ScanForUpdatesPreparer Uses

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

ScanForUpdatesPreparer prepares the ScanForUpdates request.

func (DevicesClient) ScanForUpdatesResponder Uses

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

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

func (DevicesClient) ScanForUpdatesSender Uses

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

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

func (DevicesClient) Update Uses

func (client DevicesClient) Update(ctx context.Context, deviceName string, parameters DataBoxEdgeDevicePatch, resourceGroupName string) (result DataBoxEdgeDevice, 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 (DevicesClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (DevicesClient) UpdateResponder Uses

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

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

func (DevicesClient) UpdateSender Uses

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

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

func (DevicesClient) UploadCertificate Uses

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

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

func (DevicesClient) UploadCertificatePreparer Uses

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

UploadCertificatePreparer prepares the UploadCertificate request.

func (DevicesClient) UploadCertificateResponder Uses

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

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

func (DevicesClient) UploadCertificateSender Uses

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

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

type DevicesCreateOrUpdateFuture Uses

type DevicesCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*DevicesCreateOrUpdateFuture) Result Uses

func (future *DevicesCreateOrUpdateFuture) Result(client DevicesClient) (dbed DataBoxEdgeDevice, err error)

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

type DevicesCreateOrUpdateSecuritySettingsFuture Uses

type DevicesCreateOrUpdateSecuritySettingsFuture struct {
    azure.Future
}

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

func (*DevicesCreateOrUpdateSecuritySettingsFuture) Result Uses

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

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

type DevicesDeleteFuture Uses

type DevicesDeleteFuture struct {
    azure.Future
}

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

func (*DevicesDeleteFuture) Result Uses

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

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

type DevicesDownloadUpdatesFuture Uses

type DevicesDownloadUpdatesFuture struct {
    azure.Future
}

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

func (*DevicesDownloadUpdatesFuture) Result Uses

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

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

type DevicesInstallUpdatesFuture Uses

type DevicesInstallUpdatesFuture struct {
    azure.Future
}

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

func (*DevicesInstallUpdatesFuture) Result Uses

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

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

type DevicesScanForUpdatesFuture Uses

type DevicesScanForUpdatesFuture struct {
    azure.Future
}

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

func (*DevicesScanForUpdatesFuture) Result Uses

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

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

type DownloadPhase Uses

type DownloadPhase string

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 Uses

func PossibleDownloadPhaseValues() []DownloadPhase

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

type EncryptionAlgorithm Uses

type EncryptionAlgorithm string

EncryptionAlgorithm enumerates the values for encryption algorithm.

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

func PossibleEncryptionAlgorithmValues Uses

func PossibleEncryptionAlgorithmValues() []EncryptionAlgorithm

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

type FileEventTrigger Uses

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

FileEventTrigger trigger details.

func (FileEventTrigger) AsBasicTrigger Uses

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

AsBasicTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsFileEventTrigger Uses

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

AsFileEventTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsPeriodicTimerEventTrigger Uses

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

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) AsTrigger Uses

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

AsTrigger is the BasicTrigger implementation for FileEventTrigger.

func (FileEventTrigger) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for FileEventTrigger.

func (*FileEventTrigger) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for FileEventTrigger struct.

type FileSourceInfo Uses

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

FileSourceInfo file source details.

type FileTriggerProperties Uses

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

FileTriggerProperties file trigger properties.

type InstallRebootBehavior Uses

type InstallRebootBehavior string

InstallRebootBehavior enumerates the values for install reboot behavior.

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

func PossibleInstallRebootBehaviorValues Uses

func PossibleInstallRebootBehaviorValues() []InstallRebootBehavior

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

type IoTDeviceInfo Uses

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 Uses

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

IoTRole compute role.

func (IoTRole) AsBasicRole Uses

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

AsBasicRole is the BasicRole implementation for IoTRole.

func (IoTRole) AsIoTRole Uses

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

AsIoTRole is the BasicRole implementation for IoTRole.

func (IoTRole) AsRole Uses

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

AsRole is the BasicRole implementation for IoTRole.

func (IoTRole) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for IoTRole.

func (*IoTRole) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for IoTRole struct.

type IoTRoleProperties Uses

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

IoTRoleProperties ioT role properties.

type Ipv4Config Uses

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 Uses

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 Uses

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

Job a device job.

func (Job) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Job.

func (*Job) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Job struct.

type JobErrorDetails Uses

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 Uses

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 Uses

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.
    ShareID *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.

type JobStatus Uses

type JobStatus string

JobStatus enumerates the values for job status.

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

func PossibleJobStatusValues Uses

func PossibleJobStatusValues() []JobStatus

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

type JobType Uses

type JobType string

JobType enumerates the values for job type.

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

func PossibleJobTypeValues Uses

func PossibleJobTypeValues() []JobType

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

type JobsClient Uses

type JobsClient struct {
    BaseClient
}

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

func NewJobsClient Uses

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI Uses

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) Get Uses

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

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

func (JobsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder Uses

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

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

func (JobsClient) GetSender Uses

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

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

type Kind Uses

type Kind string

Kind enumerates the values for kind.

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

func PossibleKindValues Uses

func PossibleKindValues() []Kind

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

type KindBasicTrigger Uses

type KindBasicTrigger string

KindBasicTrigger enumerates the values for kind basic trigger.

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

func PossibleKindBasicTriggerValues Uses

func PossibleKindBasicTriggerValues() []KindBasicTrigger

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

type MetricAggregationType Uses

type MetricAggregationType string

MetricAggregationType enumerates the values for metric aggregation type.

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

func PossibleMetricAggregationTypeValues Uses

func PossibleMetricAggregationTypeValues() []MetricAggregationType

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

type MetricCategory Uses

type MetricCategory string

MetricCategory enumerates the values for metric category.

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

func PossibleMetricCategoryValues Uses

func PossibleMetricCategoryValues() []MetricCategory

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

type MetricDimensionV1 Uses

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 Uses

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

MetricSpecificationV1 metric specification version 1.

type MetricUnit Uses

type MetricUnit string

MetricUnit enumerates the values for metric unit.

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

func PossibleMetricUnitValues Uses

func PossibleMetricUnitValues() []MetricUnit

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

type MonitoringStatus Uses

type MonitoringStatus string

MonitoringStatus enumerates the values for monitoring status.

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

func PossibleMonitoringStatusValues Uses

func PossibleMonitoringStatusValues() []MonitoringStatus

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

type MountPointMap Uses

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

MountPointMap the share mount point.

type NetworkAdapter Uses

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.

type NetworkAdapterDHCPStatus Uses

type NetworkAdapterDHCPStatus string

NetworkAdapterDHCPStatus enumerates the values for network adapter dhcp status.

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

func PossibleNetworkAdapterDHCPStatusValues Uses

func PossibleNetworkAdapterDHCPStatusValues() []NetworkAdapterDHCPStatus

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

type NetworkAdapterPosition Uses

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

NetworkAdapterPosition the network adapter position.

type NetworkAdapterRDMAStatus Uses

type NetworkAdapterRDMAStatus string

NetworkAdapterRDMAStatus enumerates the values for network adapter rdma status.

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

func PossibleNetworkAdapterRDMAStatusValues Uses

func PossibleNetworkAdapterRDMAStatusValues() []NetworkAdapterRDMAStatus

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

type NetworkAdapterStatus Uses

type NetworkAdapterStatus string

NetworkAdapterStatus enumerates the values for network adapter status.

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

func PossibleNetworkAdapterStatusValues Uses

func PossibleNetworkAdapterStatusValues() []NetworkAdapterStatus

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

type NetworkGroup Uses

type NetworkGroup string

NetworkGroup enumerates the values for network group.

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

func PossibleNetworkGroupValues Uses

func PossibleNetworkGroupValues() []NetworkGroup

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

type NetworkSettings Uses

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

NetworkSettings the network settings of a device.

func (NetworkSettings) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for NetworkSettings.

func (*NetworkSettings) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for NetworkSettings struct.

type NetworkSettingsProperties Uses

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 Uses

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

Operation operations.

func (Operation) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay Uses

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 Uses

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

OperationProperties operation properties.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

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

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

List sends the list request.

func (OperationsClient) ListComplete Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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

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

func (OperationsClient) ListSender Uses

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

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

type OperationsList Uses

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

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

func (OperationsList) IsEmpty Uses

func (ol OperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListIterator Uses

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

OperationsListIterator provides access to a complete listing of Operation values.

func NewOperationsListIterator Uses

func NewOperationsListIterator(page OperationsListPage) OperationsListIterator

Creates a new instance of the OperationsListIterator type.

func (*OperationsListIterator) Next Uses

func (iter *OperationsListIterator) Next() error

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

func (*OperationsListIterator) NextWithContext Uses

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

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

func (OperationsListIterator) NotDone Uses

func (iter OperationsListIterator) NotDone() bool

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

func (OperationsListIterator) Response Uses

func (iter OperationsListIterator) Response() OperationsList

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

func (OperationsListIterator) Value Uses

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 Uses

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

OperationsListPage contains a page of Operation values.

func NewOperationsListPage Uses

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

Creates a new instance of the OperationsListPage type.

func (*OperationsListPage) Next Uses

func (page *OperationsListPage) Next() error

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

func (*OperationsListPage) NextWithContext Uses

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

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

func (OperationsListPage) NotDone Uses

func (page OperationsListPage) NotDone() bool

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

func (OperationsListPage) Response Uses

func (page OperationsListPage) Response() OperationsList

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

func (OperationsListPage) Values Uses

func (page OperationsListPage) Values() []Operation

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

type OperationsStatusClient Uses

type OperationsStatusClient struct {
    BaseClient
}

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

func NewOperationsStatusClient Uses

func NewOperationsStatusClient(subscriptionID string) OperationsStatusClient

NewOperationsStatusClient creates an instance of the OperationsStatusClient client.

func NewOperationsStatusClientWithBaseURI Uses

func NewOperationsStatusClientWithBaseURI(baseURI string, subscriptionID string) OperationsStatusClient

NewOperationsStatusClientWithBaseURI creates an instance of the OperationsStatusClient client.

func (OperationsStatusClient) Get Uses

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

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

func (OperationsStatusClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (OperationsStatusClient) GetResponder Uses

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

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

func (OperationsStatusClient) GetSender Uses

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

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

type Order Uses

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

Order the order details.

func (Order) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Order.

func (*Order) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Order struct.

type OrderList Uses

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

OrderList list of order entities.

func (OrderList) IsEmpty Uses

func (ol OrderList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OrderListIterator Uses

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

OrderListIterator provides access to a complete listing of Order values.

func NewOrderListIterator Uses

func NewOrderListIterator(page OrderListPage) OrderListIterator

Creates a new instance of the OrderListIterator type.

func (*OrderListIterator) Next Uses

func (iter *OrderListIterator) Next() error

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

func (*OrderListIterator) NextWithContext Uses

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

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

func (OrderListIterator) NotDone Uses

func (iter OrderListIterator) NotDone() bool

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

func (OrderListIterator) Response Uses

func (iter OrderListIterator) Response() OrderList

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

func (OrderListIterator) Value Uses

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 Uses

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

OrderListPage contains a page of Order values.

func NewOrderListPage Uses

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

Creates a new instance of the OrderListPage type.

func (*OrderListPage) Next Uses

func (page *OrderListPage) Next() error

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

func (*OrderListPage) NextWithContext Uses

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

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

func (OrderListPage) NotDone Uses

func (page OrderListPage) NotDone() bool

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

func (OrderListPage) Response Uses

func (page OrderListPage) Response() OrderList

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

func (OrderListPage) Values Uses

func (page OrderListPage) Values() []Order

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

type OrderProperties Uses

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.

type OrderState Uses

type OrderState string

OrderState enumerates the values for order state.

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

func PossibleOrderStateValues Uses

func PossibleOrderStateValues() []OrderState

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

type OrderStatus Uses

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.

type OrdersClient Uses

type OrdersClient struct {
    BaseClient
}

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

func NewOrdersClient Uses

func NewOrdersClient(subscriptionID string) OrdersClient

NewOrdersClient creates an instance of the OrdersClient client.

func NewOrdersClientWithBaseURI Uses

func NewOrdersClientWithBaseURI(baseURI string, subscriptionID string) OrdersClient

NewOrdersClientWithBaseURI creates an instance of the OrdersClient client.

func (OrdersClient) CreateOrUpdate Uses

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 (OrdersClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OrdersClient) CreateOrUpdateResponder Uses

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

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

func (OrdersClient) CreateOrUpdateSender Uses

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

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

func (OrdersClient) Delete Uses

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

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

func (OrdersClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (OrdersClient) DeleteResponder Uses

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

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

func (OrdersClient) DeleteSender Uses

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

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

func (OrdersClient) Get Uses

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

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

func (OrdersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (OrdersClient) GetResponder Uses

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

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

func (OrdersClient) GetSender Uses

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

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

func (OrdersClient) ListByDataBoxEdgeDevice Uses

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

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

func (OrdersClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (OrdersClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (OrdersClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (OrdersClient) ListByDataBoxEdgeDeviceSender Uses

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 Uses

type OrdersCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*OrdersCreateOrUpdateFuture) Result Uses

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

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

type OrdersDeleteFuture Uses

type OrdersDeleteFuture struct {
    azure.Future
}

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

func (*OrdersDeleteFuture) Result Uses

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

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

type PeriodicTimerEventTrigger Uses

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

PeriodicTimerEventTrigger trigger details.

func (PeriodicTimerEventTrigger) AsBasicTrigger Uses

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

AsBasicTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsFileEventTrigger Uses

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

AsFileEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsPeriodicTimerEventTrigger Uses

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

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) AsTrigger Uses

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

AsTrigger is the BasicTrigger implementation for PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for PeriodicTimerEventTrigger.

func (*PeriodicTimerEventTrigger) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for PeriodicTimerEventTrigger struct.

type PeriodicTimerProperties Uses

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 Uses

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.

type PlatformType Uses

type PlatformType string

PlatformType enumerates the values for platform type.

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

func PossiblePlatformTypeValues Uses

func PossiblePlatformTypeValues() []PlatformType

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

type RawCertificateData Uses

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 Uses

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 Uses

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

Role compute role.

func (Role) AsBasicRole Uses

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

AsBasicRole is the BasicRole implementation for Role.

func (Role) AsIoTRole Uses

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

AsIoTRole is the BasicRole implementation for Role.

func (Role) AsRole Uses

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

AsRole is the BasicRole implementation for Role.

func (Role) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Role.

type RoleList Uses

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

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

func (RoleList) IsEmpty Uses

func (rl RoleList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*RoleList) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for RoleList struct.

type RoleListIterator Uses

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

RoleListIterator provides access to a complete listing of Role values.

func NewRoleListIterator Uses

func NewRoleListIterator(page RoleListPage) RoleListIterator

Creates a new instance of the RoleListIterator type.

func (*RoleListIterator) Next Uses

func (iter *RoleListIterator) Next() error

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

func (*RoleListIterator) NextWithContext Uses

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

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

func (RoleListIterator) NotDone Uses

func (iter RoleListIterator) NotDone() bool

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

func (RoleListIterator) Response Uses

func (iter RoleListIterator) Response() RoleList

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

func (RoleListIterator) Value Uses

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 Uses

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

RoleListPage contains a page of BasicRole values.

func NewRoleListPage Uses

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

Creates a new instance of the RoleListPage type.

func (*RoleListPage) Next Uses

func (page *RoleListPage) Next() error

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

func (*RoleListPage) NextWithContext Uses

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

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

func (RoleListPage) NotDone Uses

func (page RoleListPage) NotDone() bool

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

func (RoleListPage) Response Uses

func (page RoleListPage) Response() RoleList

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

func (RoleListPage) Values Uses

func (page RoleListPage) Values() []BasicRole

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

type RoleModel Uses

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

RoleModel ...

func (*RoleModel) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for RoleModel struct.

type RoleSinkInfo Uses

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

RoleSinkInfo compute role against which events will be raised.

type RoleStatus Uses

type RoleStatus string

RoleStatus enumerates the values for role status.

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

func PossibleRoleStatusValues Uses

func PossibleRoleStatusValues() []RoleStatus

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

type RoleTypes Uses

type RoleTypes string

RoleTypes enumerates the values for role types.

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

func PossibleRoleTypesValues Uses

func PossibleRoleTypesValues() []RoleTypes

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

type RolesClient Uses

type RolesClient struct {
    BaseClient
}

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

func NewRolesClient Uses

func NewRolesClient(subscriptionID string) RolesClient

NewRolesClient creates an instance of the RolesClient client.

func NewRolesClientWithBaseURI Uses

func NewRolesClientWithBaseURI(baseURI string, subscriptionID string) RolesClient

NewRolesClientWithBaseURI creates an instance of the RolesClient client.

func (RolesClient) CreateOrUpdate Uses

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

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

func (RolesClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RolesClient) CreateOrUpdateResponder Uses

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

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

func (RolesClient) CreateOrUpdateSender Uses

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

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

func (RolesClient) Delete Uses

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 (RolesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (RolesClient) DeleteResponder Uses

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

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

func (RolesClient) DeleteSender Uses

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

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

func (RolesClient) Get Uses

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

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

func (RolesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (RolesClient) GetResponder Uses

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

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

func (RolesClient) GetSender Uses

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

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

func (RolesClient) ListByDataBoxEdgeDevice Uses

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 (RolesClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (RolesClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (RolesClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (RolesClient) ListByDataBoxEdgeDeviceSender Uses

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

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

type RolesCreateOrUpdateFuture Uses

type RolesCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*RolesCreateOrUpdateFuture) Result Uses

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

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

type RolesDeleteFuture Uses

type RolesDeleteFuture struct {
    azure.Future
}

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

func (*RolesDeleteFuture) Result Uses

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

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

type SSLStatus Uses

type SSLStatus string

SSLStatus enumerates the values for ssl status.

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

func PossibleSSLStatusValues Uses

func PossibleSSLStatusValues() []SSLStatus

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

type SecuritySettings Uses

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

SecuritySettings the security settings of a device.

func (SecuritySettings) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for SecuritySettings.

func (*SecuritySettings) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for SecuritySettings struct.

type SecuritySettingsProperties Uses

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 Uses

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

ServiceSpecification service specification.

type Share Uses

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

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

func (Share) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Share.

func (*Share) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Share struct.

type ShareAccessProtocol Uses

type ShareAccessProtocol string

ShareAccessProtocol enumerates the values for share access protocol.

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

func PossibleShareAccessProtocolValues Uses

func PossibleShareAccessProtocolValues() []ShareAccessProtocol

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

type ShareAccessRight Uses

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

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

type ShareAccessType Uses

type ShareAccessType string

ShareAccessType enumerates the values for share access type.

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

func PossibleShareAccessTypeValues Uses

func PossibleShareAccessTypeValues() []ShareAccessType

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

type ShareList Uses

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

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

func (ShareList) IsEmpty Uses

func (sl ShareList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ShareListIterator Uses

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

ShareListIterator provides access to a complete listing of Share values.

func NewShareListIterator Uses

func NewShareListIterator(page ShareListPage) ShareListIterator

Creates a new instance of the ShareListIterator type.

func (*ShareListIterator) Next Uses

func (iter *ShareListIterator) Next() error

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

func (*ShareListIterator) NextWithContext Uses

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

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

func (ShareListIterator) NotDone Uses

func (iter ShareListIterator) NotDone() bool

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

func (ShareListIterator) Response Uses

func (iter ShareListIterator) Response() ShareList

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

func (ShareListIterator) Value Uses

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 Uses

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

ShareListPage contains a page of Share values.

func NewShareListPage Uses

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

Creates a new instance of the ShareListPage type.

func (*ShareListPage) Next Uses

func (page *ShareListPage) Next() error

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

func (*ShareListPage) NextWithContext Uses

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

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

func (ShareListPage) NotDone Uses

func (page ShareListPage) NotDone() bool

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

func (ShareListPage) Response Uses

func (page ShareListPage) Response() ShareList

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

func (ShareListPage) Values Uses

func (page ShareListPage) Values() []Share

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

type ShareProperties Uses

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

ShareProperties the share properties.

type ShareStatus Uses

type ShareStatus string

ShareStatus enumerates the values for share status.

const (
    // ShareStatusOffline ...
    ShareStatusOffline ShareStatus = "Offline"
    // ShareStatusOnline ...
    ShareStatusOnline ShareStatus = "Online"
)

func PossibleShareStatusValues Uses

func PossibleShareStatusValues() []ShareStatus

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

type SharesClient Uses

type SharesClient struct {
    BaseClient
}

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

func NewSharesClient Uses

func NewSharesClient(subscriptionID string) SharesClient

NewSharesClient creates an instance of the SharesClient client.

func NewSharesClientWithBaseURI Uses

func NewSharesClientWithBaseURI(baseURI string, subscriptionID string) SharesClient

NewSharesClientWithBaseURI creates an instance of the SharesClient client.

func (SharesClient) CreateOrUpdate Uses

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

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

func (SharesClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SharesClient) CreateOrUpdateResponder Uses

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

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

func (SharesClient) CreateOrUpdateSender Uses

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

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

func (SharesClient) Delete Uses

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 (SharesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (SharesClient) DeleteResponder Uses

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

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

func (SharesClient) DeleteSender Uses

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

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

func (SharesClient) Get Uses

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

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

func (SharesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (SharesClient) GetResponder Uses

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

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

func (SharesClient) GetSender Uses

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

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

func (SharesClient) ListByDataBoxEdgeDevice Uses

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

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

func (SharesClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (SharesClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (SharesClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (SharesClient) ListByDataBoxEdgeDeviceSender Uses

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

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

func (SharesClient) Refresh Uses

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

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

func (SharesClient) RefreshPreparer Uses

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

RefreshPreparer prepares the Refresh request.

func (SharesClient) RefreshResponder Uses

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

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

func (SharesClient) RefreshSender Uses

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 Uses

type SharesCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*SharesCreateOrUpdateFuture) Result Uses

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

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

type SharesDeleteFuture Uses

type SharesDeleteFuture struct {
    azure.Future
}

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

func (*SharesDeleteFuture) Result Uses

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

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

type SharesRefreshFuture Uses

type SharesRefreshFuture struct {
    azure.Future
}

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

func (*SharesRefreshFuture) Result Uses

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

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

type Sku Uses

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.

type SkuName Uses

type SkuName string

SkuName enumerates the values for sku name.

const (
    // Edge ...
    Edge SkuName = "Edge"
    // Gateway ...
    Gateway SkuName = "Gateway"
)

func PossibleSkuNameValues Uses

func PossibleSkuNameValues() []SkuName

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

type SkuTier Uses

type SkuTier string

SkuTier enumerates the values for sku tier.

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

func PossibleSkuTierValues Uses

func PossibleSkuTierValues() []SkuTier

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

type StorageAccountCredential Uses

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

StorageAccountCredential the storage account credential.

func (StorageAccountCredential) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for StorageAccountCredential.

func (*StorageAccountCredential) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for StorageAccountCredential struct.

type StorageAccountCredentialList Uses

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

StorageAccountCredentialList the collection of storage account credentials.

func (StorageAccountCredentialList) IsEmpty Uses

func (sacl StorageAccountCredentialList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageAccountCredentialListIterator Uses

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

StorageAccountCredentialListIterator provides access to a complete listing of StorageAccountCredential values.

func NewStorageAccountCredentialListIterator Uses

func NewStorageAccountCredentialListIterator(page StorageAccountCredentialListPage) StorageAccountCredentialListIterator

Creates a new instance of the StorageAccountCredentialListIterator type.

func (*StorageAccountCredentialListIterator) Next Uses

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

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

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

func (StorageAccountCredentialListIterator) NotDone Uses

func (iter StorageAccountCredentialListIterator) NotDone() bool

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

func (StorageAccountCredentialListIterator) Response Uses

func (iter StorageAccountCredentialListIterator) Response() StorageAccountCredentialList

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

func (StorageAccountCredentialListIterator) Value Uses

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 Uses

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

StorageAccountCredentialListPage contains a page of StorageAccountCredential values.

func NewStorageAccountCredentialListPage Uses

func NewStorageAccountCredentialListPage(getNextPage func(context.Context, StorageAccountCredentialList) (StorageAccountCredentialList, error)) StorageAccountCredentialListPage

Creates a new instance of the StorageAccountCredentialListPage type.

func (*StorageAccountCredentialListPage) Next Uses

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

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

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

func (StorageAccountCredentialListPage) NotDone Uses

func (page StorageAccountCredentialListPage) NotDone() bool

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

func (StorageAccountCredentialListPage) Response Uses

func (page StorageAccountCredentialListPage) Response() StorageAccountCredentialList

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

func (StorageAccountCredentialListPage) Values Uses

func (page StorageAccountCredentialListPage) Values() []StorageAccountCredential

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

type StorageAccountCredentialProperties Uses

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 Uses

type StorageAccountCredentialsClient struct {
    BaseClient
}

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

func NewStorageAccountCredentialsClient Uses

func NewStorageAccountCredentialsClient(subscriptionID string) StorageAccountCredentialsClient

NewStorageAccountCredentialsClient creates an instance of the StorageAccountCredentialsClient client.

func NewStorageAccountCredentialsClientWithBaseURI Uses

func NewStorageAccountCredentialsClientWithBaseURI(baseURI string, subscriptionID string) StorageAccountCredentialsClient

NewStorageAccountCredentialsClientWithBaseURI creates an instance of the StorageAccountCredentialsClient client.

func (StorageAccountCredentialsClient) CreateOrUpdate Uses

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

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

func (StorageAccountCredentialsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StorageAccountCredentialsClient) CreateOrUpdateResponder Uses

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

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

func (StorageAccountCredentialsClient) CreateOrUpdateSender Uses

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 (StorageAccountCredentialsClient) Delete Uses

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

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

func (StorageAccountCredentialsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (StorageAccountCredentialsClient) DeleteResponder Uses

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

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

func (StorageAccountCredentialsClient) DeleteSender Uses

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 (StorageAccountCredentialsClient) Get Uses

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

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

func (StorageAccountCredentialsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (StorageAccountCredentialsClient) GetResponder Uses

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

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

func (StorageAccountCredentialsClient) GetSender Uses

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

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

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDevice Uses

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

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

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceComplete Uses

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

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

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceResponder Uses

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

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

func (StorageAccountCredentialsClient) ListByDataBoxEdgeDeviceSender Uses

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 Uses

type StorageAccountCredentialsCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*StorageAccountCredentialsCreateOrUpdateFuture) Result Uses

func (future *StorageAccountCredentialsCreateOrUpdateFuture) Result(client StorageAccountCredentialsClient) (sac StorageAccountCredential, err error)

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

type StorageAccountCredentialsDeleteFuture Uses

type StorageAccountCredentialsDeleteFuture struct {
    azure.Future
}

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

func (*StorageAccountCredentialsDeleteFuture) Result Uses

func (future *StorageAccountCredentialsDeleteFuture) Result(client StorageAccountCredentialsClient) (ar autorest.Response, err error)

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

type SymmetricKey Uses

type SymmetricKey struct {
    // ConnectionString - Connection string based on the symmetric key.
    ConnectionString *AsymmetricEncryptedSecret `json:"connectionString,omitempty"`
}

SymmetricKey symmetric key for authentication.

type TimeGrain Uses

type TimeGrain string

TimeGrain enumerates the values for time grain.

const (
    // PT12H ...
    PT12H TimeGrain = "PT12H"
    // PT15M ...
    PT15M TimeGrain = "PT15M"
    // PT1D ...
    PT1D TimeGrain = "PT1D"
    // PT1H ...
    PT1H TimeGrain = "PT1H"
    // PT1M ...
    PT1M TimeGrain = "PT1M"
    // PT30M ...
    PT30M TimeGrain = "PT30M"
    // PT5M ...
    PT5M TimeGrain = "PT5M"
    // PT6H ...
    PT6H TimeGrain = "PT6H"
)

func PossibleTimeGrainValues Uses

func PossibleTimeGrainValues() []TimeGrain

PossibleTimeGrainValues returns an array of possible values for the TimeGrain const type.

type TrackingInfo Uses

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 Uses

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

Trigger trigger details.

func (Trigger) AsBasicTrigger Uses

func (t Trigger) AsBasicTrigger() (BasicTrigger, bool)

AsBasicTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsFileEventTrigger Uses

func (t Trigger) AsFileEventTrigger() (*FileEventTrigger, bool)

AsFileEventTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsPeriodicTimerEventTrigger Uses

func (t Trigger) AsPeriodicTimerEventTrigger() (*PeriodicTimerEventTrigger, bool)

AsPeriodicTimerEventTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) AsTrigger Uses

func (t Trigger) AsTrigger() (*Trigger, bool)

AsTrigger is the BasicTrigger implementation for Trigger.

func (Trigger) MarshalJSON Uses

func (t Trigger) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Trigger.

type TriggerList Uses

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

TriggerList collection of all trigger on the data box edge device.

func (TriggerList) IsEmpty Uses

func (tl TriggerList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*TriggerList) UnmarshalJSON Uses

func (tl *TriggerList) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TriggerList struct.

type TriggerListIterator Uses

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

TriggerListIterator provides access to a complete listing of Trigger values.

func NewTriggerListIterator Uses

func NewTriggerListIterator(page TriggerListPage) TriggerListIterator

Creates a new instance of the TriggerListIterator type.

func (*TriggerListIterator) Next Uses

func (iter *TriggerListIterator) Next() error

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

func (*TriggerListIterator) NextWithContext Uses

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

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

func (TriggerListIterator) NotDone Uses

func (iter TriggerListIterator) NotDone() bool

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

func (TriggerListIterator) Response Uses

func (iter TriggerListIterator) Response() TriggerList

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

func (TriggerListIterator) Value Uses

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 Uses

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

TriggerListPage contains a page of BasicTrigger values.

func NewTriggerListPage Uses

func NewTriggerListPage(getNextPage func(context.Context, TriggerList) (TriggerList, error)) TriggerListPage

Creates a new instance of the TriggerListPage type.

func (*TriggerListPage) Next Uses

func (page *TriggerListPage) Next() error

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

func (*TriggerListPage) NextWithContext Uses

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

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

func (TriggerListPage) NotDone Uses

func (page TriggerListPage) NotDone() bool

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

func (TriggerListPage) Response Uses

func (page TriggerListPage) Response() TriggerList

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

func (TriggerListPage) Values Uses

func (page TriggerListPage) Values() []BasicTrigger

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

type TriggerModel Uses

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

TriggerModel ...

func (*TriggerModel) UnmarshalJSON Uses

func (tm *TriggerModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TriggerModel struct.

type TriggersClient Uses

type TriggersClient struct {
    BaseClient
}

TriggersClient is the client for the Triggers methods of the Edgegateway service.

func NewTriggersClient Uses

func NewTriggersClient(subscriptionID string) TriggersClient

NewTriggersClient creates an instance of the TriggersClient client.

func NewTriggersClientWithBaseURI Uses

func NewTriggersClientWithBaseURI(baseURI string, subscriptionID string) TriggersClient

NewTriggersClientWithBaseURI creates an instance of the TriggersClient client.

func (TriggersClient) CreateOrUpdate Uses

func (client TriggersClient) CreateOrUpdate(ctx context.Context, deviceName string, name string, trigger BasicTrigger, resourceGroupName string) (result TriggersCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a trigger. Parameters: deviceName - creates or updates a trigger name - the trigger name. trigger - the trigger. resourceGroupName - the resource group name.

func (TriggersClient) CreateOrUpdatePreparer Uses

func (client TriggersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, trigger BasicTrigger, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TriggersClient) CreateOrUpdateResponder Uses

func (client TriggersClient) CreateOrUpdateResponder(resp *http.Response) (result TriggerModel, err error)

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

func (TriggersClient) CreateOrUpdateSender Uses

func (client TriggersClient) CreateOrUpdateSender(req *http.Request) (future TriggersCreateOrUpdateFuture, err error)

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

func (TriggersClient) Delete Uses

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

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

func (TriggersClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (TriggersClient) DeleteResponder Uses

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

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

func (TriggersClient) DeleteSender Uses

func (client TriggersClient) DeleteSender(req *http.Request) (future TriggersDeleteFuture, err error)

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

func (TriggersClient) Get Uses

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

Get get a specific trigger by name. Parameters: deviceName - the device name. name - the trigger name. resourceGroupName - the resource group name.

func (TriggersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (TriggersClient) GetResponder Uses

func (client TriggersClient) GetResponder(resp *http.Response) (result TriggerModel, err error)

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

func (TriggersClient) GetSender Uses

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

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

func (TriggersClient) ListByDataBoxEdgeDevice Uses

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 (TriggersClient) ListByDataBoxEdgeDeviceComplete Uses

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 (TriggersClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (TriggersClient) ListByDataBoxEdgeDeviceResponder Uses

func (client TriggersClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result TriggerList, err error)

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

func (TriggersClient) ListByDataBoxEdgeDeviceSender Uses

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 Uses

type TriggersCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*TriggersCreateOrUpdateFuture) Result Uses

func (future *TriggersCreateOrUpdateFuture) Result(client TriggersClient) (tm TriggerModel, err error)

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

type TriggersDeleteFuture Uses

type TriggersDeleteFuture struct {
    azure.Future
}

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

func (*TriggersDeleteFuture) Result Uses

func (future *TriggersDeleteFuture) Result(client TriggersClient) (ar autorest.Response, err error)

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

type UpdateDownloadProgress Uses

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 Uses

type UpdateInstallProgress struct {
    // PercentComplete - READ-ONLY; Percentage completed.
    PercentComplete *int32 `json:"percentComplete,omitempty"`
    // NumberOfUpdatesToInstall - READ-ONLY; Number of updates to install.
    NumberOfUpdatesToInstall *int32 `json:"numberOfUpdatesToInstall,omitempty"`
    // NumberOfUpdatesInstalled - READ-ONLY; Number of updates installed.
    NumberOfUpdatesInstalled *int32 `json:"numberOfUpdatesInstalled,omitempty"`
}

UpdateInstallProgress progress details during installation of updates.

type UpdateOperation Uses

type UpdateOperation string

UpdateOperation enumerates the values for update operation.

const (
    // UpdateOperationDownload ...
    UpdateOperationDownload UpdateOperation = "Download"
    // UpdateOperationInstall ...
    UpdateOperationInstall UpdateOperation = "Install"
    // UpdateOperationNone ...
    UpdateOperationNone UpdateOperation = "None"
    // UpdateOperationScan ...
    UpdateOperationScan UpdateOperation = "Scan"
)

func PossibleUpdateOperationValues Uses

func PossibleUpdateOperationValues() []UpdateOperation

PossibleUpdateOperationValues returns an array of possible values for the UpdateOperation const type.

type UpdateOperationStage Uses

type UpdateOperationStage string

UpdateOperationStage enumerates the values for update operation stage.

const (
    // UpdateOperationStageDownloadComplete ...
    UpdateOperationStageDownloadComplete UpdateOperationStage = "DownloadComplete"
    // UpdateOperationStageDownloadFailed ...
    UpdateOperationStageDownloadFailed UpdateOperationStage = "DownloadFailed"
    // UpdateOperationStageDownloadStarted ...
    UpdateOperationStageDownloadStarted UpdateOperationStage = "DownloadStarted"
    // UpdateOperationStageFailure ...
    UpdateOperationStageFailure UpdateOperationStage = "Failure"
    // UpdateOperationStageInitial ...
    UpdateOperationStageInitial UpdateOperationStage = "Initial"
    // UpdateOperationStageInstallComplete ...
    UpdateOperationStageInstallComplete UpdateOperationStage = "InstallComplete"
    // UpdateOperationStageInstallFailed ...
    UpdateOperationStageInstallFailed UpdateOperationStage = "InstallFailed"
    // UpdateOperationStageInstallStarted ...
    UpdateOperationStageInstallStarted UpdateOperationStage = "InstallStarted"
    // UpdateOperationStageRebootInitiated ...
    UpdateOperationStageRebootInitiated UpdateOperationStage = "RebootInitiated"
    // UpdateOperationStageRescanComplete ...
    UpdateOperationStageRescanComplete UpdateOperationStage = "RescanComplete"
    // UpdateOperationStageRescanFailed ...
    UpdateOperationStageRescanFailed UpdateOperationStage = "RescanFailed"
    // UpdateOperationStageRescanStarted ...
    UpdateOperationStageRescanStarted UpdateOperationStage = "RescanStarted"
    // UpdateOperationStageScanComplete ...
    UpdateOperationStageScanComplete UpdateOperationStage = "ScanComplete"
    // UpdateOperationStageScanFailed ...
    UpdateOperationStageScanFailed UpdateOperationStage = "ScanFailed"
    // UpdateOperationStageScanStarted ...
    UpdateOperationStageScanStarted UpdateOperationStage = "ScanStarted"
    // UpdateOperationStageSuccess ...
    UpdateOperationStageSuccess UpdateOperationStage = "Success"
    // UpdateOperationStageUnknown ...
    UpdateOperationStageUnknown UpdateOperationStage = "Unknown"
)

func PossibleUpdateOperationStageValues Uses

func PossibleUpdateOperationStageValues() []UpdateOperationStage

PossibleUpdateOperationStageValues returns an array of possible values for the UpdateOperationStage const type.

type UpdateSummary Uses

type UpdateSummary struct {
    autorest.Response `json:"-"`
    // UpdateSummaryProperties - The device update information summary.
    *UpdateSummaryProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The path ID that uniquely identifies the object.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The object name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The hierarchical type of the object.
    Type *string `json:"type,omitempty"`
}

UpdateSummary details about ongoing updates and availability of updates on the device.

func (UpdateSummary) MarshalJSON Uses

func (us UpdateSummary) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateSummary.

func (*UpdateSummary) UnmarshalJSON Uses

func (us *UpdateSummary) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UpdateSummary struct.

type UpdateSummaryProperties Uses

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.

type UploadCertificateRequest Uses

type UploadCertificateRequest struct {
    // RawCertificateData - The Base 64 encoded certificate raw data.
    *RawCertificateData `json:"properties,omitempty"`
}

UploadCertificateRequest the upload certificate request.

func (UploadCertificateRequest) MarshalJSON Uses

func (ucr UploadCertificateRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UploadCertificateRequest.

func (*UploadCertificateRequest) UnmarshalJSON Uses

func (ucr *UploadCertificateRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UploadCertificateRequest struct.

type UploadCertificateResponse Uses

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 Uses

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

User represents a user who has access to one or more shares on the Data Box Edge/Gateway device.

func (User) MarshalJSON Uses

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for User.

func (*User) UnmarshalJSON Uses

func (u *User) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for User struct.

type UserAccessRight Uses

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 Uses

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

UserList collection of users.

func (UserList) IsEmpty Uses

func (ul UserList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserListIterator Uses

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

UserListIterator provides access to a complete listing of User values.

func NewUserListIterator Uses

func NewUserListIterator(page UserListPage) UserListIterator

Creates a new instance of the UserListIterator type.

func (*UserListIterator) Next Uses

func (iter *UserListIterator) Next() error

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

func (*UserListIterator) NextWithContext Uses

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

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

func (UserListIterator) NotDone Uses

func (iter UserListIterator) NotDone() bool

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

func (UserListIterator) Response Uses

func (iter UserListIterator) Response() UserList

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

func (UserListIterator) Value Uses

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 Uses

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

UserListPage contains a page of User values.

func NewUserListPage Uses

func NewUserListPage(getNextPage func(context.Context, UserList) (UserList, error)) UserListPage

Creates a new instance of the UserListPage type.

func (*UserListPage) Next Uses

func (page *UserListPage) Next() error

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

func (*UserListPage) NextWithContext Uses

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

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

func (UserListPage) NotDone Uses

func (page UserListPage) NotDone() bool

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

func (UserListPage) Response Uses

func (page UserListPage) Response() UserList

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

func (UserListPage) Values Uses

func (page UserListPage) Values() []User

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

type UserProperties Uses

type UserProperties struct {
    // EncryptedPassword - The password details.
    EncryptedPassword *AsymmetricEncryptedSecret `json:"encryptedPassword,omitempty"`
    // ShareAccessRights - List of shares that the user has rights on. This field should not be specified during user creation.
    ShareAccessRights *[]ShareAccessRight `json:"shareAccessRights,omitempty"`
}

UserProperties the user properties.

type UsersClient Uses

type UsersClient struct {
    BaseClient
}

UsersClient is the client for the Users methods of the Edgegateway service.

func NewUsersClient Uses

func NewUsersClient(subscriptionID string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func NewUsersClientWithBaseURI Uses

func NewUsersClientWithBaseURI(baseURI string, subscriptionID string) UsersClient

NewUsersClientWithBaseURI creates an instance of the UsersClient client.

func (UsersClient) CreateOrUpdate Uses

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 (UsersClient) CreateOrUpdatePreparer Uses

func (client UsersClient) CreateOrUpdatePreparer(ctx context.Context, deviceName string, name string, userParameter User, resourceGroupName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UsersClient) CreateOrUpdateResponder Uses

func (client UsersClient) CreateOrUpdateResponder(resp *http.Response) (result User, err error)

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

func (UsersClient) CreateOrUpdateSender Uses

func (client UsersClient) CreateOrUpdateSender(req *http.Request) (future UsersCreateOrUpdateFuture, err error)

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

func (UsersClient) Delete Uses

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

Delete deletes the user on a databox edge/gateway device. Parameters: deviceName - the device name. name - the user name. resourceGroupName - the resource group name.

func (UsersClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (UsersClient) DeleteResponder Uses

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

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

func (UsersClient) DeleteSender Uses

func (client UsersClient) DeleteSender(req *http.Request) (future UsersDeleteFuture, err error)

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

func (UsersClient) Get Uses

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

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

func (UsersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (UsersClient) GetResponder Uses

func (client UsersClient) GetResponder(resp *http.Response) (result User, err error)

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

func (UsersClient) GetSender Uses

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

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

func (UsersClient) ListByDataBoxEdgeDevice Uses

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 (UsersClient) ListByDataBoxEdgeDeviceComplete Uses

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 (UsersClient) ListByDataBoxEdgeDevicePreparer Uses

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

ListByDataBoxEdgeDevicePreparer prepares the ListByDataBoxEdgeDevice request.

func (UsersClient) ListByDataBoxEdgeDeviceResponder Uses

func (client UsersClient) ListByDataBoxEdgeDeviceResponder(resp *http.Response) (result UserList, err error)

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

func (UsersClient) ListByDataBoxEdgeDeviceSender Uses

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

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

type UsersCreateOrUpdateFuture Uses

type UsersCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*UsersCreateOrUpdateFuture) Result Uses

func (future *UsersCreateOrUpdateFuture) Result(client UsersClient) (u User, err error)

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

type UsersDeleteFuture Uses

type UsersDeleteFuture struct {
    azure.Future
}

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

func (*UsersDeleteFuture) Result Uses

func (future *UsersDeleteFuture) Result(client UsersClient) (ar autorest.Response, err error)

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

Directories

PathSynopsis
edgegatewayapi

Package edgegateway imports 10 packages (graph) and is imported by 3 packages. Updated 2019-08-03. Refresh now. Tools for package owners.