armdataboxedge

package
v20200901.0.0-...-6ade699 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ARMBaseModel 

type ARMBaseModel struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ARMBaseModel - Represents the base class for all object models.

func (ARMBaseModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ARMBaseModel.

func (*ARMBaseModel) UnmarshalJSON 

func (a *ARMBaseModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ARMBaseModel.

type AccountType 

type AccountType string

AccountType - Type of storage accessed on the storage account. 

const (
	AccountTypeBlobStorage           AccountType = "BlobStorage"
	AccountTypeGeneralPurposeStorage AccountType = "GeneralPurposeStorage"
)

func PossibleAccountTypeValues 

func PossibleAccountTypeValues() []AccountType

PossibleAccountTypeValues returns the possible values for the AccountType const type.

type Address 

type Address struct {
	// REQUIRED; The address line1.
	AddressLine1 *string `json:"addressLine1,omitempty"`

	// REQUIRED; The city name.
	City *string `json:"city,omitempty"`

	// REQUIRED; The country name.
	Country *string `json:"country,omitempty"`

	// REQUIRED; The postal code.
	PostalCode *string `json:"postalCode,omitempty"`

	// REQUIRED; The state name.
	State *string `json:"state,omitempty"`

	// The address line2.
	AddressLine2 *string `json:"addressLine2,omitempty"`

	// The address line3.
	AddressLine3 *string `json:"addressLine3,omitempty"`
}

Address - The shipping address of the customer.

func (Address) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Address.

func (*Address) UnmarshalJSON 

func (a *Address) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Address.

type Alert 

type Alert struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Properties of alert.
	Properties *AlertProperties `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Alert on the data box edge/gateway device.

func (Alert) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Alert.

func (*Alert) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Alert.

type AlertErrorDetails 

type AlertErrorDetails struct {
	// READ-ONLY; Error code.
	ErrorCode *string `json:"errorCode,omitempty" azure:"ro"`

	// READ-ONLY; Error Message.
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Number of occurrences.
	Occurrences *int32 `json:"occurrences,omitempty" azure:"ro"`
}

AlertErrorDetails - Error details for the alert.

func (AlertErrorDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertErrorDetails.

func (*AlertErrorDetails) UnmarshalJSON 

func (a *AlertErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertErrorDetails.

type AlertList 

type AlertList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The value.
	Value []*Alert `json:"value,omitempty" azure:"ro"`
}

AlertList - Collection of alerts.

func (AlertList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertList.

func (*AlertList) UnmarshalJSON 

func (a *AlertList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertList.

type AlertProperties 

type AlertProperties struct {
	// READ-ONLY; Alert type.
	AlertType *string `json:"alertType,omitempty" azure:"ro"`

	// READ-ONLY; UTC time when the alert appeared.
	AppearedAtDateTime *time.Time `json:"appearedAtDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Alert details.
	DetailedInformation map[string]*string `json:"detailedInformation,omitempty" azure:"ro"`

	// READ-ONLY; Error details of the alert.
	ErrorDetails *AlertErrorDetails `json:"errorDetails,omitempty" azure:"ro"`

	// READ-ONLY; Alert recommendation.
	Recommendation *string `json:"recommendation,omitempty" azure:"ro"`

	// READ-ONLY; Severity of the alert.
	Severity *AlertSeverity `json:"severity,omitempty" azure:"ro"`

	// READ-ONLY; Alert title.
	Title *string `json:"title,omitempty" azure:"ro"`
}

AlertProperties - Properties of alert.

func (AlertProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertProperties.

func (*AlertProperties) UnmarshalJSON 

func (a *AlertProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertProperties.

type AlertSeverity 

type AlertSeverity string

AlertSeverity - Severity of the alert. 

const (
	AlertSeverityCritical      AlertSeverity = "Critical"
	AlertSeverityInformational AlertSeverity = "Informational"
	AlertSeverityWarning       AlertSeverity = "Warning"
)

func PossibleAlertSeverityValues 

func PossibleAlertSeverityValues() []AlertSeverity

PossibleAlertSeverityValues returns the possible values for the AlertSeverity const type.

type AlertsClient 

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

AlertsClient contains the methods for the Alerts group. Don't use this type directly, use NewAlertsClient() instead.

func NewAlertsClient 

func NewAlertsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AlertsClient, error)

NewAlertsClient creates a new instance of AlertsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AlertsClient) Get 

func (client *AlertsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *AlertsClientGetOptions) (AlertsClientGetResponse, error)

Get - Gets an alert by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The alert name.
  • resourceGroupName - The resource group name.
  • options - AlertsClientGetOptions contains the optional parameters for the AlertsClient.Get method.

func (*AlertsClient) NewListByDataBoxEdgeDevicePager 

func (client *AlertsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *AlertsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[AlertsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the alerts for a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - AlertsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the AlertsClient.NewListByDataBoxEdgeDevicePager method.

type AlertsClientGetOptions 

type AlertsClientGetOptions struct {
}

AlertsClientGetOptions contains the optional parameters for the AlertsClient.Get method.

type AlertsClientGetResponse 

type AlertsClientGetResponse struct {
	Alert
}

AlertsClientGetResponse contains the response from method AlertsClient.Get.

type AlertsClientListByDataBoxEdgeDeviceOptions 

type AlertsClientListByDataBoxEdgeDeviceOptions struct {
}

AlertsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the AlertsClient.NewListByDataBoxEdgeDevicePager method.

type AlertsClientListByDataBoxEdgeDeviceResponse 

type AlertsClientListByDataBoxEdgeDeviceResponse struct {
	AlertList
}

AlertsClientListByDataBoxEdgeDeviceResponse contains the response from method AlertsClient.NewListByDataBoxEdgeDevicePager.

type AsymmetricEncryptedSecret 

type AsymmetricEncryptedSecret struct {
	// REQUIRED; The algorithm used to encrypt "Value".
	EncryptionAlgorithm *EncryptionAlgorithm `json:"encryptionAlgorithm,omitempty"`

	// REQUIRED; The value of the secret.
	Value *string `json:"value,omitempty"`

	// Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null.
	EncryptionCertThumbprint *string `json:"encryptionCertThumbprint,omitempty"`
}

AsymmetricEncryptedSecret - Represent the secrets intended for encryption with asymmetric key pair.

func (AsymmetricEncryptedSecret) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AsymmetricEncryptedSecret.

func (*AsymmetricEncryptedSecret) UnmarshalJSON 

func (a *AsymmetricEncryptedSecret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AsymmetricEncryptedSecret.

type Authentication 

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

Authentication mechanism for IoT devices.

func (Authentication) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Authentication.

func (*Authentication) UnmarshalJSON 

func (a *Authentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Authentication.

type AuthenticationType 

type AuthenticationType string

AuthenticationType - The authentication type. 

const (
	AuthenticationTypeAzureActiveDirectory AuthenticationType = "AzureActiveDirectory"
	AuthenticationTypeInvalid              AuthenticationType = "Invalid"
)

func PossibleAuthenticationTypeValues 

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns the possible values for the AuthenticationType const type.

type AzureContainerDataFormat 

type AzureContainerDataFormat string

AzureContainerDataFormat - Storage format used for the file represented by the share. 

const (
	AzureContainerDataFormatAzureFile AzureContainerDataFormat = "AzureFile"
	AzureContainerDataFormatBlockBlob AzureContainerDataFormat = "BlockBlob"
	AzureContainerDataFormatPageBlob  AzureContainerDataFormat = "PageBlob"
)

func PossibleAzureContainerDataFormatValues 

func PossibleAzureContainerDataFormatValues() []AzureContainerDataFormat

PossibleAzureContainerDataFormatValues returns the possible values for the AzureContainerDataFormat const type.

type AzureContainerInfo 

type AzureContainerInfo struct {
	// REQUIRED; Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
	ContainerName *string `json:"containerName,omitempty"`

	// REQUIRED; Storage format used for the file represented by the share.
	DataFormat *AzureContainerDataFormat `json:"dataFormat,omitempty"`

	// REQUIRED; ID of the storage account credential used to access storage.
	StorageAccountCredentialID *string `json:"storageAccountCredentialId,omitempty"`
}

AzureContainerInfo - Azure container mapping of the endpoint.

func (AzureContainerInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureContainerInfo.

func (*AzureContainerInfo) UnmarshalJSON 

func (a *AzureContainerInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureContainerInfo.

type BandwidthSchedule 

type BandwidthSchedule struct {
	// REQUIRED; The properties of the bandwidth schedule.
	Properties *BandwidthScheduleProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BandwidthSchedule - The bandwidth schedule details.

func (BandwidthSchedule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BandwidthSchedule.

func (*BandwidthSchedule) UnmarshalJSON 

func (b *BandwidthSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthSchedule.

type BandwidthScheduleProperties 

type BandwidthScheduleProperties struct {
	// REQUIRED; The days of the week when this schedule is applicable.
	Days []*DayOfWeek `json:"days,omitempty"`

	// REQUIRED; The bandwidth rate in Mbps.
	RateInMbps *int32 `json:"rateInMbps,omitempty"`

	// REQUIRED; The start time of the schedule in UTC.
	Start *string `json:"start,omitempty"`

	// REQUIRED; The stop time of the schedule in UTC.
	Stop *string `json:"stop,omitempty"`
}

BandwidthScheduleProperties - The properties of the bandwidth schedule.

func (BandwidthScheduleProperties) MarshalJSON 

func (b BandwidthScheduleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BandwidthScheduleProperties.

func (*BandwidthScheduleProperties) UnmarshalJSON 

func (b *BandwidthScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthScheduleProperties.

type BandwidthSchedulesClient 

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

BandwidthSchedulesClient contains the methods for the BandwidthSchedules group. Don't use this type directly, use NewBandwidthSchedulesClient() instead.

func NewBandwidthSchedulesClient 

func NewBandwidthSchedulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BandwidthSchedulesClient, error)

NewBandwidthSchedulesClient creates a new instance of BandwidthSchedulesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BandwidthSchedulesClient) BeginCreateOrUpdate 

func (client *BandwidthSchedulesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, parameters BandwidthSchedule, options *BandwidthSchedulesClientBeginCreateOrUpdateOptions) (*runtime.Poller[BandwidthSchedulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The bandwidth schedule name which needs to be added/updated.
  • resourceGroupName - The resource group name.
  • parameters - The bandwidth schedule to be added or updated.
  • options - BandwidthSchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the BandwidthSchedulesClient.BeginCreateOrUpdate method.

func (*BandwidthSchedulesClient) BeginDelete 

func (client *BandwidthSchedulesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *BandwidthSchedulesClientBeginDeleteOptions) (*runtime.Poller[BandwidthSchedulesClientDeleteResponse], error)

BeginDelete - Deletes the specified bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The bandwidth schedule name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientBeginDeleteOptions contains the optional parameters for the BandwidthSchedulesClient.BeginDelete method.

func (*BandwidthSchedulesClient) Get 

func (client *BandwidthSchedulesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *BandwidthSchedulesClientGetOptions) (BandwidthSchedulesClientGetResponse, error)

Get - Gets the properties of the specified bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The bandwidth schedule name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientGetOptions contains the optional parameters for the BandwidthSchedulesClient.Get method.

func (*BandwidthSchedulesClient) NewListByDataBoxEdgeDevicePager 

func (client *BandwidthSchedulesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager method.

type BandwidthSchedulesClientBeginCreateOrUpdateOptions 

type BandwidthSchedulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BandwidthSchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the BandwidthSchedulesClient.BeginCreateOrUpdate method.

type BandwidthSchedulesClientBeginDeleteOptions 

type BandwidthSchedulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BandwidthSchedulesClientBeginDeleteOptions contains the optional parameters for the BandwidthSchedulesClient.BeginDelete method.

type BandwidthSchedulesClientCreateOrUpdateResponse 

type BandwidthSchedulesClientCreateOrUpdateResponse struct {
	BandwidthSchedule
}

BandwidthSchedulesClientCreateOrUpdateResponse contains the response from method BandwidthSchedulesClient.BeginCreateOrUpdate.

type BandwidthSchedulesClientDeleteResponse 

type BandwidthSchedulesClientDeleteResponse struct {
}

BandwidthSchedulesClientDeleteResponse contains the response from method BandwidthSchedulesClient.BeginDelete.

type BandwidthSchedulesClientGetOptions 

type BandwidthSchedulesClientGetOptions struct {
}

BandwidthSchedulesClientGetOptions contains the optional parameters for the BandwidthSchedulesClient.Get method.

type BandwidthSchedulesClientGetResponse 

type BandwidthSchedulesClientGetResponse struct {
	BandwidthSchedule
}

BandwidthSchedulesClientGetResponse contains the response from method BandwidthSchedulesClient.Get.

type BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions 

type BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions struct {
}

BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager method.

type BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse 

type BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse struct {
	BandwidthSchedulesList
}

BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse contains the response from method BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager.

type BandwidthSchedulesList 

type BandwidthSchedulesList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of bandwidth schedules.
	Value []*BandwidthSchedule `json:"value,omitempty" azure:"ro"`
}

BandwidthSchedulesList - The collection of bandwidth schedules.

func (BandwidthSchedulesList) MarshalJSON 

func (b BandwidthSchedulesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BandwidthSchedulesList.

func (*BandwidthSchedulesList) UnmarshalJSON 

func (b *BandwidthSchedulesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthSchedulesList.

type ClientAccessRight 

type ClientAccessRight struct {
	// REQUIRED; Type of access to be allowed for the client.
	AccessPermission *ClientPermissionType `json:"accessPermission,omitempty"`

	// REQUIRED; IP of the client.
	Client *string `json:"client,omitempty"`
}

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

func (ClientAccessRight) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClientAccessRight.

func (*ClientAccessRight) UnmarshalJSON 

func (c *ClientAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientAccessRight.

type ClientFactory 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAlertsClient 

func (c *ClientFactory) NewAlertsClient() *AlertsClient

func (*ClientFactory) NewBandwidthSchedulesClient 

func (c *ClientFactory) NewBandwidthSchedulesClient() *BandwidthSchedulesClient

func (*ClientFactory) NewContainersClient 

func (c *ClientFactory) NewContainersClient() *ContainersClient

func (*ClientFactory) NewDevicesClient 

func (c *ClientFactory) NewDevicesClient() *DevicesClient

func (*ClientFactory) NewJobsClient 

func (c *ClientFactory) NewJobsClient() *JobsClient

func (*ClientFactory) NewNodesClient 

func (c *ClientFactory) NewNodesClient() *NodesClient

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

func (*ClientFactory) NewOperationsStatusClient 

func (c *ClientFactory) NewOperationsStatusClient() *OperationsStatusClient

func (*ClientFactory) NewOrdersClient 

func (c *ClientFactory) NewOrdersClient() *OrdersClient

func (*ClientFactory) NewRolesClient 

func (c *ClientFactory) NewRolesClient() *RolesClient

func (*ClientFactory) NewSKUsClient 

func (c *ClientFactory) NewSKUsClient() *SKUsClient

func (*ClientFactory) NewSharesClient 

func (c *ClientFactory) NewSharesClient() *SharesClient

func (*ClientFactory) NewStorageAccountCredentialsClient 

func (c *ClientFactory) NewStorageAccountCredentialsClient() *StorageAccountCredentialsClient

func (*ClientFactory) NewStorageAccountsClient 

func (c *ClientFactory) NewStorageAccountsClient() *StorageAccountsClient

func (*ClientFactory) NewTriggersClient 

func (c *ClientFactory) NewTriggersClient() *TriggersClient

func (*ClientFactory) NewUsersClient 

func (c *ClientFactory) NewUsersClient() *UsersClient

type ClientPermissionType 

type ClientPermissionType string

ClientPermissionType - Type of access to be allowed for the client. 

const (
	ClientPermissionTypeNoAccess  ClientPermissionType = "NoAccess"
	ClientPermissionTypeReadOnly  ClientPermissionType = "ReadOnly"
	ClientPermissionTypeReadWrite ClientPermissionType = "ReadWrite"
)

func PossibleClientPermissionTypeValues 

func PossibleClientPermissionTypeValues() []ClientPermissionType

PossibleClientPermissionTypeValues returns the possible values for the ClientPermissionType const type.

type ContactDetails 

type ContactDetails struct {
	// REQUIRED; The name of the company.
	CompanyName *string `json:"companyName,omitempty"`

	// REQUIRED; The contact person name.
	ContactPerson *string `json:"contactPerson,omitempty"`

	// REQUIRED; The email list.
	EmailList []*string `json:"emailList,omitempty"`

	// REQUIRED; The phone number.
	Phone *string `json:"phone,omitempty"`
}

ContactDetails - Contains all the contact details of the customer.

func (ContactDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContactDetails.

func (*ContactDetails) UnmarshalJSON 

func (c *ContactDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactDetails.

type Container 

type Container struct {
	// REQUIRED; The container properties.
	Properties *ContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (Container) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Container.

func (*Container) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Container.

type ContainerList 

type ContainerList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of containers.
	Value []*Container `json:"value,omitempty" azure:"ro"`
}

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

func (ContainerList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerList.

func (*ContainerList) UnmarshalJSON 

func (c *ContainerList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerList.

type ContainerProperties 

type ContainerProperties struct {
	// REQUIRED; DataFormat for Container
	DataFormat *AzureContainerDataFormat `json:"dataFormat,omitempty"`

	// READ-ONLY; Current status of the container.
	ContainerStatus *ContainerStatus `json:"containerStatus,omitempty" azure:"ro"`

	// READ-ONLY; The UTC time when container got created.
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Details of the refresh job on this container.
	RefreshDetails *RefreshDetails `json:"refreshDetails,omitempty" azure:"ro"`
}

ContainerProperties - The container properties.

func (ContainerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerProperties.

func (*ContainerProperties) UnmarshalJSON 

func (c *ContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerProperties.

type ContainerStatus 

type ContainerStatus string

ContainerStatus - Current status of the container. 

const (
	ContainerStatusNeedsAttention ContainerStatus = "NeedsAttention"
	ContainerStatusOK             ContainerStatus = "OK"
	ContainerStatusOffline        ContainerStatus = "Offline"
	ContainerStatusUnknown        ContainerStatus = "Unknown"
	ContainerStatusUpdating       ContainerStatus = "Updating"
)

func PossibleContainerStatusValues 

func PossibleContainerStatusValues() []ContainerStatus

PossibleContainerStatusValues returns the possible values for the ContainerStatus const type.

type ContainersClient 

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

ContainersClient contains the methods for the Containers group. Don't use this type directly, use NewContainersClient() instead.

func NewContainersClient 

func NewContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainersClient, error)

NewContainersClient creates a new instance of ContainersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainersClient) BeginCreateOrUpdate 

func (client *ContainersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, containerParam Container, options *ContainersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new container or updates an existing container on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • containerParam - The container properties.
  • options - ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.

func (*ContainersClient) BeginDelete 

func (client *ContainersClient) BeginDelete(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientBeginDeleteOptions) (*runtime.Poller[ContainersClientDeleteResponse], error)

BeginDelete - Deletes the container on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.

func (*ContainersClient) BeginRefresh 

func (client *ContainersClient) BeginRefresh(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientBeginRefreshOptions) (*runtime.Poller[ContainersClientRefreshResponse], error)

BeginRefresh - Refreshes the container metadata with the data from the cloud. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientBeginRefreshOptions contains the optional parameters for the ContainersClient.BeginRefresh method.

func (*ContainersClient) Get 

func (client *ContainersClient) Get(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientGetOptions) (ContainersClientGetResponse, error)

Get - Gets a container by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container Name
  • resourceGroupName - The resource group name.
  • options - ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.

func (*ContainersClient) NewListByStorageAccountPager 

func (client *ContainersClient) NewListByStorageAccountPager(deviceName string, storageAccountName string, resourceGroupName string, options *ContainersClientListByStorageAccountOptions) *runtime.Pager[ContainersClientListByStorageAccountResponse]

NewListByStorageAccountPager - Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The storage Account name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientListByStorageAccountOptions contains the optional parameters for the ContainersClient.NewListByStorageAccountPager method.

type ContainersClientBeginCreateOrUpdateOptions 

type ContainersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.

type ContainersClientBeginDeleteOptions 

type ContainersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.

type ContainersClientBeginRefreshOptions 

type ContainersClientBeginRefreshOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginRefreshOptions contains the optional parameters for the ContainersClient.BeginRefresh method.

type ContainersClientCreateOrUpdateResponse 

type ContainersClientCreateOrUpdateResponse struct {
	Container
}

ContainersClientCreateOrUpdateResponse contains the response from method ContainersClient.BeginCreateOrUpdate.

type ContainersClientDeleteResponse 

type ContainersClientDeleteResponse struct {
}

ContainersClientDeleteResponse contains the response from method ContainersClient.BeginDelete.

type ContainersClientGetOptions 

type ContainersClientGetOptions struct {
}

ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.

type ContainersClientGetResponse 

type ContainersClientGetResponse struct {
	Container
}

ContainersClientGetResponse contains the response from method ContainersClient.Get.

type ContainersClientListByStorageAccountOptions 

type ContainersClientListByStorageAccountOptions struct {
}

ContainersClientListByStorageAccountOptions contains the optional parameters for the ContainersClient.NewListByStorageAccountPager method.

type ContainersClientListByStorageAccountResponse 

type ContainersClientListByStorageAccountResponse struct {
	ContainerList
}

ContainersClientListByStorageAccountResponse contains the response from method ContainersClient.NewListByStorageAccountPager.

type ContainersClientRefreshResponse 

type ContainersClientRefreshResponse struct {
}

ContainersClientRefreshResponse contains the response from method ContainersClient.BeginRefresh.

type DataBoxEdgeDeviceStatus 

type DataBoxEdgeDeviceStatus string

DataBoxEdgeDeviceStatus - The status of the Data Box Edge/Gateway device. 

const (
	DataBoxEdgeDeviceStatusDisconnected          DataBoxEdgeDeviceStatus = "Disconnected"
	DataBoxEdgeDeviceStatusMaintenance           DataBoxEdgeDeviceStatus = "Maintenance"
	DataBoxEdgeDeviceStatusNeedsAttention        DataBoxEdgeDeviceStatus = "NeedsAttention"
	DataBoxEdgeDeviceStatusOffline               DataBoxEdgeDeviceStatus = "Offline"
	DataBoxEdgeDeviceStatusOnline                DataBoxEdgeDeviceStatus = "Online"
	DataBoxEdgeDeviceStatusPartiallyDisconnected DataBoxEdgeDeviceStatus = "PartiallyDisconnected"
	DataBoxEdgeDeviceStatusReadyToSetup          DataBoxEdgeDeviceStatus = "ReadyToSetup"
)

func PossibleDataBoxEdgeDeviceStatusValues 

func PossibleDataBoxEdgeDeviceStatusValues() []DataBoxEdgeDeviceStatus

PossibleDataBoxEdgeDeviceStatusValues returns the possible values for the DataBoxEdgeDeviceStatus const type.

type DataPolicy 

type DataPolicy string

DataPolicy - Data policy of the share. 

const (
	DataPolicyCloud DataPolicy = "Cloud"
	DataPolicyLocal DataPolicy = "Local"
)

func PossibleDataPolicyValues 

func PossibleDataPolicyValues() []DataPolicy

PossibleDataPolicyValues returns the possible values for the DataPolicy const type.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type Device 

type Device struct {
	// REQUIRED; 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"`

	// The etag for the devices.
	Etag *string `json:"etag,omitempty"`

	// The properties of the Data Box Edge/Gateway device.
	Properties *DeviceProperties `json:"properties,omitempty"`

	// The SKU type.
	SKU *SKUInfo `json:"sku,omitempty"`

	// 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,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Device - The Data Box Edge/Gateway device.

func (Device) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Device.

func (*Device) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Device.

type DeviceExtendedInfo 

type DeviceExtendedInfo struct {
	// The extended info properties.
	Properties *DeviceExtendedInfoProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (DeviceExtendedInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceExtendedInfo.

func (*DeviceExtendedInfo) UnmarshalJSON 

func (d *DeviceExtendedInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceExtendedInfo.

type DeviceExtendedInfoProperties 

type DeviceExtendedInfoProperties struct {
	// The public part of the encryption certificate. Client uses this to encrypt any secret.
	EncryptionKey *string `json:"encryptionKey,omitempty"`

	// The digital signature of encrypted certificate.
	EncryptionKeyThumbprint *string `json:"encryptionKeyThumbprint,omitempty"`

	// READ-ONLY; The Resource ID of the Resource.
	ResourceKey *string `json:"resourceKey,omitempty" azure:"ro"`
}

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

func (DeviceExtendedInfoProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceExtendedInfoProperties.

func (*DeviceExtendedInfoProperties) UnmarshalJSON 

func (d *DeviceExtendedInfoProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceExtendedInfoProperties.

type DeviceList 

type DeviceList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of Data Box Edge/Gateway devices.
	Value []*Device `json:"value,omitempty" azure:"ro"`
}

DeviceList - The collection of Data Box Edge/Gateway devices.

func (DeviceList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceList.

func (*DeviceList) UnmarshalJSON 

func (d *DeviceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceList.

type DevicePatch 

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

DevicePatch - The Data Box Edge/Gateway device patch.

func (DevicePatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevicePatch.

func (*DevicePatch) UnmarshalJSON 

func (d *DevicePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DevicePatch.

type DeviceProperties 

type DeviceProperties struct {
	// The status of the Data Box Edge/Gateway device.
	DataBoxEdgeDeviceStatus *DataBoxEdgeDeviceStatus `json:"dataBoxEdgeDeviceStatus,omitempty"`

	// The Description of the Data Box Edge/Gateway device.
	Description *string `json:"description,omitempty"`

	// The Data Box Edge/Gateway device name.
	FriendlyName *string `json:"friendlyName,omitempty"`

	// The description of the Data Box Edge/Gateway device model.
	ModelDescription *string `json:"modelDescription,omitempty"`

	// READ-ONLY; Type of compute roles configured.
	ConfiguredRoleTypes []*RoleTypes `json:"configuredRoleTypes,omitempty" azure:"ro"`

	// READ-ONLY; The Data Box Edge/Gateway device culture.
	Culture *string `json:"culture,omitempty" azure:"ro"`

	// READ-ONLY; The device software version number of the device (eg: 1.2.18105.6).
	DeviceHcsVersion *string `json:"deviceHcsVersion,omitempty" azure:"ro"`

	// READ-ONLY; The Data Box Edge/Gateway device local capacity in MB.
	DeviceLocalCapacity *int64 `json:"deviceLocalCapacity,omitempty" azure:"ro"`

	// READ-ONLY; The Data Box Edge/Gateway device model.
	DeviceModel *string `json:"deviceModel,omitempty" azure:"ro"`

	// READ-ONLY; The Data Box Edge/Gateway device software version.
	DeviceSoftwareVersion *string `json:"deviceSoftwareVersion,omitempty" azure:"ro"`

	// READ-ONLY; The type of the Data Box Edge/Gateway device.
	DeviceType *DeviceType `json:"deviceType,omitempty" azure:"ro"`

	// READ-ONLY; The number of nodes in the cluster.
	NodeCount *int32 `json:"nodeCount,omitempty" azure:"ro"`

	// READ-ONLY; The Serial Number of Data Box Edge/Gateway device.
	SerialNumber *string `json:"serialNumber,omitempty" azure:"ro"`

	// READ-ONLY; The Data Box Edge/Gateway device timezone.
	TimeZone *string `json:"timeZone,omitempty" azure:"ro"`
}

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

func (DeviceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceProperties.

func (*DeviceProperties) UnmarshalJSON 

func (d *DeviceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceProperties.

type DeviceType 

type DeviceType string

DeviceType - The type of the Data Box Edge/Gateway device. 

const (
	DeviceTypeDataBoxEdgeDevice DeviceType = "DataBoxEdgeDevice"
)

func PossibleDeviceTypeValues 

func PossibleDeviceTypeValues() []DeviceType

PossibleDeviceTypeValues returns the possible values for the DeviceType const type.

type DevicesClient 

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

DevicesClient contains the methods for the Devices group. Don't use this type directly, use NewDevicesClient() instead.

func NewDevicesClient 

func NewDevicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DevicesClient, error)

NewDevicesClient creates a new instance of DevicesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DevicesClient) BeginCreateOrUpdate 

func (client *DevicesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, resourceGroupName string, dataBoxEdgeDevice Device, options *DevicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[DevicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a Data Box Edge/Data Box Gateway resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • dataBoxEdgeDevice - The resource object.
  • options - DevicesClientBeginCreateOrUpdateOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdate method.

func (*DevicesClient) BeginCreateOrUpdateSecuritySettings 

func (client *DevicesClient) BeginCreateOrUpdateSecuritySettings(ctx context.Context, deviceName string, resourceGroupName string, securitySettings SecuritySettings, options *DevicesClientBeginCreateOrUpdateSecuritySettingsOptions) (*runtime.Poller[DevicesClientCreateOrUpdateSecuritySettingsResponse], error)

BeginCreateOrUpdateSecuritySettings - Updates the security settings on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • securitySettings - The security settings.
  • options - DevicesClientBeginCreateOrUpdateSecuritySettingsOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdateSecuritySettings method.

func (*DevicesClient) BeginDelete 

func (client *DevicesClient) BeginDelete(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginDeleteOptions) (*runtime.Poller[DevicesClientDeleteResponse], error)

BeginDelete - Deletes the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginDeleteOptions contains the optional parameters for the DevicesClient.BeginDelete method.

func (*DevicesClient) BeginDownloadUpdates 

func (client *DevicesClient) BeginDownloadUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginDownloadUpdatesOptions) (*runtime.Poller[DevicesClientDownloadUpdatesResponse], error)

BeginDownloadUpdates - Downloads the updates on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginDownloadUpdatesOptions contains the optional parameters for the DevicesClient.BeginDownloadUpdates method.

func (*DevicesClient) BeginInstallUpdates 

func (client *DevicesClient) BeginInstallUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginInstallUpdatesOptions) (*runtime.Poller[DevicesClientInstallUpdatesResponse], error)

BeginInstallUpdates - Installs the updates on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginInstallUpdatesOptions contains the optional parameters for the DevicesClient.BeginInstallUpdates method.

func (*DevicesClient) BeginScanForUpdates 

func (client *DevicesClient) BeginScanForUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginScanForUpdatesOptions) (*runtime.Poller[DevicesClientScanForUpdatesResponse], error)

BeginScanForUpdates - Scans for updates on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginScanForUpdatesOptions contains the optional parameters for the DevicesClient.BeginScanForUpdates method.

func (*DevicesClient) Get 

func (client *DevicesClient) Get(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetOptions) (DevicesClientGetResponse, error)

Get - Gets the properties of the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetOptions contains the optional parameters for the DevicesClient.Get method.

func (*DevicesClient) GetExtendedInformation 

func (client *DevicesClient) GetExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetExtendedInformationOptions) (DevicesClientGetExtendedInformationResponse, error)

GetExtendedInformation - Gets additional information for the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetExtendedInformationOptions contains the optional parameters for the DevicesClient.GetExtendedInformation method.

func (*DevicesClient) GetNetworkSettings 

func (client *DevicesClient) GetNetworkSettings(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetNetworkSettingsOptions) (DevicesClientGetNetworkSettingsResponse, error)

GetNetworkSettings - Gets the network settings of the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetNetworkSettingsOptions contains the optional parameters for the DevicesClient.GetNetworkSettings method.

func (*DevicesClient) GetUpdateSummary 

func (client *DevicesClient) GetUpdateSummary(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetUpdateSummaryOptions) (DevicesClientGetUpdateSummaryResponse, error)

GetUpdateSummary - Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetUpdateSummaryOptions contains the optional parameters for the DevicesClient.GetUpdateSummary method.

func (*DevicesClient) NewListByResourceGroupPager 

func (client *DevicesClient) NewListByResourceGroupPager(resourceGroupName string, options *DevicesClientListByResourceGroupOptions) *runtime.Pager[DevicesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

Generated from API version 2019-08-01

  • resourceGroupName - The resource group name.
  • options - DevicesClientListByResourceGroupOptions contains the optional parameters for the DevicesClient.NewListByResourceGroupPager method.

func (*DevicesClient) NewListBySubscriptionPager 

func (client *DevicesClient) NewListBySubscriptionPager(options *DevicesClientListBySubscriptionOptions) *runtime.Pager[DevicesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

Generated from API version 2019-08-01

  • options - DevicesClientListBySubscriptionOptions contains the optional parameters for the DevicesClient.NewListBySubscriptionPager method.

func (*DevicesClient) Update 

func (client *DevicesClient) Update(ctx context.Context, deviceName string, resourceGroupName string, parameters DevicePatch, options *DevicesClientUpdateOptions) (DevicesClientUpdateResponse, error)

Update - Modifies a Data Box Edge/Data Box Gateway resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • parameters - The resource parameters.
  • options - DevicesClientUpdateOptions contains the optional parameters for the DevicesClient.Update method.

func (*DevicesClient) UploadCertificate 

func (client *DevicesClient) UploadCertificate(ctx context.Context, deviceName string, resourceGroupName string, parameters UploadCertificateRequest, options *DevicesClientUploadCertificateOptions) (DevicesClientUploadCertificateResponse, error)

UploadCertificate - Uploads registration certificate for the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • parameters - The upload certificate request.
  • options - DevicesClientUploadCertificateOptions contains the optional parameters for the DevicesClient.UploadCertificate method.

type DevicesClientBeginCreateOrUpdateOptions 

type DevicesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginCreateOrUpdateOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdate method.

type DevicesClientBeginCreateOrUpdateSecuritySettingsOptions 

type DevicesClientBeginCreateOrUpdateSecuritySettingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginCreateOrUpdateSecuritySettingsOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdateSecuritySettings method.

type DevicesClientBeginDeleteOptions 

type DevicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginDeleteOptions contains the optional parameters for the DevicesClient.BeginDelete method.

type DevicesClientBeginDownloadUpdatesOptions 

type DevicesClientBeginDownloadUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginDownloadUpdatesOptions contains the optional parameters for the DevicesClient.BeginDownloadUpdates method.

type DevicesClientBeginInstallUpdatesOptions 

type DevicesClientBeginInstallUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginInstallUpdatesOptions contains the optional parameters for the DevicesClient.BeginInstallUpdates method.

type DevicesClientBeginScanForUpdatesOptions 

type DevicesClientBeginScanForUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginScanForUpdatesOptions contains the optional parameters for the DevicesClient.BeginScanForUpdates method.

type DevicesClientCreateOrUpdateResponse 

type DevicesClientCreateOrUpdateResponse struct {
	Device
}

DevicesClientCreateOrUpdateResponse contains the response from method DevicesClient.BeginCreateOrUpdate.

type DevicesClientCreateOrUpdateSecuritySettingsResponse 

type DevicesClientCreateOrUpdateSecuritySettingsResponse struct {
}

DevicesClientCreateOrUpdateSecuritySettingsResponse contains the response from method DevicesClient.BeginCreateOrUpdateSecuritySettings.

type DevicesClientDeleteResponse 

type DevicesClientDeleteResponse struct {
}

DevicesClientDeleteResponse contains the response from method DevicesClient.BeginDelete.

type DevicesClientDownloadUpdatesResponse 

type DevicesClientDownloadUpdatesResponse struct {
}

DevicesClientDownloadUpdatesResponse contains the response from method DevicesClient.BeginDownloadUpdates.

type DevicesClientGetExtendedInformationOptions 

type DevicesClientGetExtendedInformationOptions struct {
}

DevicesClientGetExtendedInformationOptions contains the optional parameters for the DevicesClient.GetExtendedInformation method.

type DevicesClientGetExtendedInformationResponse 

type DevicesClientGetExtendedInformationResponse struct {
	DeviceExtendedInfo
}

DevicesClientGetExtendedInformationResponse contains the response from method DevicesClient.GetExtendedInformation.

type DevicesClientGetNetworkSettingsOptions 

type DevicesClientGetNetworkSettingsOptions struct {
}

DevicesClientGetNetworkSettingsOptions contains the optional parameters for the DevicesClient.GetNetworkSettings method.

type DevicesClientGetNetworkSettingsResponse 

type DevicesClientGetNetworkSettingsResponse struct {
	NetworkSettings
}

DevicesClientGetNetworkSettingsResponse contains the response from method DevicesClient.GetNetworkSettings.

type DevicesClientGetOptions 

type DevicesClientGetOptions struct {
}

DevicesClientGetOptions contains the optional parameters for the DevicesClient.Get method.

type DevicesClientGetResponse 

type DevicesClientGetResponse struct {
	Device
}

DevicesClientGetResponse contains the response from method DevicesClient.Get.

type DevicesClientGetUpdateSummaryOptions 

type DevicesClientGetUpdateSummaryOptions struct {
}

DevicesClientGetUpdateSummaryOptions contains the optional parameters for the DevicesClient.GetUpdateSummary method.

type DevicesClientGetUpdateSummaryResponse 

type DevicesClientGetUpdateSummaryResponse struct {
	UpdateSummary
}

DevicesClientGetUpdateSummaryResponse contains the response from method DevicesClient.GetUpdateSummary.

type DevicesClientInstallUpdatesResponse 

type DevicesClientInstallUpdatesResponse struct {
}

DevicesClientInstallUpdatesResponse contains the response from method DevicesClient.BeginInstallUpdates.

type DevicesClientListByResourceGroupOptions 

type DevicesClientListByResourceGroupOptions struct {
	// Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next
	// page in the list.
	Expand *string
}

DevicesClientListByResourceGroupOptions contains the optional parameters for the DevicesClient.NewListByResourceGroupPager method.

type DevicesClientListByResourceGroupResponse 

type DevicesClientListByResourceGroupResponse struct {
	DeviceList
}

DevicesClientListByResourceGroupResponse contains the response from method DevicesClient.NewListByResourceGroupPager.

type DevicesClientListBySubscriptionOptions 

type DevicesClientListBySubscriptionOptions struct {
	// Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next
	// page in the list.
	Expand *string
}

DevicesClientListBySubscriptionOptions contains the optional parameters for the DevicesClient.NewListBySubscriptionPager method.

type DevicesClientListBySubscriptionResponse 

type DevicesClientListBySubscriptionResponse struct {
	DeviceList
}

DevicesClientListBySubscriptionResponse contains the response from method DevicesClient.NewListBySubscriptionPager.

type DevicesClientScanForUpdatesResponse 

type DevicesClientScanForUpdatesResponse struct {
}

DevicesClientScanForUpdatesResponse contains the response from method DevicesClient.BeginScanForUpdates.

type DevicesClientUpdateOptions 

type DevicesClientUpdateOptions struct {
}

DevicesClientUpdateOptions contains the optional parameters for the DevicesClient.Update method.

type DevicesClientUpdateResponse 

type DevicesClientUpdateResponse struct {
	Device
}

DevicesClientUpdateResponse contains the response from method DevicesClient.Update.

type DevicesClientUploadCertificateOptions 

type DevicesClientUploadCertificateOptions struct {
}

DevicesClientUploadCertificateOptions contains the optional parameters for the DevicesClient.UploadCertificate method.

type DevicesClientUploadCertificateResponse 

type DevicesClientUploadCertificateResponse struct {
	UploadCertificateResponse
}

DevicesClientUploadCertificateResponse contains the response from method DevicesClient.UploadCertificate.

type DownloadPhase 

type DownloadPhase string

DownloadPhase - The download phase. 

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

func PossibleDownloadPhaseValues 

func PossibleDownloadPhaseValues() []DownloadPhase

PossibleDownloadPhaseValues returns the possible values for the DownloadPhase const type.

type EncryptionAlgorithm 

type EncryptionAlgorithm string

EncryptionAlgorithm - The algorithm used to encrypt "Value". 

const (
	EncryptionAlgorithmAES256        EncryptionAlgorithm = "AES256"
	EncryptionAlgorithmNone          EncryptionAlgorithm = "None"
	EncryptionAlgorithmRSAESPKCS1V15 EncryptionAlgorithm = "RSAES_PKCS1_v_1_5"
)

func PossibleEncryptionAlgorithmValues 

func PossibleEncryptionAlgorithmValues() []EncryptionAlgorithm

PossibleEncryptionAlgorithmValues returns the possible values for the EncryptionAlgorithm const type.

type FileEventTrigger 

type FileEventTrigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType `json:"kind,omitempty"`

	// REQUIRED; File trigger properties.
	Properties *FileTriggerProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

FileEventTrigger - Trigger details.

func (*FileEventTrigger) GetTrigger 

func (f *FileEventTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type FileEventTrigger.

func (FileEventTrigger) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type FileEventTrigger.

func (*FileEventTrigger) UnmarshalJSON 

func (f *FileEventTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileEventTrigger.

type FileSourceInfo 

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

FileSourceInfo - File source details.

func (FileSourceInfo) MarshalJSON 

func (f FileSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSourceInfo.

func (*FileSourceInfo) UnmarshalJSON 

func (f *FileSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSourceInfo.

type FileTriggerProperties 

type FileTriggerProperties struct {
	// REQUIRED; Role sink info.
	SinkInfo *RoleSinkInfo `json:"sinkInfo,omitempty"`

	// REQUIRED; File event source details.
	SourceInfo *FileSourceInfo `json:"sourceInfo,omitempty"`

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

func (FileTriggerProperties) MarshalJSON 

func (f FileTriggerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileTriggerProperties.

func (*FileTriggerProperties) UnmarshalJSON 

func (f *FileTriggerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileTriggerProperties.

type IPv4Config 

type IPv4Config struct {
	// READ-ONLY; The IPv4 gateway of the network adapter.
	Gateway *string `json:"gateway,omitempty" azure:"ro"`

	// READ-ONLY; The IPv4 address of the network adapter.
	IPAddress *string `json:"ipAddress,omitempty" azure:"ro"`

	// READ-ONLY; The IPv4 subnet of the network adapter.
	Subnet *string `json:"subnet,omitempty" azure:"ro"`
}

IPv4Config - Details related to the IPv4 address configuration.

func (IPv4Config) MarshalJSON 

func (i IPv4Config) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv4Config.

func (*IPv4Config) UnmarshalJSON 

func (i *IPv4Config) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv4Config.

type IPv6Config 

type IPv6Config struct {
	// READ-ONLY; The IPv6 gateway of the network adapter.
	Gateway *string `json:"gateway,omitempty" azure:"ro"`

	// READ-ONLY; The IPv6 address of the network adapter.
	IPAddress *string `json:"ipAddress,omitempty" azure:"ro"`

	// READ-ONLY; The IPv6 prefix of the network adapter.
	PrefixLength *int32 `json:"prefixLength,omitempty" azure:"ro"`
}

IPv6Config - Details related to the IPv6 address configuration.

func (IPv6Config) MarshalJSON 

func (i IPv6Config) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv6Config.

func (*IPv6Config) UnmarshalJSON 

func (i *IPv6Config) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv6Config.

type InstallRebootBehavior 

type InstallRebootBehavior string

InstallRebootBehavior - Indicates if updates are available and at least one of the updates needs a reboot. 

const (
	InstallRebootBehaviorNeverReboots   InstallRebootBehavior = "NeverReboots"
	InstallRebootBehaviorRequestReboot  InstallRebootBehavior = "RequestReboot"
	InstallRebootBehaviorRequiresReboot InstallRebootBehavior = "RequiresReboot"
)

func PossibleInstallRebootBehaviorValues 

func PossibleInstallRebootBehaviorValues() []InstallRebootBehavior

PossibleInstallRebootBehaviorValues returns the possible values for the InstallRebootBehavior const type.

type IoTDeviceInfo 

type IoTDeviceInfo struct {
	// REQUIRED; ID of the IoT device/edge device.
	DeviceID *string `json:"deviceId,omitempty"`

	// REQUIRED; Host name for the IoT hub associated to the device.
	IoTHostHub *string `json:"ioTHostHub,omitempty"`

	// IoT device authentication info.
	Authentication *Authentication `json:"authentication,omitempty"`

	// Id for the IoT hub associated to the device.
	IoTHostHubID *string `json:"ioTHostHubId,omitempty"`
}

IoTDeviceInfo - Metadata of IoT device/IoT Edge device to be configured.

func (IoTDeviceInfo) MarshalJSON 

func (i IoTDeviceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTDeviceInfo.

func (*IoTDeviceInfo) UnmarshalJSON 

func (i *IoTDeviceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTDeviceInfo.

type IoTRole 

type IoTRole struct {
	// REQUIRED; Role type.
	Kind *RoleTypes `json:"kind,omitempty"`

	// Properties specific to IoT role.
	Properties *IoTRoleProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IoTRole - Compute role.

func (*IoTRole) GetRole 

func (i *IoTRole) GetRole() *Role

GetRole implements the RoleClassification interface for type IoTRole.

func (IoTRole) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IoTRole.

func (*IoTRole) UnmarshalJSON 

func (i *IoTRole) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTRole.

type IoTRoleProperties 

type IoTRoleProperties struct {
	// REQUIRED; Host OS supported by the IoT role.
	HostPlatform *PlatformType `json:"hostPlatform,omitempty"`

	// REQUIRED; IoT device metadata to which data box edge device needs to be connected.
	IoTDeviceDetails *IoTDeviceInfo `json:"ioTDeviceDetails,omitempty"`

	// REQUIRED; IoT edge device to which the IoT role needs to be configured.
	IoTEdgeDeviceDetails *IoTDeviceInfo `json:"ioTEdgeDeviceDetails,omitempty"`

	// REQUIRED; Role status.
	RoleStatus *RoleStatus `json:"roleStatus,omitempty"`

	// Mount points of shares in role(s).
	ShareMappings []*MountPointMap `json:"shareMappings,omitempty"`
}

IoTRoleProperties - IoT role properties.

func (IoTRoleProperties) MarshalJSON 

func (i IoTRoleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTRoleProperties.

func (*IoTRoleProperties) UnmarshalJSON 

func (i *IoTRoleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTRoleProperties.

type Job 

type Job struct {
	// READ-ONLY; The UTC date and time at which the job completed.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Error *JobErrorDetails `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the object.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The percentage of the job that is complete.
	PercentComplete *int32 `json:"percentComplete,omitempty" azure:"ro"`

	// READ-ONLY; The properties of the job.
	Properties *JobProperties `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The UTC date and time at which the job started.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The current status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Job - A device job.

func (Job) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Job.

func (*Job) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Job.

type JobErrorDetails 

type JobErrorDetails struct {
	// READ-ONLY; The code intended for programmatic access.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	ErrorDetails []*JobErrorItem `json:"errorDetails,omitempty" azure:"ro"`

	// READ-ONLY; The message that describes the error in detail.
	Message *string `json:"message,omitempty" azure:"ro"`
}

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

func (JobErrorDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobErrorDetails.

func (*JobErrorDetails) UnmarshalJSON 

func (j *JobErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobErrorDetails.

type JobErrorItem 

type JobErrorItem struct {
	// READ-ONLY; The code intended for programmatic access.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The message that describes the error in detail.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The recommended actions.
	Recommendations []*string `json:"recommendations,omitempty" azure:"ro"`
}

JobErrorItem - The job error items.

func (JobErrorItem) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobErrorItem.

func (*JobErrorItem) UnmarshalJSON 

func (j *JobErrorItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobErrorItem.

type JobProperties 

type JobProperties struct {
	// If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there
	// are no subfolders.)
	Folder *string `json:"folder,omitempty"`

	// READ-ONLY; Current stage of the update operation.
	CurrentStage *UpdateOperationStage `json:"currentStage,omitempty" azure:"ro"`

	// READ-ONLY; The download progress.
	DownloadProgress *UpdateDownloadProgress `json:"downloadProgress,omitempty" azure:"ro"`

	// READ-ONLY; Local share/remote container relative path to the error manifest file of the refresh.
	ErrorManifestFile *string `json:"errorManifestFile,omitempty" azure:"ro"`

	// READ-ONLY; The install progress.
	InstallProgress *UpdateInstallProgress `json:"installProgress,omitempty" azure:"ro"`

	// READ-ONLY; The type of the job.
	JobType *JobType `json:"jobType,omitempty" azure:"ro"`

	// READ-ONLY; ARM ID of the entity that was refreshed.
	RefreshedEntityID *string `json:"refreshedEntityId,omitempty" azure:"ro"`

	// READ-ONLY; Total number of errors encountered during the refresh process.
	TotalRefreshErrors *int32 `json:"totalRefreshErrors,omitempty" azure:"ro"`
}

JobProperties - The properties for the job.

func (JobProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobProperties.

func (*JobProperties) UnmarshalJSON 

func (j *JobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobProperties.

type JobStatus 

type JobStatus string

JobStatus - The current status of the job. 

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

func PossibleJobStatusValues 

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

type JobType 

type JobType string

JobType - The type of the job. 

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

func PossibleJobTypeValues 

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns the possible values for the JobType const type.

type JobsClient 

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

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient 

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*JobsClient) Get 

func (client *JobsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

Get - Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The job name.
  • resourceGroupName - The resource group name.
  • options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetOptions 

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse 

type JobsClientGetResponse struct {
	Job
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type MetricAggregationType 

type MetricAggregationType string

MetricAggregationType - Metric aggregation type. 

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

func PossibleMetricAggregationTypeValues 

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns the possible values for the MetricAggregationType const type.

type MetricCategory 

type MetricCategory string

MetricCategory - Metric category. 

const (
	MetricCategoryCapacity    MetricCategory = "Capacity"
	MetricCategoryTransaction MetricCategory = "Transaction"
)

func PossibleMetricCategoryValues 

func PossibleMetricCategoryValues() []MetricCategory

PossibleMetricCategoryValues returns the possible values for the MetricCategory const type.

type MetricDimensionV1 

type MetricDimensionV1 struct {
	// Display name of the metrics dimension.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of the metrics dimension.
	Name *string `json:"name,omitempty"`

	// To be exported to shoe box.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

MetricDimensionV1 - Metric Dimension v1.

func (MetricDimensionV1) MarshalJSON 

func (m MetricDimensionV1) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricDimensionV1.

func (*MetricDimensionV1) UnmarshalJSON 

func (m *MetricDimensionV1) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricDimensionV1.

type MetricSpecificationV1 

type MetricSpecificationV1 struct {
	// Metric aggregation type.
	AggregationType *MetricAggregationType `json:"aggregationType,omitempty"`

	// Metric category.
	Category *MetricCategory `json:"category,omitempty"`

	// Metric dimensions, other than default dimension which is resource.
	Dimensions []*MetricDimensionV1 `json:"dimensions,omitempty"`

	// Description of the metric to be displayed.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Display name of the metric.
	DisplayName *string `json:"displayName,omitempty"`

	// Set true to fill the gaps with zero.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// Name of the metric.
	Name *string `json:"name,omitempty"`

	// Resource name override.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

	// Support metric aggregation type.
	SupportedAggregationTypes []*MetricAggregationType `json:"supportedAggregationTypes,omitempty"`

	// Support granularity of metrics.
	SupportedTimeGrainTypes []*TimeGrain `json:"supportedTimeGrainTypes,omitempty"`

	// Metric units.
	Unit *MetricUnit `json:"unit,omitempty"`
}

MetricSpecificationV1 - Metric specification version 1.

func (MetricSpecificationV1) MarshalJSON 

func (m MetricSpecificationV1) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecificationV1.

func (*MetricSpecificationV1) UnmarshalJSON 

func (m *MetricSpecificationV1) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricSpecificationV1.

type MetricUnit 

type MetricUnit string

MetricUnit - Metric units. 

const (
	MetricUnitBytes          MetricUnit = "Bytes"
	MetricUnitBytesPerSecond MetricUnit = "BytesPerSecond"
	MetricUnitCount          MetricUnit = "Count"
	MetricUnitCountPerSecond MetricUnit = "CountPerSecond"
	MetricUnitMilliseconds   MetricUnit = "Milliseconds"
	MetricUnitNotSpecified   MetricUnit = "NotSpecified"
	MetricUnitPercent        MetricUnit = "Percent"
	MetricUnitSeconds        MetricUnit = "Seconds"
)

func PossibleMetricUnitValues 

func PossibleMetricUnitValues() []MetricUnit

PossibleMetricUnitValues returns the possible values for the MetricUnit const type.

type MonitoringStatus 

type MonitoringStatus string

MonitoringStatus - Current monitoring status of the share. 

const (
	MonitoringStatusDisabled MonitoringStatus = "Disabled"
	MonitoringStatusEnabled  MonitoringStatus = "Enabled"
)

func PossibleMonitoringStatusValues 

func PossibleMonitoringStatusValues() []MonitoringStatus

PossibleMonitoringStatusValues returns the possible values for the MonitoringStatus const type.

type MountPointMap 

type MountPointMap struct {
	// REQUIRED; ID of the share mounted to the role VM.
	ShareID *string `json:"shareId,omitempty"`

	// READ-ONLY; Mount point for the share.
	MountPoint *string `json:"mountPoint,omitempty" azure:"ro"`

	// READ-ONLY; ID of the role to which share is mounted.
	RoleID *string `json:"roleId,omitempty" azure:"ro"`

	// READ-ONLY; Role type.
	RoleType *RoleTypes `json:"roleType,omitempty" azure:"ro"`
}

MountPointMap - The share mount point.

func (MountPointMap) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MountPointMap.

func (*MountPointMap) UnmarshalJSON 

func (m *MountPointMap) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MountPointMap.

type NetworkAdapter 

type NetworkAdapter struct {
	// Value indicating whether this adapter has DHCP enabled.
	DhcpStatus *NetworkAdapterDHCPStatus `json:"dhcpStatus,omitempty"`

	// Value indicating whether this adapter is RDMA capable.
	RdmaStatus *NetworkAdapterRDMAStatus `json:"rdmaStatus,omitempty"`

	// READ-ONLY; Instance ID of network adapter.
	AdapterID *string `json:"adapterId,omitempty" azure:"ro"`

	// READ-ONLY; Hardware position of network adapter.
	AdapterPosition *NetworkAdapterPosition `json:"adapterPosition,omitempty" azure:"ro"`

	// READ-ONLY; The list of DNS Servers of the device.
	DNSServers []*string `json:"dnsServers,omitempty" azure:"ro"`

	// READ-ONLY; The IPv4 configuration of the network adapter.
	IPv4Configuration *IPv4Config `json:"ipv4Configuration,omitempty" azure:"ro"`

	// READ-ONLY; The IPv6 configuration of the network adapter.
	IPv6Configuration *IPv6Config `json:"ipv6Configuration,omitempty" azure:"ro"`

	// READ-ONLY; The IPv6 local address.
	IPv6LinkLocalAddress *string `json:"ipv6LinkLocalAddress,omitempty" azure:"ro"`

	// READ-ONLY; Logical index of the adapter.
	Index *int32 `json:"index,omitempty" azure:"ro"`

	// READ-ONLY; Hardware label for the adapter.
	Label *string `json:"label,omitempty" azure:"ro"`

	// READ-ONLY; Link speed.
	LinkSpeed *int64 `json:"linkSpeed,omitempty" azure:"ro"`

	// READ-ONLY; MAC address.
	MacAddress *string `json:"macAddress,omitempty" azure:"ro"`

	// READ-ONLY; Network adapter name.
	NetworkAdapterName *string `json:"networkAdapterName,omitempty" azure:"ro"`

	// READ-ONLY; Node ID of the network adapter.
	NodeID *string `json:"nodeId,omitempty" azure:"ro"`

	// READ-ONLY; Value indicating whether this adapter is valid.
	Status *NetworkAdapterStatus `json:"status,omitempty" azure:"ro"`
}

NetworkAdapter - Represents the networkAdapter on a device.

func (NetworkAdapter) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkAdapter.

func (*NetworkAdapter) UnmarshalJSON 

func (n *NetworkAdapter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkAdapter.

type NetworkAdapterDHCPStatus 

type NetworkAdapterDHCPStatus string

NetworkAdapterDHCPStatus - Value indicating whether this adapter has DHCP enabled. 

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

func PossibleNetworkAdapterDHCPStatusValues 

func PossibleNetworkAdapterDHCPStatusValues() []NetworkAdapterDHCPStatus

PossibleNetworkAdapterDHCPStatusValues returns the possible values for the NetworkAdapterDHCPStatus const type.

type NetworkAdapterPosition 

type NetworkAdapterPosition struct {
	// READ-ONLY; The network group.
	NetworkGroup *NetworkGroup `json:"networkGroup,omitempty" azure:"ro"`

	// READ-ONLY; The port.
	Port *int32 `json:"port,omitempty" azure:"ro"`
}

NetworkAdapterPosition - The network adapter position.

func (NetworkAdapterPosition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkAdapterPosition.

func (*NetworkAdapterPosition) UnmarshalJSON 

func (n *NetworkAdapterPosition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkAdapterPosition.

type NetworkAdapterRDMAStatus 

type NetworkAdapterRDMAStatus string

NetworkAdapterRDMAStatus - Value indicating whether this adapter is RDMA capable. 

const (
	NetworkAdapterRDMAStatusCapable   NetworkAdapterRDMAStatus = "Capable"
	NetworkAdapterRDMAStatusIncapable NetworkAdapterRDMAStatus = "Incapable"
)

func PossibleNetworkAdapterRDMAStatusValues 

func PossibleNetworkAdapterRDMAStatusValues() []NetworkAdapterRDMAStatus

PossibleNetworkAdapterRDMAStatusValues returns the possible values for the NetworkAdapterRDMAStatus const type.

type NetworkAdapterStatus 

type NetworkAdapterStatus string

NetworkAdapterStatus - Value indicating whether this adapter is valid. 

const (
	NetworkAdapterStatusActive   NetworkAdapterStatus = "Active"
	NetworkAdapterStatusInactive NetworkAdapterStatus = "Inactive"
)

func PossibleNetworkAdapterStatusValues 

func PossibleNetworkAdapterStatusValues() []NetworkAdapterStatus

PossibleNetworkAdapterStatusValues returns the possible values for the NetworkAdapterStatus const type.

type NetworkGroup 

type NetworkGroup string

NetworkGroup - The network group. 

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

func PossibleNetworkGroupValues 

func PossibleNetworkGroupValues() []NetworkGroup

PossibleNetworkGroupValues returns the possible values for the NetworkGroup const type.

type NetworkSettings 

type NetworkSettings struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The properties of network settings of a device.
	Properties *NetworkSettingsProperties `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

NetworkSettings - The network settings of a device.

func (NetworkSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkSettings.

func (*NetworkSettings) UnmarshalJSON 

func (n *NetworkSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkSettings.

type NetworkSettingsProperties 

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

NetworkSettingsProperties - The properties of network settings.

func (NetworkSettingsProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkSettingsProperties.

func (*NetworkSettingsProperties) UnmarshalJSON 

func (n *NetworkSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkSettingsProperties.

type Node 

type Node struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The properties of the node
	Properties *NodeProperties `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (Node) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Node.

func (*Node) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Node.

type NodeList 

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

NodeList - Collection of Nodes.

func (NodeList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NodeList.

func (*NodeList) UnmarshalJSON 

func (n *NodeList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeList.

type NodeProperties 

type NodeProperties struct {
	// READ-ONLY; Serial number of the Chassis
	NodeChassisSerialNumber *string `json:"nodeChassisSerialNumber,omitempty" azure:"ro"`

	// READ-ONLY; Display Name of the individual node
	NodeDisplayName *string `json:"nodeDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; Friendly software version name that is currently installed on the node
	NodeFriendlySoftwareVersion *string `json:"nodeFriendlySoftwareVersion,omitempty" azure:"ro"`

	// READ-ONLY; HCS version that is currently installed on the node
	NodeHcsVersion *string `json:"nodeHcsVersion,omitempty" azure:"ro"`

	// READ-ONLY; Guid instance id of the node
	NodeInstanceID *string `json:"nodeInstanceId,omitempty" azure:"ro"`

	// READ-ONLY; Serial number of the individual node
	NodeSerialNumber *string `json:"nodeSerialNumber,omitempty" azure:"ro"`

	// READ-ONLY; The current status of the individual node
	NodeStatus *NodeStatus `json:"nodeStatus,omitempty" azure:"ro"`
}

NodeProperties - This class represents the nodes in a highly available cluster

func (NodeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NodeProperties.

func (*NodeProperties) UnmarshalJSON 

func (n *NodeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeProperties.

type NodeStatus 

type NodeStatus string

NodeStatus - The current status of the individual node 

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

func PossibleNodeStatusValues 

func PossibleNodeStatusValues() []NodeStatus

PossibleNodeStatusValues returns the possible values for the NodeStatus const type.

type NodesClient 

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

NodesClient contains the methods for the Nodes group. Don't use this type directly, use NewNodesClient() instead.

func NewNodesClient 

func NewNodesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NodesClient, error)

NewNodesClient creates a new instance of NodesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NodesClient) NewListByDataBoxEdgeDevicePager 

func (client *NodesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *NodesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[NodesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the nodes currently configured under this Data Box Edge device

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - NodesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the NodesClient.NewListByDataBoxEdgeDevicePager method.

type NodesClientListByDataBoxEdgeDeviceOptions 

type NodesClientListByDataBoxEdgeDeviceOptions struct {
}

NodesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the NodesClient.NewListByDataBoxEdgeDevicePager method.

type NodesClientListByDataBoxEdgeDeviceResponse 

type NodesClientListByDataBoxEdgeDeviceResponse struct {
	NodeList
}

NodesClientListByDataBoxEdgeDeviceResponse contains the response from method NodesClient.NewListByDataBoxEdgeDevicePager.

type Operation 

type Operation struct {
	// Properties displayed for the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Name of the operation.
	Name *string `json:"name,omitempty"`

	// Origin of the operation.
	Origin *string `json:"origin,omitempty"`

	// Operation properties.
	Properties *OperationProperties `json:"properties,omitempty"`
}

Operations.

func (Operation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation to be performed.
	Description *string `json:"description,omitempty"`

	// Operation to be performed on the resource.
	Operation *string `json:"operation,omitempty"`

	// Provider name.
	Provider *string `json:"provider,omitempty"`

	// The type of resource in which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Operation display properties.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationProperties 

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

OperationProperties - Operation properties.

func (OperationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON 

func (o *OperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List all the supported operations.

Generated from API version 2019-08-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	OperationsList
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsList 

type OperationsList struct {
	// REQUIRED; The value.
	Value []*Operation `json:"value,omitempty"`

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

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

MarshalJSON implements the json.Marshaller interface for type OperationsList.

func (*OperationsList) UnmarshalJSON 

func (o *OperationsList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsList.

type OperationsStatusClient 

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

OperationsStatusClient contains the methods for the OperationsStatus group. Don't use this type directly, use NewOperationsStatusClient() instead.

func NewOperationsStatusClient 

func NewOperationsStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsStatusClient, error)

NewOperationsStatusClient creates a new instance of OperationsStatusClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsStatusClient) Get 

func (client *OperationsStatusClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *OperationsStatusClientGetOptions) (OperationsStatusClientGetResponse, error)

Get - Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The job name.
  • resourceGroupName - The resource group name.
  • options - OperationsStatusClientGetOptions contains the optional parameters for the OperationsStatusClient.Get method.

type OperationsStatusClientGetOptions 

type OperationsStatusClientGetOptions struct {
}

OperationsStatusClientGetOptions contains the optional parameters for the OperationsStatusClient.Get method.

type OperationsStatusClientGetResponse 

type OperationsStatusClientGetResponse struct {
	Job
}

OperationsStatusClientGetResponse contains the response from method OperationsStatusClient.Get.

type Order 

type Order struct {
	// The order properties.
	Properties *OrderProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Order - The order details.

func (Order) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Order.

func (*Order) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Order.

type OrderList 

type OrderList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of orders.
	Value []*Order `json:"value,omitempty" azure:"ro"`
}

OrderList - List of order entities.

func (OrderList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OrderList.

func (*OrderList) UnmarshalJSON 

func (o *OrderList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderList.

type OrderProperties 

type OrderProperties struct {
	// REQUIRED; The contact details.
	ContactInformation *ContactDetails `json:"contactInformation,omitempty"`

	// REQUIRED; The shipping address.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`

	// Current status of the order.
	CurrentStatus *OrderStatus `json:"currentStatus,omitempty"`

	// 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" azure:"ro"`

	// READ-ONLY; List of status changes in the order.
	OrderHistory []*OrderStatus `json:"orderHistory,omitempty" azure:"ro"`

	// 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" azure:"ro"`

	// READ-ONLY; Serial number of the device.
	SerialNumber *string `json:"serialNumber,omitempty" azure:"ro"`
}

OrderProperties - Order properties.

func (OrderProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OrderProperties.

func (*OrderProperties) UnmarshalJSON 

func (o *OrderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderProperties.

type OrderState 

type OrderState string

OrderState - Status of the order as per the allowed status types. 

const (
	OrderStateArriving               OrderState = "Arriving"
	OrderStateAwaitingFulfilment     OrderState = "AwaitingFulfilment"
	OrderStateAwaitingPreparation    OrderState = "AwaitingPreparation"
	OrderStateAwaitingReturnShipment OrderState = "AwaitingReturnShipment"
	OrderStateAwaitingShipment       OrderState = "AwaitingShipment"
	OrderStateCollectedAtMicrosoft   OrderState = "CollectedAtMicrosoft"
	OrderStateDeclined               OrderState = "Declined"
	OrderStateDelivered              OrderState = "Delivered"
	OrderStateLostDevice             OrderState = "LostDevice"
	OrderStateReplacementRequested   OrderState = "ReplacementRequested"
	OrderStateReturnInitiated        OrderState = "ReturnInitiated"
	OrderStateShipped                OrderState = "Shipped"
	OrderStateShippedBack            OrderState = "ShippedBack"
	OrderStateUntracked              OrderState = "Untracked"
)

func PossibleOrderStateValues 

func PossibleOrderStateValues() []OrderState

PossibleOrderStateValues returns the possible values for the OrderState const type.

type OrderStatus 

type OrderStatus struct {
	// REQUIRED; Status of the order as per the allowed status types.
	Status *OrderState `json:"status,omitempty"`

	// Comments related to this status change.
	Comments *string `json:"comments,omitempty"`

	// READ-ONLY; Dictionary to hold generic information which is not stored by the already existing properties
	AdditionalOrderDetails map[string]*string `json:"additionalOrderDetails,omitempty" azure:"ro"`

	// READ-ONLY; Time of status update.
	UpdateDateTime *time.Time `json:"updateDateTime,omitempty" azure:"ro"`
}

OrderStatus - Represents a single status change.

func (OrderStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OrderStatus.

func (*OrderStatus) UnmarshalJSON 

func (o *OrderStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderStatus.

type OrdersClient 

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

OrdersClient contains the methods for the Orders group. Don't use this type directly, use NewOrdersClient() instead.

func NewOrdersClient 

func NewOrdersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OrdersClient, error)

NewOrdersClient creates a new instance of OrdersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OrdersClient) BeginCreateOrUpdate 

func (client *OrdersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, resourceGroupName string, order Order, options *OrdersClientBeginCreateOrUpdateOptions) (*runtime.Poller[OrdersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an order. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The order details of a device.
  • resourceGroupName - The resource group name.
  • order - The order to be created or updated.
  • options - OrdersClientBeginCreateOrUpdateOptions contains the optional parameters for the OrdersClient.BeginCreateOrUpdate method.

func (*OrdersClient) BeginDelete 

func (client *OrdersClient) BeginDelete(ctx context.Context, deviceName string, resourceGroupName string, options *OrdersClientBeginDeleteOptions) (*runtime.Poller[OrdersClientDeleteResponse], error)

BeginDelete - Deletes the order related to the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientBeginDeleteOptions contains the optional parameters for the OrdersClient.BeginDelete method.

func (*OrdersClient) Get 

func (client *OrdersClient) Get(ctx context.Context, deviceName string, resourceGroupName string, options *OrdersClientGetOptions) (OrdersClientGetResponse, error)

Get - Gets a specific order by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientGetOptions contains the optional parameters for the OrdersClient.Get method.

func (*OrdersClient) NewListByDataBoxEdgeDevicePager 

func (client *OrdersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *OrdersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[OrdersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the orders related to a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the OrdersClient.NewListByDataBoxEdgeDevicePager method.

type OrdersClientBeginCreateOrUpdateOptions 

type OrdersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OrdersClientBeginCreateOrUpdateOptions contains the optional parameters for the OrdersClient.BeginCreateOrUpdate method.

type OrdersClientBeginDeleteOptions 

type OrdersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OrdersClientBeginDeleteOptions contains the optional parameters for the OrdersClient.BeginDelete method.

type OrdersClientCreateOrUpdateResponse 

type OrdersClientCreateOrUpdateResponse struct {
	Order
}

OrdersClientCreateOrUpdateResponse contains the response from method OrdersClient.BeginCreateOrUpdate.

type OrdersClientDeleteResponse 

type OrdersClientDeleteResponse struct {
}

OrdersClientDeleteResponse contains the response from method OrdersClient.BeginDelete.

type OrdersClientGetOptions 

type OrdersClientGetOptions struct {
}

OrdersClientGetOptions contains the optional parameters for the OrdersClient.Get method.

type OrdersClientGetResponse 

type OrdersClientGetResponse struct {
	Order
}

OrdersClientGetResponse contains the response from method OrdersClient.Get.

type OrdersClientListByDataBoxEdgeDeviceOptions 

type OrdersClientListByDataBoxEdgeDeviceOptions struct {
}

OrdersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the OrdersClient.NewListByDataBoxEdgeDevicePager method.

type OrdersClientListByDataBoxEdgeDeviceResponse 

type OrdersClientListByDataBoxEdgeDeviceResponse struct {
	OrderList
}

OrdersClientListByDataBoxEdgeDeviceResponse contains the response from method OrdersClient.NewListByDataBoxEdgeDevicePager.

type PeriodicTimerEventTrigger 

type PeriodicTimerEventTrigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType `json:"kind,omitempty"`

	// REQUIRED; Periodic timer trigger properties.
	Properties *PeriodicTimerProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PeriodicTimerEventTrigger - Trigger details.

func (*PeriodicTimerEventTrigger) GetTrigger 

func (p *PeriodicTimerEventTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerEventTrigger.

func (*PeriodicTimerEventTrigger) UnmarshalJSON 

func (p *PeriodicTimerEventTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerEventTrigger.

type PeriodicTimerProperties 

type PeriodicTimerProperties struct {
	// REQUIRED; Role Sink information.
	SinkInfo *RoleSinkInfo `json:"sinkInfo,omitempty"`

	// REQUIRED; Periodic timer details.
	SourceInfo *PeriodicTimerSourceInfo `json:"sourceInfo,omitempty"`

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

func (PeriodicTimerProperties) MarshalJSON 

func (p PeriodicTimerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerProperties.

func (*PeriodicTimerProperties) UnmarshalJSON 

func (p *PeriodicTimerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerProperties.

type PeriodicTimerSourceInfo 

type PeriodicTimerSourceInfo struct {
	// REQUIRED; Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.
	Schedule *string `json:"schedule,omitempty"`

	// REQUIRED; The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified
	// upto seconds. If timezone is not specified the time will considered to be in device
	// timezone. The value will always be returned as UTC time.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Topic where periodic events are published to IoT device.
	Topic *string `json:"topic,omitempty"`
}

PeriodicTimerSourceInfo - Periodic timer event source.

func (PeriodicTimerSourceInfo) MarshalJSON 

func (p PeriodicTimerSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerSourceInfo.

func (*PeriodicTimerSourceInfo) UnmarshalJSON 

func (p *PeriodicTimerSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerSourceInfo.

type PlatformType 

type PlatformType string

PlatformType - Host OS supported by the IoT role. 

const (
	PlatformTypeLinux   PlatformType = "Linux"
	PlatformTypeWindows PlatformType = "Windows"
)

func PossiblePlatformTypeValues 

func PossiblePlatformTypeValues() []PlatformType

PossiblePlatformTypeValues returns the possible values for the PlatformType const type.

type RawCertificateData 

type RawCertificateData struct {
	// REQUIRED; The base64 encoded certificate raw data.
	Certificate *string `json:"certificate,omitempty"`

	// The authentication type.
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`
}

RawCertificateData - Raw Certificate Data.

func (RawCertificateData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RawCertificateData.

func (*RawCertificateData) UnmarshalJSON 

func (r *RawCertificateData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RawCertificateData.

type RefreshDetails 

type RefreshDetails struct {
	// Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This
	// could be a failed job or a successful job.
	ErrorManifestFile *string `json:"errorManifestFile,omitempty"`

	// If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that
	// job. The field is empty if no job is in progress.
	InProgressRefreshJobID *string `json:"inProgressRefreshJobId,omitempty"`

	// Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed
	// job or a successful job.
	LastCompletedRefreshJobTimeInUTC *time.Time `json:"lastCompletedRefreshJobTimeInUTC,omitempty"`

	// Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a
	// successful job.
	LastJob *string `json:"lastJob,omitempty"`
}

RefreshDetails - Fields for tracking refresh job on the share or container.

func (RefreshDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RefreshDetails.

func (*RefreshDetails) UnmarshalJSON 

func (r *RefreshDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RefreshDetails.

type ResourceTypeSKU 

type ResourceTypeSKU struct {
	// READ-ONLY; The API versions in which SKU is available
	APIVersions []*string `json:"apiVersions,omitempty" azure:"ro"`

	// READ-ONLY; The pricing info of the Sku.
	Costs []*SKUCost `json:"costs,omitempty" azure:"ro"`

	// READ-ONLY; The Sku family
	Family *string `json:"family,omitempty" azure:"ro"`

	// READ-ONLY; The Sku kind
	Kind *string `json:"kind,omitempty" azure:"ro"`

	// READ-ONLY; Availability of the SKU for the location/zone
	LocationInfo []*SKULocationInfo `json:"locationInfo,omitempty" azure:"ro"`

	// READ-ONLY; Availability of the SKU for the region
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; The Sku name
	Name *SKUName `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; Restrictions of the SKU availability.
	Restrictions []*SKURestriction `json:"restrictions,omitempty" azure:"ro"`

	// READ-ONLY; The Sku tier
	Tier *SKUTier `json:"tier,omitempty" azure:"ro"`
}

ResourceTypeSKU - SkuInformation object

func (ResourceTypeSKU) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceTypeSKU.

func (*ResourceTypeSKU) UnmarshalJSON 

func (r *ResourceTypeSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeSKU.

type Role 

type Role struct {
	// REQUIRED; Role type.
	Kind *RoleTypes `json:"kind,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Role - Compute role.

func (*Role) GetRole 

func (r *Role) GetRole() *Role

GetRole implements the RoleClassification interface for type Role.

func (Role) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Role.

func (*Role) UnmarshalJSON 

func (r *Role) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Role.

type RoleClassification 

type RoleClassification interface {
	// GetRole returns the Role content of the underlying type.
	GetRole() *Role
}

RoleClassification provides polymorphic access to related types. Call the interface's GetRole() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *IoTRole, *Role

type RoleList 

type RoleList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The Value.
	Value []RoleClassification `json:"value,omitempty" azure:"ro"`
}

RoleList - Collection of all the roles on the Data Box Edge device.

func (RoleList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleList.

func (*RoleList) UnmarshalJSON 

func (r *RoleList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleList.

type RoleSinkInfo 

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

RoleSinkInfo - Compute role against which events will be raised.

func (RoleSinkInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleSinkInfo.

func (*RoleSinkInfo) UnmarshalJSON 

func (r *RoleSinkInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleSinkInfo.

type RoleStatus 

type RoleStatus string

RoleStatus - Role status. 

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

func PossibleRoleStatusValues 

func PossibleRoleStatusValues() []RoleStatus

PossibleRoleStatusValues returns the possible values for the RoleStatus const type.

type RoleTypes 

type RoleTypes string
const (
	RoleTypesASA       RoleTypes = "ASA"
	RoleTypesCognitive RoleTypes = "Cognitive"
	RoleTypesFunctions RoleTypes = "Functions"
	RoleTypesIOT       RoleTypes = "IOT"
)

func PossibleRoleTypesValues 

func PossibleRoleTypesValues() []RoleTypes

PossibleRoleTypesValues returns the possible values for the RoleTypes const type.

type RolesClient 

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

RolesClient contains the methods for the Roles group. Don't use this type directly, use NewRolesClient() instead.

func NewRolesClient 

func NewRolesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RolesClient, error)

NewRolesClient creates a new instance of RolesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RolesClient) BeginCreateOrUpdate 

func (client *RolesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, role RoleClassification, options *RolesClientBeginCreateOrUpdateOptions) (*runtime.Poller[RolesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a role. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • role - The role properties.
  • options - RolesClientBeginCreateOrUpdateOptions contains the optional parameters for the RolesClient.BeginCreateOrUpdate method.

func (*RolesClient) BeginDelete 

func (client *RolesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *RolesClientBeginDeleteOptions) (*runtime.Poller[RolesClientDeleteResponse], error)

BeginDelete - Deletes the role on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • options - RolesClientBeginDeleteOptions contains the optional parameters for the RolesClient.BeginDelete method.

func (*RolesClient) Get 

func (client *RolesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *RolesClientGetOptions) (RolesClientGetResponse, error)

Get - Gets a specific role by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • options - RolesClientGetOptions contains the optional parameters for the RolesClient.Get method.

func (*RolesClient) NewListByDataBoxEdgeDevicePager 

func (client *RolesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *RolesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[RolesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - RolesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the RolesClient.NewListByDataBoxEdgeDevicePager method.

type RolesClientBeginCreateOrUpdateOptions 

type RolesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RolesClientBeginCreateOrUpdateOptions contains the optional parameters for the RolesClient.BeginCreateOrUpdate method.

type RolesClientBeginDeleteOptions 

type RolesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RolesClientBeginDeleteOptions contains the optional parameters for the RolesClient.BeginDelete method.

type RolesClientCreateOrUpdateResponse 

type RolesClientCreateOrUpdateResponse struct {
	RoleClassification
}

RolesClientCreateOrUpdateResponse contains the response from method RolesClient.BeginCreateOrUpdate.

func (*RolesClientCreateOrUpdateResponse) UnmarshalJSON 

func (r *RolesClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RolesClientCreateOrUpdateResponse.

type RolesClientDeleteResponse 

type RolesClientDeleteResponse struct {
}

RolesClientDeleteResponse contains the response from method RolesClient.BeginDelete.

type RolesClientGetOptions 

type RolesClientGetOptions struct {
}

RolesClientGetOptions contains the optional parameters for the RolesClient.Get method.

type RolesClientGetResponse 

type RolesClientGetResponse struct {
	RoleClassification
}

RolesClientGetResponse contains the response from method RolesClient.Get.

func (*RolesClientGetResponse) UnmarshalJSON 

func (r *RolesClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RolesClientGetResponse.

type RolesClientListByDataBoxEdgeDeviceOptions 

type RolesClientListByDataBoxEdgeDeviceOptions struct {
}

RolesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the RolesClient.NewListByDataBoxEdgeDevicePager method.

type RolesClientListByDataBoxEdgeDeviceResponse 

type RolesClientListByDataBoxEdgeDeviceResponse struct {
	RoleList
}

RolesClientListByDataBoxEdgeDeviceResponse contains the response from method RolesClient.NewListByDataBoxEdgeDevicePager.

type SKUCost 

type SKUCost struct {
	// READ-ONLY; Restriction of the SKU for the location/zone
	ExtendedUnit *string `json:"extendedUnit,omitempty" azure:"ro"`

	// READ-ONLY; Used for querying price from commerce.
	MeterID *string `json:"meterId,omitempty" azure:"ro"`

	// READ-ONLY; The cost quantity.
	Quantity *int64 `json:"quantity,omitempty" azure:"ro"`
}

SKUCost - The metadata for retrieving price info.

func (SKUCost) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUCost.

func (*SKUCost) UnmarshalJSON 

func (s *SKUCost) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCost.

type SKUInfo 

type SKUInfo struct {
	// SKU name.
	Name *SKUName `json:"name,omitempty"`

	// The SKU tier. This is based on the SKU name.
	Tier *SKUTier `json:"tier,omitempty"`
}

SKUInfo - The SKU type.

func (SKUInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUInfo.

func (*SKUInfo) UnmarshalJSON 

func (s *SKUInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUInfo.

type SKUInformationList 

type SKUInformationList struct {
	// READ-ONLY; Links to the next set of results
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of ResourceType Sku
	Value []*ResourceTypeSKU `json:"value,omitempty" azure:"ro"`
}

SKUInformationList - List of SKU Information objects

func (SKUInformationList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUInformationList.

func (*SKUInformationList) UnmarshalJSON 

func (s *SKUInformationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUInformationList.

type SKULocationInfo 

type SKULocationInfo struct {
	// READ-ONLY; The location.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; The sites.
	Sites []*string `json:"sites,omitempty" azure:"ro"`

	// READ-ONLY; The zones.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

SKULocationInfo - The location info.

func (SKULocationInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKULocationInfo.

func (*SKULocationInfo) UnmarshalJSON 

func (s *SKULocationInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKULocationInfo.

type SKUName 

type SKUName string

SKUName - The Sku name 

const (
	SKUNameEdge              SKUName = "Edge"
	SKUNameGateway           SKUName = "Gateway"
	SKUNameTEA1Node          SKUName = "TEA_1Node"
	SKUNameTEA1NodeHeater    SKUName = "TEA_1Node_Heater"
	SKUNameTEA1NodeUPS       SKUName = "TEA_1Node_UPS"
	SKUNameTEA1NodeUPSHeater SKUName = "TEA_1Node_UPS_Heater"
	SKUNameTEA4NodeHeater    SKUName = "TEA_4Node_Heater"
	SKUNameTEA4NodeUPSHeater SKUName = "TEA_4Node_UPS_Heater"
	SKUNameTMA               SKUName = "TMA"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKURestriction 

type SKURestriction struct {
	// READ-ONLY; The SKU restriction reason.
	ReasonCode *SKURestrictionReasonCode `json:"reasonCode,omitempty" azure:"ro"`

	// READ-ONLY; Restriction of the SKU for the location/zone
	RestrictionInfo *SKURestrictionInfo `json:"restrictionInfo,omitempty" azure:"ro"`

	// READ-ONLY; The type of the restriction.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; The locations where sku is restricted.
	Values []*string `json:"values,omitempty" azure:"ro"`
}

SKURestriction - The restrictions because of which SKU cannot be used.

func (SKURestriction) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKURestriction.

func (*SKURestriction) UnmarshalJSON 

func (s *SKURestriction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKURestriction.

type SKURestrictionInfo 

type SKURestrictionInfo struct {
	// READ-ONLY; The locations.
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; The zones.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

SKURestrictionInfo - The restriction info with locations and zones.

func (SKURestrictionInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKURestrictionInfo.

func (*SKURestrictionInfo) UnmarshalJSON 

func (s *SKURestrictionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKURestrictionInfo.

type SKURestrictionReasonCode 

type SKURestrictionReasonCode string

SKURestrictionReasonCode - The SKU restriction reason. 

const (
	SKURestrictionReasonCodeNotAvailableForSubscription SKURestrictionReasonCode = "NotAvailableForSubscription"
	SKURestrictionReasonCodeQuotaID                     SKURestrictionReasonCode = "QuotaId"
)

func PossibleSKURestrictionReasonCodeValues 

func PossibleSKURestrictionReasonCodeValues() []SKURestrictionReasonCode

PossibleSKURestrictionReasonCodeValues returns the possible values for the SKURestrictionReasonCode const type.

type SKUTier 

type SKUTier string

SKUTier - The Sku tier 

const (
	SKUTierStandard SKUTier = "Standard"
)

func PossibleSKUTierValues 

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type SKUsClient 

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

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient 

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SKUsClient) NewListPager 

func (client *SKUsClient) NewListPager(options *SKUsClientListOptions) *runtime.Pager[SKUsClientListResponse]

NewListPager - List all the available Skus in the region and information related to them

Generated from API version 2019-08-01

  • options - SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.

type SKUsClientListOptions 

type SKUsClientListOptions struct {
	// Specify $filter='location eq ' to filter on location.
	Filter *string
}

SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.

type SKUsClientListResponse 

type SKUsClientListResponse struct {
	SKUInformationList
}

SKUsClientListResponse contains the response from method SKUsClient.NewListPager.

type SSLStatus 

type SSLStatus string

SSLStatus - Signifies whether SSL needs to be enabled or not. 

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

func PossibleSSLStatusValues 

func PossibleSSLStatusValues() []SSLStatus

PossibleSSLStatusValues returns the possible values for the SSLStatus const type.

type SecuritySettings 

type SecuritySettings struct {
	// REQUIRED; Properties of the security settings.
	Properties *SecuritySettingsProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SecuritySettings - The security settings of a device.

func (SecuritySettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecuritySettings.

func (*SecuritySettings) UnmarshalJSON 

func (s *SecuritySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettings.

type SecuritySettingsProperties 

type SecuritySettingsProperties struct {
	// REQUIRED; 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.

func (SecuritySettingsProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecuritySettingsProperties.

func (*SecuritySettingsProperties) UnmarshalJSON 

func (s *SecuritySettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettingsProperties.

type ServiceSpecification 

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

ServiceSpecification - Service specification.

func (ServiceSpecification) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

func (*ServiceSpecification) UnmarshalJSON 

func (s *ServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceSpecification.

type Share 

type Share struct {
	// REQUIRED; The share properties.
	Properties *ShareProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (Share) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Share.

func (*Share) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Share.

type ShareAccessProtocol 

type ShareAccessProtocol string

ShareAccessProtocol - Access protocol to be used by the share. 

const (
	ShareAccessProtocolNFS ShareAccessProtocol = "NFS"
	ShareAccessProtocolSMB ShareAccessProtocol = "SMB"
)

func PossibleShareAccessProtocolValues 

func PossibleShareAccessProtocolValues() []ShareAccessProtocol

PossibleShareAccessProtocolValues returns the possible values for the ShareAccessProtocol const type.

type ShareAccessRight 

type ShareAccessRight struct {
	// REQUIRED; Type of access to be allowed on the share for this user.
	AccessType *ShareAccessType `json:"accessType,omitempty"`

	// REQUIRED; The share ID.
	ShareID *string `json:"shareId,omitempty"`
}

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

func (ShareAccessRight) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareAccessRight.

func (*ShareAccessRight) UnmarshalJSON 

func (s *ShareAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareAccessRight.

type ShareAccessType 

type ShareAccessType string

ShareAccessType - Type of access to be allowed on the share for this user. 

const (
	ShareAccessTypeChange ShareAccessType = "Change"
	ShareAccessTypeCustom ShareAccessType = "Custom"
	ShareAccessTypeRead   ShareAccessType = "Read"
)

func PossibleShareAccessTypeValues 

func PossibleShareAccessTypeValues() []ShareAccessType

PossibleShareAccessTypeValues returns the possible values for the ShareAccessType const type.

type ShareList 

type ShareList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of shares.
	Value []*Share `json:"value,omitempty" azure:"ro"`
}

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

func (ShareList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareList.

func (*ShareList) UnmarshalJSON 

func (s *ShareList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareList.

type ShareProperties 

type ShareProperties struct {
	// REQUIRED; Access protocol to be used by the share.
	AccessProtocol *ShareAccessProtocol `json:"accessProtocol,omitempty"`

	// REQUIRED; Current monitoring status of the share.
	MonitoringStatus *MonitoringStatus `json:"monitoringStatus,omitempty"`

	// REQUIRED; Current status of the share.
	ShareStatus *ShareStatus `json:"shareStatus,omitempty"`

	// Azure container mapping for the share.
	AzureContainerInfo *AzureContainerInfo `json:"azureContainerInfo,omitempty"`

	// List of IP addresses and corresponding access rights on the share(required for NFS protocol).
	ClientAccessRights []*ClientAccessRight `json:"clientAccessRights,omitempty"`

	// Data policy of the share.
	DataPolicy *DataPolicy `json:"dataPolicy,omitempty"`

	// Description for the share.
	Description *string `json:"description,omitempty"`

	// Details of the refresh job on this share.
	RefreshDetails *RefreshDetails `json:"refreshDetails,omitempty"`

	// Mapping of users and corresponding access rights on the share (required for SMB protocol).
	UserAccessRights []*UserAccessRight `json:"userAccessRights,omitempty"`

	// READ-ONLY; Share mount point to the role.
	ShareMappings []*MountPointMap `json:"shareMappings,omitempty" azure:"ro"`
}

ShareProperties - The share properties.

func (ShareProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareProperties.

func (*ShareProperties) UnmarshalJSON 

func (s *ShareProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareProperties.

type ShareStatus 

type ShareStatus string

ShareStatus - Current status of the share. 

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

func PossibleShareStatusValues 

func PossibleShareStatusValues() []ShareStatus

PossibleShareStatusValues returns the possible values for the ShareStatus const type.

type SharesClient 

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

SharesClient contains the methods for the Shares group. Don't use this type directly, use NewSharesClient() instead.

func NewSharesClient 

func NewSharesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SharesClient, error)

NewSharesClient creates a new instance of SharesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SharesClient) BeginCreateOrUpdate 

func (client *SharesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, share Share, options *SharesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SharesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new share or updates an existing share on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • share - The share properties.
  • options - SharesClientBeginCreateOrUpdateOptions contains the optional parameters for the SharesClient.BeginCreateOrUpdate method.

func (*SharesClient) BeginDelete 

func (client *SharesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientBeginDeleteOptions) (*runtime.Poller[SharesClientDeleteResponse], error)

BeginDelete - Deletes the share on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.

func (*SharesClient) BeginRefresh 

func (client *SharesClient) BeginRefresh(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientBeginRefreshOptions) (*runtime.Poller[SharesClientRefreshResponse], error)

BeginRefresh - Refreshes the share metadata with the data from the cloud. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientBeginRefreshOptions contains the optional parameters for the SharesClient.BeginRefresh method.

func (*SharesClient) Get 

func (client *SharesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientGetOptions) (SharesClientGetResponse, error)

Get - Gets a share by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.

func (*SharesClient) NewListByDataBoxEdgeDevicePager 

func (client *SharesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *SharesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[SharesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the shares in a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - SharesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the SharesClient.NewListByDataBoxEdgeDevicePager method.

type SharesClientBeginCreateOrUpdateOptions 

type SharesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginCreateOrUpdateOptions contains the optional parameters for the SharesClient.BeginCreateOrUpdate method.

type SharesClientBeginDeleteOptions 

type SharesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.

type SharesClientBeginRefreshOptions 

type SharesClientBeginRefreshOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginRefreshOptions contains the optional parameters for the SharesClient.BeginRefresh method.

type SharesClientCreateOrUpdateResponse 

type SharesClientCreateOrUpdateResponse struct {
	Share
}

SharesClientCreateOrUpdateResponse contains the response from method SharesClient.BeginCreateOrUpdate.

type SharesClientDeleteResponse 

type SharesClientDeleteResponse struct {
}

SharesClientDeleteResponse contains the response from method SharesClient.BeginDelete.

type SharesClientGetOptions 

type SharesClientGetOptions struct {
}

SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.

type SharesClientGetResponse 

type SharesClientGetResponse struct {
	Share
}

SharesClientGetResponse contains the response from method SharesClient.Get.

type SharesClientListByDataBoxEdgeDeviceOptions 

type SharesClientListByDataBoxEdgeDeviceOptions struct {
}

SharesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the SharesClient.NewListByDataBoxEdgeDevicePager method.

type SharesClientListByDataBoxEdgeDeviceResponse 

type SharesClientListByDataBoxEdgeDeviceResponse struct {
	ShareList
}

SharesClientListByDataBoxEdgeDeviceResponse contains the response from method SharesClient.NewListByDataBoxEdgeDevicePager.

type SharesClientRefreshResponse 

type SharesClientRefreshResponse struct {
}

SharesClientRefreshResponse contains the response from method SharesClient.BeginRefresh.

type StorageAccount 

type StorageAccount struct {
	// REQUIRED; The Storage Account properties.
	Properties *StorageAccountProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (StorageAccount) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccount.

func (*StorageAccount) UnmarshalJSON 

func (s *StorageAccount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccount.

type StorageAccountCredential 

type StorageAccountCredential struct {
	// REQUIRED; The storage account credential properties.
	Properties *StorageAccountCredentialProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

StorageAccountCredential - The storage account credential.

func (StorageAccountCredential) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredential.

func (*StorageAccountCredential) UnmarshalJSON 

func (s *StorageAccountCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredential.

type StorageAccountCredentialList 

type StorageAccountCredentialList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The value.
	Value []*StorageAccountCredential `json:"value,omitempty" azure:"ro"`
}

StorageAccountCredentialList - The collection of storage account credentials.

func (StorageAccountCredentialList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredentialList.

func (*StorageAccountCredentialList) UnmarshalJSON 

func (s *StorageAccountCredentialList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredentialList.

type StorageAccountCredentialProperties 

type StorageAccountCredentialProperties struct {
	// REQUIRED; Type of storage accessed on the storage account.
	AccountType *AccountType `json:"accountType,omitempty"`

	// REQUIRED; Alias for the storage account.
	Alias *string `json:"alias,omitempty"`

	// REQUIRED; Signifies whether SSL needs to be enabled or not.
	SSLStatus *SSLStatus `json:"sslStatus,omitempty"`

	// Encrypted storage key.
	AccountKey *AsymmetricEncryptedSecret `json:"accountKey,omitempty"`

	// Blob end point for private clouds.
	BlobDomainName *string `json:"blobDomainName,omitempty"`

	// Connection string for the storage account. Use this string if username and account key are not specified.
	ConnectionString *string `json:"connectionString,omitempty"`

	// Id of the storage account.
	StorageAccountID *string `json:"storageAccountId,omitempty"`

	// Username for the storage account.
	UserName *string `json:"userName,omitempty"`
}

StorageAccountCredentialProperties - The storage account credential properties.

func (StorageAccountCredentialProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredentialProperties.

func (*StorageAccountCredentialProperties) UnmarshalJSON 

func (s *StorageAccountCredentialProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredentialProperties.

type StorageAccountCredentialsClient 

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

StorageAccountCredentialsClient contains the methods for the StorageAccountCredentials group. Don't use this type directly, use NewStorageAccountCredentialsClient() instead.

func NewStorageAccountCredentialsClient 

func NewStorageAccountCredentialsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StorageAccountCredentialsClient, error)

NewStorageAccountCredentialsClient creates a new instance of StorageAccountCredentialsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*StorageAccountCredentialsClient) BeginCreateOrUpdate 

func (client *StorageAccountCredentialsClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, storageAccountCredential StorageAccountCredential, options *StorageAccountCredentialsClientBeginCreateOrUpdateOptions) (*runtime.Poller[StorageAccountCredentialsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • storageAccountCredential - The storage account credential.
  • options - StorageAccountCredentialsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginCreateOrUpdate method.

func (*StorageAccountCredentialsClient) BeginDelete 

func (client *StorageAccountCredentialsClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *StorageAccountCredentialsClientBeginDeleteOptions) (*runtime.Poller[StorageAccountCredentialsClientDeleteResponse], error)

BeginDelete - Deletes the storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientBeginDeleteOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginDelete method.

func (*StorageAccountCredentialsClient) Get 

func (client *StorageAccountCredentialsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *StorageAccountCredentialsClientGetOptions) (StorageAccountCredentialsClientGetResponse, error)

Get - Gets the properties of the specified storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientGetOptions contains the optional parameters for the StorageAccountCredentialsClient.Get method.

func (*StorageAccountCredentialsClient) NewListByDataBoxEdgeDevicePager 

func (client *StorageAccountCredentialsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountCredentialsClientBeginCreateOrUpdateOptions 

type StorageAccountCredentialsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountCredentialsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginCreateOrUpdate method.

type StorageAccountCredentialsClientBeginDeleteOptions 

type StorageAccountCredentialsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountCredentialsClientBeginDeleteOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginDelete method.

type StorageAccountCredentialsClientCreateOrUpdateResponse 

type StorageAccountCredentialsClientCreateOrUpdateResponse struct {
	StorageAccountCredential
}

StorageAccountCredentialsClientCreateOrUpdateResponse contains the response from method StorageAccountCredentialsClient.BeginCreateOrUpdate.

type StorageAccountCredentialsClientDeleteResponse 

type StorageAccountCredentialsClientDeleteResponse struct {
}

StorageAccountCredentialsClientDeleteResponse contains the response from method StorageAccountCredentialsClient.BeginDelete.

type StorageAccountCredentialsClientGetOptions 

type StorageAccountCredentialsClientGetOptions struct {
}

StorageAccountCredentialsClientGetOptions contains the optional parameters for the StorageAccountCredentialsClient.Get method.

type StorageAccountCredentialsClientGetResponse 

type StorageAccountCredentialsClientGetResponse struct {
	StorageAccountCredential
}

StorageAccountCredentialsClientGetResponse contains the response from method StorageAccountCredentialsClient.Get.

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions 

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions struct {
}

StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse 

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse struct {
	StorageAccountCredentialList
}

StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse contains the response from method StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager.

type StorageAccountList 

type StorageAccountList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of storageAccounts.
	Value []*StorageAccount `json:"value,omitempty" azure:"ro"`
}

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

func (StorageAccountList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccountList.

func (*StorageAccountList) UnmarshalJSON 

func (s *StorageAccountList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountList.

type StorageAccountProperties 

type StorageAccountProperties struct {
	// Data policy of the storage Account.
	DataPolicy *DataPolicy `json:"dataPolicy,omitempty"`

	// Description for the storage Account.
	Description *string `json:"description,omitempty"`

	// Storage Account Credential Id
	StorageAccountCredentialID *string `json:"storageAccountCredentialId,omitempty"`

	// Current status of the storage account
	StorageAccountStatus *StorageAccountStatus `json:"storageAccountStatus,omitempty"`

	// READ-ONLY; BlobEndpoint of Storage Account
	BlobEndpoint *string `json:"blobEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.
	ContainerCount *int32 `json:"containerCount,omitempty" azure:"ro"`
}

StorageAccountProperties - The storage account properties.

func (StorageAccountProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageAccountProperties.

func (*StorageAccountProperties) UnmarshalJSON 

func (s *StorageAccountProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountProperties.

type StorageAccountStatus 

type StorageAccountStatus string

StorageAccountStatus - Current status of the storage account 

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

func PossibleStorageAccountStatusValues 

func PossibleStorageAccountStatusValues() []StorageAccountStatus

PossibleStorageAccountStatusValues returns the possible values for the StorageAccountStatus const type.

type StorageAccountsClient 

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

StorageAccountsClient contains the methods for the StorageAccounts group. Don't use this type directly, use NewStorageAccountsClient() instead.

func NewStorageAccountsClient 

func NewStorageAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StorageAccountsClient, error)

NewStorageAccountsClient creates a new instance of StorageAccountsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*StorageAccountsClient) BeginCreateOrUpdate 

func (client *StorageAccountsClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, storageAccount StorageAccount, options *StorageAccountsClientBeginCreateOrUpdateOptions) (*runtime.Poller[StorageAccountsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new StorageAccount or updates an existing StorageAccount on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The StorageAccount name.
  • resourceGroupName - The resource group name.
  • storageAccount - The StorageAccount properties.
  • options - StorageAccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountsClient.BeginCreateOrUpdate method.

func (*StorageAccountsClient) BeginDelete 

func (client *StorageAccountsClient) BeginDelete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, options *StorageAccountsClientBeginDeleteOptions) (*runtime.Poller[StorageAccountsClientDeleteResponse], error)

BeginDelete - Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The StorageAccount name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientBeginDeleteOptions contains the optional parameters for the StorageAccountsClient.BeginDelete method.

func (*StorageAccountsClient) Get 

func (client *StorageAccountsClient) Get(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, options *StorageAccountsClientGetOptions) (StorageAccountsClientGetResponse, error)

Get - Gets a StorageAccount by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • storageAccountName - The storage account name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientGetOptions contains the optional parameters for the StorageAccountsClient.Get method.

func (*StorageAccountsClient) NewListByDataBoxEdgeDevicePager 

func (client *StorageAccountsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *StorageAccountsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[StorageAccountsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the storage accounts in a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountsClientBeginCreateOrUpdateOptions 

type StorageAccountsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountsClient.BeginCreateOrUpdate method.

type StorageAccountsClientBeginDeleteOptions 

type StorageAccountsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountsClientBeginDeleteOptions contains the optional parameters for the StorageAccountsClient.BeginDelete method.

type StorageAccountsClientCreateOrUpdateResponse 

type StorageAccountsClientCreateOrUpdateResponse struct {
	StorageAccount
}

StorageAccountsClientCreateOrUpdateResponse contains the response from method StorageAccountsClient.BeginCreateOrUpdate.

type StorageAccountsClientDeleteResponse 

type StorageAccountsClientDeleteResponse struct {
}

StorageAccountsClientDeleteResponse contains the response from method StorageAccountsClient.BeginDelete.

type StorageAccountsClientGetOptions 

type StorageAccountsClientGetOptions struct {
}

StorageAccountsClientGetOptions contains the optional parameters for the StorageAccountsClient.Get method.

type StorageAccountsClientGetResponse 

type StorageAccountsClientGetResponse struct {
	StorageAccount
}

StorageAccountsClientGetResponse contains the response from method StorageAccountsClient.Get.

type StorageAccountsClientListByDataBoxEdgeDeviceOptions 

type StorageAccountsClientListByDataBoxEdgeDeviceOptions struct {
}

StorageAccountsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountsClientListByDataBoxEdgeDeviceResponse 

type StorageAccountsClientListByDataBoxEdgeDeviceResponse struct {
	StorageAccountList
}

StorageAccountsClientListByDataBoxEdgeDeviceResponse contains the response from method StorageAccountsClient.NewListByDataBoxEdgeDevicePager.

type SymmetricKey 

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

SymmetricKey - Symmetric key for authentication.

func (SymmetricKey) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SymmetricKey.

func (*SymmetricKey) UnmarshalJSON 

func (s *SymmetricKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SymmetricKey.

type TimeGrain 

type TimeGrain string
const (
	TimeGrainPT12H TimeGrain = "PT12H"
	TimeGrainPT15M TimeGrain = "PT15M"
	TimeGrainPT1D  TimeGrain = "PT1D"
	TimeGrainPT1H  TimeGrain = "PT1H"
	TimeGrainPT1M  TimeGrain = "PT1M"
	TimeGrainPT30M TimeGrain = "PT30M"
	TimeGrainPT5M  TimeGrain = "PT5M"
	TimeGrainPT6H  TimeGrain = "PT6H"
)

func PossibleTimeGrainValues 

func PossibleTimeGrainValues() []TimeGrain

PossibleTimeGrainValues returns the possible values for the TimeGrain const type.

type TrackingInfo 

type TrackingInfo struct {
	// Name of the carrier used in the delivery.
	CarrierName *string `json:"carrierName,omitempty"`

	// Serial number of the device being tracked.
	SerialNumber *string `json:"serialNumber,omitempty"`

	// Tracking ID of the shipment.
	TrackingID *string `json:"trackingId,omitempty"`

	// Tracking URL of the shipment.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

TrackingInfo - Tracking courier information.

func (TrackingInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TrackingInfo.

func (*TrackingInfo) UnmarshalJSON 

func (t *TrackingInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackingInfo.

type Trigger 

type Trigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType `json:"kind,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Trigger details.

func (*Trigger) GetTrigger 

func (t *Trigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type Trigger.

func (Trigger) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Trigger.

func (*Trigger) UnmarshalJSON 

func (t *Trigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Trigger.

type TriggerClassification 

type TriggerClassification interface {
	// GetTrigger returns the Trigger content of the underlying type.
	GetTrigger() *Trigger
}

TriggerClassification provides polymorphic access to related types. Call the interface's GetTrigger() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *FileEventTrigger, *PeriodicTimerEventTrigger, *Trigger

type TriggerEventType 

type TriggerEventType string

TriggerEventType - Trigger Kind. 

const (
	TriggerEventTypeFileEvent          TriggerEventType = "FileEvent"
	TriggerEventTypePeriodicTimerEvent TriggerEventType = "PeriodicTimerEvent"
)

func PossibleTriggerEventTypeValues 

func PossibleTriggerEventTypeValues() []TriggerEventType

PossibleTriggerEventTypeValues returns the possible values for the TriggerEventType const type.

type TriggerList 

type TriggerList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of triggers.
	Value []TriggerClassification `json:"value,omitempty" azure:"ro"`
}

TriggerList - Collection of all trigger on the data box edge device.

func (TriggerList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TriggerList.

func (*TriggerList) UnmarshalJSON 

func (t *TriggerList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerList.

type TriggersClient 

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

TriggersClient contains the methods for the Triggers group. Don't use this type directly, use NewTriggersClient() instead.

func NewTriggersClient 

func NewTriggersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TriggersClient, error)

NewTriggersClient creates a new instance of TriggersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TriggersClient) BeginCreateOrUpdate 

func (client *TriggersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, trigger TriggerClassification, options *TriggersClientBeginCreateOrUpdateOptions) (*runtime.Poller[TriggersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a trigger. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - Creates or updates a trigger
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • trigger - The trigger.
  • options - TriggersClientBeginCreateOrUpdateOptions contains the optional parameters for the TriggersClient.BeginCreateOrUpdate method.

func (*TriggersClient) BeginDelete 

func (client *TriggersClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *TriggersClientBeginDeleteOptions) (*runtime.Poller[TriggersClientDeleteResponse], error)

BeginDelete - Deletes the trigger on the gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.

func (*TriggersClient) Get 

func (client *TriggersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *TriggersClientGetOptions) (TriggersClientGetResponse, error)

Get - Get a specific trigger by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.

func (*TriggersClient) NewListByDataBoxEdgeDevicePager 

func (client *TriggersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *TriggersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[TriggersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the triggers configured in the device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the TriggersClient.NewListByDataBoxEdgeDevicePager method.

type TriggersClientBeginCreateOrUpdateOptions 

type TriggersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginCreateOrUpdateOptions contains the optional parameters for the TriggersClient.BeginCreateOrUpdate method.

type TriggersClientBeginDeleteOptions 

type TriggersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.

type TriggersClientCreateOrUpdateResponse 

type TriggersClientCreateOrUpdateResponse struct {
	TriggerClassification
}

TriggersClientCreateOrUpdateResponse contains the response from method TriggersClient.BeginCreateOrUpdate.

func (*TriggersClientCreateOrUpdateResponse) UnmarshalJSON 

func (t *TriggersClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientCreateOrUpdateResponse.

type TriggersClientDeleteResponse 

type TriggersClientDeleteResponse struct {
}

TriggersClientDeleteResponse contains the response from method TriggersClient.BeginDelete.

type TriggersClientGetOptions 

type TriggersClientGetOptions struct {
}

TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.

type TriggersClientGetResponse 

type TriggersClientGetResponse struct {
	TriggerClassification
}

TriggersClientGetResponse contains the response from method TriggersClient.Get.

func (*TriggersClientGetResponse) UnmarshalJSON 

func (t *TriggersClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientGetResponse.

type TriggersClientListByDataBoxEdgeDeviceOptions 

type TriggersClientListByDataBoxEdgeDeviceOptions struct {
	// Specify $filter='CustomContextTag eq ' to filter on custom context tag property
	Filter *string
}

TriggersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the TriggersClient.NewListByDataBoxEdgeDevicePager method.

type TriggersClientListByDataBoxEdgeDeviceResponse 

type TriggersClientListByDataBoxEdgeDeviceResponse struct {
	TriggerList
}

TriggersClientListByDataBoxEdgeDeviceResponse contains the response from method TriggersClient.NewListByDataBoxEdgeDevicePager.

type UpdateDownloadProgress 

type UpdateDownloadProgress struct {
	// READ-ONLY; The download phase.
	DownloadPhase *DownloadPhase `json:"downloadPhase,omitempty" azure:"ro"`

	// READ-ONLY; Number of updates downloaded.
	NumberOfUpdatesDownloaded *int32 `json:"numberOfUpdatesDownloaded,omitempty" azure:"ro"`

	// READ-ONLY; Number of updates to download.
	NumberOfUpdatesToDownload *int32 `json:"numberOfUpdatesToDownload,omitempty" azure:"ro"`

	// READ-ONLY; Percentage of completion.
	PercentComplete *int32 `json:"percentComplete,omitempty" azure:"ro"`

	// READ-ONLY; Total bytes downloaded.
	TotalBytesDownloaded *float64 `json:"totalBytesDownloaded,omitempty" azure:"ro"`

	// READ-ONLY; Total bytes to download.
	TotalBytesToDownload *float64 `json:"totalBytesToDownload,omitempty" azure:"ro"`
}

UpdateDownloadProgress - Details about the download progress of update.

func (UpdateDownloadProgress) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateDownloadProgress.

func (*UpdateDownloadProgress) UnmarshalJSON 

func (u *UpdateDownloadProgress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateDownloadProgress.

type UpdateInstallProgress 

type UpdateInstallProgress struct {
	// READ-ONLY; Number of updates installed.
	NumberOfUpdatesInstalled *int32 `json:"numberOfUpdatesInstalled,omitempty" azure:"ro"`

	// READ-ONLY; Number of updates to install.
	NumberOfUpdatesToInstall *int32 `json:"numberOfUpdatesToInstall,omitempty" azure:"ro"`

	// READ-ONLY; Percentage completed.
	PercentComplete *int32 `json:"percentComplete,omitempty" azure:"ro"`
}

UpdateInstallProgress - Progress details during installation of updates.

func (UpdateInstallProgress) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateInstallProgress.

func (*UpdateInstallProgress) UnmarshalJSON 

func (u *UpdateInstallProgress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateInstallProgress.

type UpdateOperation 

type UpdateOperation string

UpdateOperation - The current update operation. 

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

func PossibleUpdateOperationValues 

func PossibleUpdateOperationValues() []UpdateOperation

PossibleUpdateOperationValues returns the possible values for the UpdateOperation const type.

type UpdateOperationStage 

type UpdateOperationStage string

UpdateOperationStage - Current stage of the update operation. 

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

func PossibleUpdateOperationStageValues 

func PossibleUpdateOperationStageValues() []UpdateOperationStage

PossibleUpdateOperationStageValues returns the possible values for the UpdateOperationStage const type.

type UpdateSummary 

type UpdateSummary struct {
	// The device update information summary.
	Properties *UpdateSummaryProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

UpdateSummary - Details about ongoing updates and availability of updates on the device.

func (UpdateSummary) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateSummary.

func (*UpdateSummary) UnmarshalJSON 

func (u *UpdateSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummary.

type UpdateSummaryProperties 

type UpdateSummaryProperties struct {
	// The last time when a scan was done on the device.
	DeviceLastScannedDateTime *time.Time `json:"deviceLastScannedDateTime,omitempty"`

	// The current version of the device in format: 1.2.17312.13.",
	DeviceVersionNumber *string `json:"deviceVersionNumber,omitempty"`

	// The current version of the device in text format.
	FriendlyDeviceVersionName *string `json:"friendlyDeviceVersionName,omitempty"`

	// The time when the last scan job was completed (success/cancelled/failed) on the appliance.
	LastCompletedScanJobDateTime *time.Time `json:"lastCompletedScanJobDateTime,omitempty"`

	// READ-ONLY; The job ID of the download job in progress.
	InProgressDownloadJobID *string `json:"inProgressDownloadJobId,omitempty" azure:"ro"`

	// READ-ONLY; The time when the currently running download (if any) started.
	InProgressDownloadJobStartedDateTime *time.Time `json:"inProgressDownloadJobStartedDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The job ID of the install job in progress.
	InProgressInstallJobID *string `json:"inProgressInstallJobId,omitempty" azure:"ro"`

	// READ-ONLY; The time when the currently running install (if any) started.
	InProgressInstallJobStartedDateTime *time.Time `json:"inProgressInstallJobStartedDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The time when the last Download job was completed (success/cancelled/failed) on the appliance.
	LastCompletedDownloadJobDateTime *time.Time `json:"lastCompletedDownloadJobDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The time when the last Install job was completed (success/cancelled/failed) on the appliance.
	LastCompletedInstallJobDateTime *time.Time `json:"lastCompletedInstallJobDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The current update operation.
	OngoingUpdateOperation *UpdateOperation `json:"ongoingUpdateOperation,omitempty" azure:"ro"`

	// READ-ONLY; Indicates if updates are available and at least one of the updates needs a reboot.
	RebootBehavior *InstallRebootBehavior `json:"rebootBehavior,omitempty" azure:"ro"`

	// READ-ONLY; The number of updates available for the current device version as per the last device scan.
	TotalNumberOfUpdatesAvailable *int32 `json:"totalNumberOfUpdatesAvailable,omitempty" azure:"ro"`

	// READ-ONLY; The total number of items pending download.
	TotalNumberOfUpdatesPendingDownload *int32 `json:"totalNumberOfUpdatesPendingDownload,omitempty" azure:"ro"`

	// READ-ONLY; The total number of items pending install.
	TotalNumberOfUpdatesPendingInstall *int32 `json:"totalNumberOfUpdatesPendingInstall,omitempty" azure:"ro"`

	// READ-ONLY; The total size of updates available for download in bytes.
	TotalUpdateSizeInBytes *float64 `json:"totalUpdateSizeInBytes,omitempty" azure:"ro"`

	// READ-ONLY; The list of updates available for install.
	UpdateTitles []*string `json:"updateTitles,omitempty" azure:"ro"`
}

UpdateSummaryProperties - The device update information summary.

func (UpdateSummaryProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateSummaryProperties.

func (*UpdateSummaryProperties) UnmarshalJSON 

func (u *UpdateSummaryProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummaryProperties.

type UploadCertificateRequest 

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

UploadCertificateRequest - The upload certificate request.

func (UploadCertificateRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UploadCertificateRequest.

func (*UploadCertificateRequest) UnmarshalJSON 

func (u *UploadCertificateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadCertificateRequest.

type UploadCertificateResponse 

type UploadCertificateResponse struct {
	// Specifies authentication type.
	AuthType *AuthenticationType `json:"authType,omitempty"`

	// READ-ONLY; Identifier of the target resource that is the recipient of the requested token.
	AADAudience *string `json:"aadAudience,omitempty" azure:"ro"`

	// READ-ONLY; Azure Active Directory tenant authority.
	AADAuthority *string `json:"aadAuthority,omitempty" azure:"ro"`

	// READ-ONLY; Azure Active Directory tenant ID.
	AADTenantID *string `json:"aadTenantId,omitempty" azure:"ro"`

	// READ-ONLY; The azure management endpoint audience.
	AzureManagementEndpointAudience *string `json:"azureManagementEndpointAudience,omitempty" azure:"ro"`

	// READ-ONLY; The resource ID of the Data Box Edge/Gateway device.
	ResourceID *string `json:"resourceId,omitempty" azure:"ro"`

	// READ-ONLY; Azure Active Directory service principal client ID.
	ServicePrincipalClientID *string `json:"servicePrincipalClientId,omitempty" azure:"ro"`

	// READ-ONLY; Azure Active Directory service principal object ID.
	ServicePrincipalObjectID *string `json:"servicePrincipalObjectId,omitempty" azure:"ro"`
}

UploadCertificateResponse - The upload registration certificate response.

func (UploadCertificateResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UploadCertificateResponse.

func (*UploadCertificateResponse) UnmarshalJSON 

func (u *UploadCertificateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadCertificateResponse.

type User 

type User struct {
	// REQUIRED; The storage account credential properties.
	Properties *UserProperties `json:"properties,omitempty"`

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The object name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The hierarchical type of the object.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (User) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type User.

func (*User) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type User.

type UserAccessRight 

type UserAccessRight struct {
	// REQUIRED; Type of access to be allowed for the user.
	AccessType *ShareAccessType `json:"accessType,omitempty"`

	// REQUIRED; User ID (already existing in the device).
	UserID *string `json:"userId,omitempty"`
}

UserAccessRight - The mapping between a particular user and the access type on the SMB share.

func (UserAccessRight) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UserAccessRight.

func (*UserAccessRight) UnmarshalJSON 

func (u *UserAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAccessRight.

type UserList 

type UserList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of users.
	Value []*User `json:"value,omitempty" azure:"ro"`
}

UserList - Collection of users.

func (UserList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UserList.

func (*UserList) UnmarshalJSON 

func (u *UserList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserList.

type UserProperties 

type UserProperties struct {
	// REQUIRED; Type of the user.
	UserType *UserType `json:"userType,omitempty"`

	// The password details.
	EncryptedPassword *AsymmetricEncryptedSecret `json:"encryptedPassword,omitempty"`

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

func (UserProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UserProperties.

func (*UserProperties) UnmarshalJSON 

func (u *UserProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserProperties.

type UserType 

type UserType string

UserType - Type of the user. 

const (
	UserTypeARM             UserType = "ARM"
	UserTypeLocalManagement UserType = "LocalManagement"
	UserTypeShare           UserType = "Share"
)

func PossibleUserTypeValues 

func PossibleUserTypeValues() []UserType

PossibleUserTypeValues returns the possible values for the UserType const type.

type UsersClient 

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

UsersClient contains the methods for the Users group. Don't use this type directly, use NewUsersClient() instead.

func NewUsersClient 

func NewUsersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsersClient, error)

NewUsersClient creates a new instance of UsersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*UsersClient) BeginCreateOrUpdate 

func (client *UsersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, userParam User, options *UsersClientBeginCreateOrUpdateOptions) (*runtime.Poller[UsersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • userParam - The user details.
  • options - UsersClientBeginCreateOrUpdateOptions contains the optional parameters for the UsersClient.BeginCreateOrUpdate method.

func (*UsersClient) BeginDelete 

func (client *UsersClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *UsersClientBeginDeleteOptions) (*runtime.Poller[UsersClientDeleteResponse], error)

BeginDelete - Deletes the user on a databox edge/gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • options - UsersClientBeginDeleteOptions contains the optional parameters for the UsersClient.BeginDelete method.

func (*UsersClient) Get 

func (client *UsersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *UsersClientGetOptions) (UsersClientGetResponse, error)

Get - Gets the properties of the specified user. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • options - UsersClientGetOptions contains the optional parameters for the UsersClient.Get method.

func (*UsersClient) NewListByDataBoxEdgeDevicePager 

func (client *UsersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *UsersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[UsersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the users registered on a Data Box Edge/Data Box Gateway device.

Generated from API version 2019-08-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - UsersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the UsersClient.NewListByDataBoxEdgeDevicePager method.

type UsersClientBeginCreateOrUpdateOptions 

type UsersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

UsersClientBeginCreateOrUpdateOptions contains the optional parameters for the UsersClient.BeginCreateOrUpdate method.

type UsersClientBeginDeleteOptions 

type UsersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

UsersClientBeginDeleteOptions contains the optional parameters for the UsersClient.BeginDelete method.

type UsersClientCreateOrUpdateResponse 

type UsersClientCreateOrUpdateResponse struct {
	User
}

UsersClientCreateOrUpdateResponse contains the response from method UsersClient.BeginCreateOrUpdate.

type UsersClientDeleteResponse 

type UsersClientDeleteResponse struct {
}

UsersClientDeleteResponse contains the response from method UsersClient.BeginDelete.

type UsersClientGetOptions 

type UsersClientGetOptions struct {
}

UsersClientGetOptions contains the optional parameters for the UsersClient.Get method.

type UsersClientGetResponse 

type UsersClientGetResponse struct {
	User
}

UsersClientGetResponse contains the response from method UsersClient.Get.

type UsersClientListByDataBoxEdgeDeviceOptions 

type UsersClientListByDataBoxEdgeDeviceOptions struct {
	// Specify $filter='UserType eq ' to filter on user type property
	Filter *string
}

UsersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the UsersClient.NewListByDataBoxEdgeDevicePager method.

type UsersClientListByDataBoxEdgeDeviceResponse 

type UsersClientListByDataBoxEdgeDeviceResponse struct {
	UserList
}

UsersClientListByDataBoxEdgeDeviceResponse contains the response from method UsersClient.NewListByDataBoxEdgeDevicePager.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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