DataBoxEdgeDevice Interface
public interface DataBoxEdgeDevice
An immutable client-side representation of DataBoxEdgeDevice.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abstract
List<Role |
configuredRoleTypes()
Gets the configured |
| abstract String |
culture()
Gets the culture property: The Data Box Edge/Gateway device culture. |
|
abstract
Data |
dataBoxEdgeDeviceStatus()
Gets the data |
| abstract String |
description()
Gets the description property: The Description of the Data Box Edge/Gateway device. |
| abstract String |
deviceHcsVersion()
Gets the device |
| abstract Long |
deviceLocalCapacity()
Gets the device |
| abstract String |
deviceModel()
Gets the device |
| abstract String |
deviceSoftwareVersion()
Gets the device |
|
abstract
Device |
deviceType()
Gets the device |
| abstract void |
downloadUpdates()
Downloads the updates on a Data Box Edge/Data Box Gateway device. |
| abstract void |
downloadUpdates(Context context)
Downloads the updates on a Data Box Edge/Data Box Gateway device. |
| abstract String |
etag()
Gets the etag property: The etag for the devices. |
| abstract String |
friendlyName()
Gets the friendly |
|
abstract
Data |
getExtendedInformation()
Gets additional information for the specified Data Box Edge/Data Box Gateway device. |
|
abstract
Response<Data |
getExtendedInformationWithResponse(Context context)
Gets additional information for the specified Data Box Edge/Data Box Gateway device. |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Data |
innerModel()
Gets the inner com. |
| abstract void |
installUpdates()
Installs the updates on the Data Box Edge/Data Box Gateway device. |
| abstract void |
installUpdates(Context context)
Installs the updates on the Data Box Edge/Data Box Gateway device. |
| abstract String |
location()
Gets the location property: The location of the device. |
| abstract String |
modelDescription()
Gets the model |
| abstract String |
name()
Gets the name property: The name of the resource. |
| abstract Integer |
nodeCount()
Gets the node |
|
abstract
Data |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Data |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract void |
scanForUpdates()
Scans for updates on a Data Box Edge/Data Box Gateway device. |
| abstract void |
scanForUpdates(Context context)
Scans for updates on a Data Box Edge/Data Box Gateway device. |
| abstract String |
serialNumber()
Gets the serial |
| abstract Sku |
sku()
Gets the sku property: The SKU type. |
| abstract Map<String,String> |
tags()
Gets the tags property: The list of tags that describe the device. |
| abstract String |
timeZone()
Gets the time |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Data |
|
abstract
Upload |
uploadCertificate(UploadCertificateRequest parameters)
Uploads registration certificate for the device. |
|
abstract
Response<Upload |
uploadCertificateWithResponse(UploadCertificateRequest parameters, Context context)
Uploads registration certificate for the device. |
Method Details
configuredRoleTypes
public abstract List
Gets the configuredRoleTypes property: Type of compute roles configured.
Returns:
culture
public abstract String culture()
Gets the culture property: The Data Box Edge/Gateway device culture.
Returns:
dataBoxEdgeDeviceStatus
public abstract DataBoxEdgeDeviceStatus dataBoxEdgeDeviceStatus()
Gets the dataBoxEdgeDeviceStatus property: The status of the Data Box Edge/Gateway device.
Returns:
description
public abstract String description()
Gets the description property: The Description of the Data Box Edge/Gateway device.
Returns:
deviceHcsVersion
public abstract String deviceHcsVersion()
Gets the deviceHcsVersion property: The device software version number of the device (eg: 1.2.18105.6).
Returns:
deviceLocalCapacity
public abstract Long deviceLocalCapacity()
Gets the deviceLocalCapacity property: The Data Box Edge/Gateway device local capacity in MB.
Returns:
deviceModel
public abstract String deviceModel()
Gets the deviceModel property: The Data Box Edge/Gateway device model.
Returns:
deviceSoftwareVersion
public abstract String deviceSoftwareVersion()
Gets the deviceSoftwareVersion property: The Data Box Edge/Gateway device software version.
Returns:
deviceType
public abstract DeviceType deviceType()
Gets the deviceType property: The type of the Data Box Edge/Gateway device.
Returns:
downloadUpdates
public abstract void downloadUpdates()
Downloads the updates on a Data Box Edge/Data Box Gateway device.
downloadUpdates
public abstract void downloadUpdates(Context context)
Downloads the updates on a Data Box Edge/Data Box Gateway device.
Parameters:
etag
public abstract String etag()
Gets the etag property: The etag for the devices.
Returns:
friendlyName
public abstract String friendlyName()
Gets the friendlyName property: The Data Box Edge/Gateway device name.
Returns:
getExtendedInformation
public abstract DataBoxEdgeDeviceExtendedInfo getExtendedInformation()
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
Returns:
getExtendedInformationWithResponse
public abstract Response
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
Parameters:
Returns:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
innerModel
public abstract DataBoxEdgeDeviceInner innerModel()
Gets the inner com.azure.resourcemanager.databoxedge.fluent.models.DataBoxEdgeDeviceInner object.
Returns:
installUpdates
public abstract void installUpdates()
Installs the updates on the Data Box Edge/Data Box Gateway device.
installUpdates
public abstract void installUpdates(Context context)
Installs the updates on the Data Box Edge/Data Box Gateway device.
Parameters:
location
public abstract String location()
Gets the location property: 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.
Returns:
modelDescription
public abstract String modelDescription()
Gets the modelDescription property: The description of the Data Box Edge/Gateway device model.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
nodeCount
public abstract Integer nodeCount()
Gets the nodeCount property: The number of nodes in the cluster.
Returns:
refresh
public abstract DataBoxEdgeDevice refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract DataBoxEdgeDevice refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
scanForUpdates
public abstract void scanForUpdates()
Scans for updates on a Data Box Edge/Data Box Gateway device.
scanForUpdates
public abstract void scanForUpdates(Context context)
Scans for updates on a Data Box Edge/Data Box Gateway device.
Parameters:
serialNumber
public abstract String serialNumber()
Gets the serialNumber property: The Serial Number of Data Box Edge/Gateway device.
Returns:
sku
public abstract Sku sku()
Gets the sku property: The SKU type.
Returns:
tags
public abstract Map
Gets the tags property: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
Returns:
timeZone
public abstract String timeZone()
Gets the timeZone property: The Data Box Edge/Gateway device timezone.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract DataBoxEdgeDevice.Update update()
Begins update for the DataBoxEdgeDevice resource.
Returns:
uploadCertificate
public abstract UploadCertificateResponse uploadCertificate(UploadCertificateRequest parameters)
Uploads registration certificate for the device.
Parameters:
Returns:
uploadCertificateWithResponse
public abstract Response
Uploads registration certificate for the device.
Parameters:
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for