Package com.azure.resourcemanager.databoxedge.models

Interface Devices

public interface Devices
Resource collection API of Devices.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<DataBoxEdgeDevice> list()
      Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
      Returns:
      all the Data Box Edge/Data Box Gateway devices in a subscription as paginated response with PagedIterable.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<DataBoxEdgeDevice> list(String expand, com.azure.core.util.Context context)
      Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
      Parameters:
      expand - Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.
      context - The context to associate with this operation.
      Returns:
      all the Data Box Edge/Data Box Gateway devices in a subscription as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DataBoxEdgeDevice> listByResourceGroup(String resourceGroupName)
      Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
      Parameters:
      resourceGroupName - The resource group name.
      Returns:
      all the Data Box Edge/Data Box Gateway devices in a resource group as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DataBoxEdgeDevice> listByResourceGroup(String resourceGroupName, String expand, com.azure.core.util.Context context)
      Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
      Parameters:
      resourceGroupName - The resource group name.
      expand - Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.
      context - The context to associate with this operation.
      Returns:
      all the Data Box Edge/Data Box Gateway devices in a resource group as paginated response with PagedIterable.
      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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<DataBoxEdgeDevice> getByResourceGroupWithResponse(String resourceGroupName, String deviceName, com.azure.core.util.Context context)
      Gets the properties of the Data Box Edge/Data Box Gateway device.
      Parameters:
      resourceGroupName - The resource group name.
      deviceName - The device name.
      context - The context to associate with this operation.
      Returns:
      the properties of the 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.

    • getByResourceGroup

      DataBoxEdgeDevice getByResourceGroup(String resourceGroupName, String deviceName)
      Gets the properties of the Data Box Edge/Data Box Gateway device.
      Parameters:
      resourceGroupName - The resource group name.
      deviceName - The device name.
      Returns:
      the properties of the Data Box Edge/Data Box Gateway device.
      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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String deviceName)
      Deletes the Data Box Edge/Data Box Gateway device.
      Parameters:
      resourceGroupName - The resource group name.
      deviceName - The device name.
      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.

    • delete

      void delete(String resourceGroupName, String deviceName, com.azure.core.util.Context context)
      Deletes the Data Box Edge/Data Box Gateway device.
      Parameters:
      resourceGroupName - The resource group name.
      deviceName - The device name.
      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.

    • downloadUpdates

      void downloadUpdates(String deviceName, String resourceGroupName)
      Downloads the updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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.

    • downloadUpdates

      void downloadUpdates(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Downloads the updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Gets additional information for the specified Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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(String deviceName, String resourceGroupName)
      Gets additional information for the specified Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      Returns:
      additional information for the specified Data Box Edge/Data Box Gateway device.
      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.

    • installUpdates

      void installUpdates(String deviceName, String resourceGroupName)
      Installs the updates on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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.

    • installUpdates

      void installUpdates(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Installs the updates on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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.

    • getNetworkSettingsWithResponse

      com.azure.core.http.rest.Response<NetworkSettings> getNetworkSettingsWithResponse(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      the network settings of 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.

    • getNetworkSettings

      NetworkSettings getNetworkSettings(String deviceName, String resourceGroupName)
      Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      Returns:
      the network settings of the specified Data Box Edge/Data Box Gateway device.
      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(String deviceName, String resourceGroupName)
      Scans for updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Scans for updates on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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.

    • createOrUpdateSecuritySettings

      void createOrUpdateSecuritySettings(String deviceName, String resourceGroupName, SecuritySettings securitySettings)
      Updates the security settings on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      securitySettings - The security settings.
      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.

    • createOrUpdateSecuritySettings

      void createOrUpdateSecuritySettings(String deviceName, String resourceGroupName, SecuritySettings securitySettings, com.azure.core.util.Context context)
      Updates the security settings on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      securitySettings - The security settings.
      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.

    • getUpdateSummaryWithResponse

      com.azure.core.http.rest.Response<UpdateSummary> getUpdateSummaryWithResponse(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      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.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      information about the availability of updates based on the last scan of the 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.

    • getUpdateSummary

      UpdateSummary getUpdateSummary(String deviceName, String resourceGroupName)
      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.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      Returns:
      information about the availability of updates based on the last scan of the device.
      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(String deviceName, String resourceGroupName, UploadCertificateRequest parameters, com.azure.core.util.Context context)
      Uploads registration certificate for the device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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(String deviceName, String resourceGroupName, UploadCertificateRequest parameters)
      Uploads registration certificate for the device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      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.

    • getById

      DataBoxEdgeDevice getById(String id)
      Gets the properties of the Data Box Edge/Data Box Gateway device.
      Parameters:
      id - the resource ID.
      Returns:
      the properties of the 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<DataBoxEdgeDevice> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the properties of the Data Box Edge/Data Box Gateway device.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the properties of the 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.

    • deleteById

      void deleteById(String id)
      Deletes the Data Box Edge/Data Box Gateway device.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the Data Box Edge/Data Box Gateway device.
      Parameters:
      id - the resource ID.
      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.

    • define

      DataBoxEdgeDevice.DefinitionStages.Blank define(String name)
      Begins definition for a new DataBoxEdgeDevice resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new DataBoxEdgeDevice definition.