Package com.azure.resourcemanager.databoxedge.models

Interface DataBoxEdgeDevice

public interface DataBoxEdgeDevice
An immutable client-side representation of DataBoxEdgeDevice.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      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:
      the location value.

    • tags

      Map<String,String> tags()
      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:
      the tags value.

    • sku

      Sku sku()
      Gets the sku property: The SKU type.
      Returns:
      the sku value.

    • etag

      String etag()
      Gets the etag property: The etag for the devices.
      Returns:
      the etag value.

    • dataBoxEdgeDeviceStatus

      DataBoxEdgeDeviceStatus dataBoxEdgeDeviceStatus()
      Gets the dataBoxEdgeDeviceStatus property: The status of the Data Box Edge/Gateway device.
      Returns:
      the dataBoxEdgeDeviceStatus value.

    • serialNumber

      String serialNumber()
      Gets the serialNumber property: The Serial Number of Data Box Edge/Gateway device.
      Returns:
      the serialNumber value.

    • description

      String description()
      Gets the description property: The Description of the Data Box Edge/Gateway device.
      Returns:
      the description value.

    • modelDescription

      String modelDescription()
      Gets the modelDescription property: The description of the Data Box Edge/Gateway device model.
      Returns:
      the modelDescription value.

    • deviceType

      DeviceType deviceType()
      Gets the deviceType property: The type of the Data Box Edge/Gateway device.
      Returns:
      the deviceType value.

    • friendlyName

      String friendlyName()
      Gets the friendlyName property: The Data Box Edge/Gateway device name.
      Returns:
      the friendlyName value.

    • culture

      String culture()
      Gets the culture property: The Data Box Edge/Gateway device culture.
      Returns:
      the culture value.

    • deviceModel

      String deviceModel()
      Gets the deviceModel property: The Data Box Edge/Gateway device model.
      Returns:
      the deviceModel value.

    • deviceSoftwareVersion

      String deviceSoftwareVersion()
      Gets the deviceSoftwareVersion property: The Data Box Edge/Gateway device software version.
      Returns:
      the deviceSoftwareVersion value.

    • deviceLocalCapacity

      Long deviceLocalCapacity()
      Gets the deviceLocalCapacity property: The Data Box Edge/Gateway device local capacity in MB.
      Returns:
      the deviceLocalCapacity value.

    • timeZone

      String timeZone()
      Gets the timeZone property: The Data Box Edge/Gateway device timezone.
      Returns:
      the timeZone value.

    • deviceHcsVersion

      String deviceHcsVersion()
      Gets the deviceHcsVersion property: The device software version number of the device (eg: 1.2.18105.6).
      Returns:
      the deviceHcsVersion value.

    • configuredRoleTypes

      List<RoleTypes> configuredRoleTypes()
      Gets the configuredRoleTypes property: Type of compute roles configured.
      Returns:
      the configuredRoleTypes value.

    • nodeCount

      Integer nodeCount()
      Gets the nodeCount property: The number of nodes in the cluster.
      Returns:
      the nodeCount value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      DataBoxEdgeDeviceInner innerModel()
      Gets the inner com.azure.resourcemanager.databoxedge.fluent.models.DataBoxEdgeDeviceInner object.
      Returns:
      the inner object.

    • update

      DataBoxEdgeDevice.Update update()
      Begins update for the DataBoxEdgeDevice resource.
      Returns:
      the stage of resource update.

    • refresh

      DataBoxEdgeDevice refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      DataBoxEdgeDevice refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • downloadUpdates

      void downloadUpdates()
      Downloads the updates on a Data Box Edge/Data Box Gateway device.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • downloadUpdates

      void downloadUpdates(com.azure.core.util.Context context)
      Downloads the updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getExtendedInformationWithResponse

      com.azure.core.http.rest.Response<DataBoxEdgeDeviceExtendedInfo> getExtendedInformationWithResponse(com.azure.core.util.Context context)
      Gets additional information for the specified Data Box Edge/Data Box Gateway device.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      additional information for the specified Data Box Edge/Data Box Gateway device along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getExtendedInformation

      DataBoxEdgeDeviceExtendedInfo getExtendedInformation()
      Gets additional information for the specified Data Box Edge/Data Box Gateway device.
      Returns:
      additional information for the specified Data Box Edge/Data Box Gateway device.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • installUpdates

      void installUpdates()
      Installs the updates on the Data Box Edge/Data Box Gateway device.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • installUpdates

      void installUpdates(com.azure.core.util.Context context)
      Installs the updates on the Data Box Edge/Data Box Gateway device.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • scanForUpdates

      void scanForUpdates()
      Scans for updates on a Data Box Edge/Data Box Gateway device.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • scanForUpdates

      void scanForUpdates(com.azure.core.util.Context context)
      Scans for updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • uploadCertificateWithResponse

      com.azure.core.http.rest.Response<UploadCertificateResponse> uploadCertificateWithResponse(UploadCertificateRequest parameters, com.azure.core.util.Context context)
      Uploads registration certificate for the device.
      Parameters:
      parameters - The upload certificate request.
      context - The context to associate with this operation.
      Returns:
      the upload registration certificate response along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • uploadCertificate

      UploadCertificateResponse uploadCertificate(UploadCertificateRequest parameters)
      Uploads registration certificate for the device.
      Parameters:
      parameters - The upload certificate request.
      Returns:
      the upload registration certificate response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.