databoxedgeapi

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Index

• type AddonsClientAPI
• type AlertsClientAPI
• type AvailableSkusClientAPI
• type BandwidthSchedulesClientAPI
• type ContainersClientAPI
• type DevicesClientAPI
• type JobsClientAPI
• type MonitoringConfigClientAPI
• type NodesClientAPI
• type OperationsClientAPI
• type OperationsStatusClientAPI
• type OrdersClientAPI
• type RolesClientAPI
• type SharesClientAPI
• type StorageAccountCredentialsClientAPI
• type StorageAccountsClientAPI
• type TriggersClientAPI
• type UsersClientAPI

Types

type AddonsClientAPI

type AddonsClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, roleName string, addonName string, addon databoxedge.BasicAddon, resourceGroupName string) (result databoxedge.AddonsCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, roleName string, addonName string, resourceGroupName string) (result databoxedge.AddonsDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, roleName string, addonName string, resourceGroupName string) (result databoxedge.AddonModel, err error)
	ListByRole(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.AddonListPage, err error)
	ListByRoleComplete(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.AddonListIterator, err error)
}

AddonsClientAPI contains the set of methods on the AddonsClient type.

type AlertsClientAPI

type AlertsClientAPI interface {
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.Alert, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.AlertListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.AlertListIterator, err error)
}

AlertsClientAPI contains the set of methods on the AlertsClient type.

type AvailableSkusClientAPI

type AvailableSkusClientAPI interface {
	List(ctx context.Context) (result databoxedge.SkuListPage, err error)
	ListComplete(ctx context.Context) (result databoxedge.SkuListIterator, err error)
}

AvailableSkusClientAPI contains the set of methods on the AvailableSkusClient type.

type BandwidthSchedulesClientAPI

type BandwidthSchedulesClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, parameters databoxedge.BandwidthSchedule, resourceGroupName string) (result databoxedge.BandwidthSchedulesCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.BandwidthSchedulesDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.BandwidthSchedule, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.BandwidthSchedulesListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.BandwidthSchedulesListIterator, err error)
}

BandwidthSchedulesClientAPI contains the set of methods on the BandwidthSchedulesClient type.

type ContainersClientAPI

type ContainersClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, containerName string, containerParameter databoxedge.Container, resourceGroupName string) (result databoxedge.ContainersCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result databoxedge.ContainersDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result databoxedge.Container, err error)
	ListByStorageAccount(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result databoxedge.ContainerListPage, err error)
	ListByStorageAccountComplete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result databoxedge.ContainerListIterator, err error)
	Refresh(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string) (result databoxedge.ContainersRefreshFuture, err error)
}

ContainersClientAPI contains the set of methods on the ContainersClient type.

type DevicesClientAPI

type DevicesClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, dataBoxEdgeDevice databoxedge.Device, resourceGroupName string) (result databoxedge.DevicesCreateOrUpdateFuture, err error)
	CreateOrUpdateSecuritySettings(ctx context.Context, deviceName string, securitySettings databoxedge.SecuritySettings, resourceGroupName string) (result databoxedge.DevicesCreateOrUpdateSecuritySettingsFuture, err error)
	Delete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DevicesDeleteFuture, err error)
	DownloadUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DevicesDownloadUpdatesFuture, err error)
	GenerateCertificate(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.GenerateCertResponse, err error)
	Get(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.Device, err error)
	GetExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DeviceExtendedInfo, err error)
	GetNetworkSettings(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.NetworkSettings, err error)
	GetUpdateSummary(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.UpdateSummary, err error)
	InstallUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DevicesInstallUpdatesFuture, err error)
	ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string) (result databoxedge.DeviceListPage, err error)
	ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand string) (result databoxedge.DeviceListIterator, err error)
	ListBySubscription(ctx context.Context, expand string) (result databoxedge.DeviceListPage, err error)
	ListBySubscriptionComplete(ctx context.Context, expand string) (result databoxedge.DeviceListIterator, err error)
	ScanForUpdates(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DevicesScanForUpdatesFuture, err error)
	Update(ctx context.Context, deviceName string, parameters databoxedge.DevicePatch, resourceGroupName string) (result databoxedge.Device, err error)
	UpdateExtendedInformation(ctx context.Context, deviceName string, parameters databoxedge.DeviceExtendedInfoPatch, resourceGroupName string) (result databoxedge.DeviceExtendedInfo, err error)
	UploadCertificate(ctx context.Context, deviceName string, parameters databoxedge.UploadCertificateRequest, resourceGroupName string) (result databoxedge.UploadCertificateResponse, err error)
}

DevicesClientAPI contains the set of methods on the DevicesClient type.

type JobsClientAPI

type JobsClientAPI interface {
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.Job, err error)
}

JobsClientAPI contains the set of methods on the JobsClient type.

type MonitoringConfigClientAPI

type MonitoringConfigClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, roleName string, monitoringMetricConfiguration databoxedge.MonitoringMetricConfiguration, resourceGroupName string) (result databoxedge.MonitoringConfigCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.MonitoringConfigDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.MonitoringMetricConfiguration, err error)
	List(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.MonitoringMetricConfigurationListPage, err error)
	ListComplete(ctx context.Context, deviceName string, roleName string, resourceGroupName string) (result databoxedge.MonitoringMetricConfigurationListIterator, err error)
}

MonitoringConfigClientAPI contains the set of methods on the MonitoringConfigClient type.

type NodesClientAPI

type NodesClientAPI interface {
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.NodeListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.NodeListIterator, err error)
}

NodesClientAPI contains the set of methods on the NodesClient type.

type OperationsClientAPI

type OperationsClientAPI interface {
	List(ctx context.Context) (result databoxedge.OperationsListPage, err error)
	ListComplete(ctx context.Context) (result databoxedge.OperationsListIterator, err error)
}

OperationsClientAPI contains the set of methods on the OperationsClient type.

type OperationsStatusClientAPI

type OperationsStatusClientAPI interface {
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.Job, err error)
}

OperationsStatusClientAPI contains the set of methods on the OperationsStatusClient type.

type OrdersClientAPI

type OrdersClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, order databoxedge.Order, resourceGroupName string) (result databoxedge.OrdersCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.OrdersDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.Order, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.OrderListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.OrderListIterator, err error)
	ListDCAccessCode(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.DCAccessCode, err error)
}

OrdersClientAPI contains the set of methods on the OrdersClient type.

type RolesClientAPI

type RolesClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, role databoxedge.BasicRole, resourceGroupName string) (result databoxedge.RolesCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.RolesDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.RoleModel, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.RoleListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.RoleListIterator, err error)
}

RolesClientAPI contains the set of methods on the RolesClient type.

type SharesClientAPI

type SharesClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, share databoxedge.Share, resourceGroupName string) (result databoxedge.SharesCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.SharesDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.Share, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.ShareListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.ShareListIterator, err error)
	Refresh(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.SharesRefreshFuture, err error)
}

SharesClientAPI contains the set of methods on the SharesClient type.

type StorageAccountCredentialsClientAPI

type StorageAccountCredentialsClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, storageAccountCredential databoxedge.StorageAccountCredential, resourceGroupName string) (result databoxedge.StorageAccountCredentialsCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.StorageAccountCredentialsDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.StorageAccountCredential, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.StorageAccountCredentialListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.StorageAccountCredentialListIterator, err error)
}

StorageAccountCredentialsClientAPI contains the set of methods on the StorageAccountCredentialsClient type.

type StorageAccountsClientAPI

type StorageAccountsClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, storageAccount databoxedge.StorageAccount, resourceGroupName string) (result databoxedge.StorageAccountsCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result databoxedge.StorageAccountsDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string) (result databoxedge.StorageAccount, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.StorageAccountListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string) (result databoxedge.StorageAccountListIterator, err error)
}

StorageAccountsClientAPI contains the set of methods on the StorageAccountsClient type.

type TriggersClientAPI

type TriggersClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, trigger databoxedge.BasicTrigger, resourceGroupName string) (result databoxedge.TriggersCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.TriggersDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.TriggerModel, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result databoxedge.TriggerListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result databoxedge.TriggerListIterator, err error)
}

TriggersClientAPI contains the set of methods on the TriggersClient type.

type UsersClientAPI

type UsersClientAPI interface {
	CreateOrUpdate(ctx context.Context, deviceName string, name string, userParameter databoxedge.User, resourceGroupName string) (result databoxedge.UsersCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.UsersDeleteFuture, err error)
	Get(ctx context.Context, deviceName string, name string, resourceGroupName string) (result databoxedge.User, err error)
	ListByDataBoxEdgeDevice(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result databoxedge.UserListPage, err error)
	ListByDataBoxEdgeDeviceComplete(ctx context.Context, deviceName string, resourceGroupName string, filter string) (result databoxedge.UserListIterator, err error)
}

UsersClientAPI contains the set of methods on the UsersClient type.