Devices Interface

Package:

com.azure.resourcemanager.databoxedge.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-databoxedge:1.0.0-beta.2

public interface Devices

Resource collection API of Devices.

Method Summary

Modifier and Type	Method and Description
abstract void	createOrUpdateSecuritySettings(String deviceName, String resourceGroupName, SecuritySettings securitySettings) Updates the security settings on a Data Box Edge/Data Box Gateway device.
abstract void	createOrUpdateSecuritySettings(String deviceName, String resourceGroupName, SecuritySettings securitySettings, Context context) Updates the security settings on a Data Box Edge/Data Box Gateway device.
abstract Blank	define(String name) Begins definition for a new DataBoxEdgeDevice resource.
abstract void	delete(String resourceGroupName, String deviceName, Context context) Deletes the Data Box Edge/Data Box Gateway device.
abstract void	deleteById(String id) Deletes the Data Box Edge/Data Box Gateway device.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes the Data Box Edge/Data Box Gateway device.
abstract void	deleteByResourceGroup(String resourceGroupName, String deviceName) Deletes the Data Box Edge/Data Box Gateway device.
abstract void	downloadUpdates(String deviceName, String resourceGroupName) Downloads the updates on a Data Box Edge/Data Box Gateway device.
abstract void	downloadUpdates(String deviceName, String resourceGroupName, Context context) Downloads the updates on a Data Box Edge/Data Box Gateway device.
abstract DataBoxEdgeDevice	getById(String id) Gets the properties of the Data Box Edge/Data Box Gateway device.
abstract Response<DataBoxEdgeDevice>	getByIdWithResponse(String id, Context context) Gets the properties of the Data Box Edge/Data Box Gateway device.
abstract DataBoxEdgeDevice	getByResourceGroup(String resourceGroupName, String deviceName) Gets the properties of the Data Box Edge/Data Box Gateway device.
abstract Response<DataBoxEdgeDevice>	getByResourceGroupWithResponse(String resourceGroupName, String deviceName, Context context) Gets the properties of the Data Box Edge/Data Box Gateway device.
abstract DataBoxEdgeDeviceExtendedInfo	getExtendedInformation(String deviceName, String resourceGroupName) Gets additional information for the specified Data Box Edge/Data Box Gateway device.
abstract Response<DataBoxEdgeDeviceExtendedInfo>	getExtendedInformationWithResponse(String deviceName, String resourceGroupName, Context context) Gets additional information for the specified Data Box Edge/Data Box Gateway device.
abstract NetworkSettings	getNetworkSettings(String deviceName, String resourceGroupName) Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
abstract Response<NetworkSettings>	getNetworkSettingsWithResponse(String deviceName, String resourceGroupName, Context context) Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
abstract UpdateSummary	getUpdateSummary(String deviceName, String resourceGroupName) Gets information about the availability of updates based on the last scan of the device.
abstract Response<UpdateSummary>	getUpdateSummaryWithResponse(String deviceName, String resourceGroupName, Context context) Gets information about the availability of updates based on the last scan of the device.
abstract void	installUpdates(String deviceName, String resourceGroupName) Installs the updates on the Data Box Edge/Data Box Gateway device.
abstract void	installUpdates(String deviceName, String resourceGroupName, Context context) Installs the updates on the Data Box Edge/Data Box Gateway device.
abstract PagedIterable<DataBoxEdgeDevice>	list() Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
abstract PagedIterable<DataBoxEdgeDevice>	list(String expand, Context context) Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
abstract PagedIterable<DataBoxEdgeDevice>	listByResourceGroup(String resourceGroupName) Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
abstract PagedIterable<DataBoxEdgeDevice>	listByResourceGroup(String resourceGroupName, String expand, Context context) Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
abstract void	scanForUpdates(String deviceName, String resourceGroupName) Scans for updates on a Data Box Edge/Data Box Gateway device.
abstract void	scanForUpdates(String deviceName, String resourceGroupName, Context context) Scans for updates on a Data Box Edge/Data Box Gateway device.
abstract UploadCertificateResponse	uploadCertificate(String deviceName, String resourceGroupName, UploadCertificateRequest parameters) Uploads registration certificate for the device.
abstract Response<UploadCertificateResponse>	uploadCertificateWithResponse(String deviceName, String resourceGroupName, UploadCertificateRequest parameters, Context context) Uploads registration certificate for the device.

Method Details

createOrUpdateSecuritySettings

public abstract 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.

createOrUpdateSecuritySettings

public abstract void createOrUpdateSecuritySettings(String deviceName, String resourceGroupName, SecuritySettings securitySettings, 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.

define

public abstract 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.

delete

public abstract void delete(String resourceGroupName, String deviceName, 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.

deleteById

public abstract void deleteById(String id)

Deletes the Data Box Edge/Data Box Gateway device.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes the Data Box Edge/Data Box Gateway device.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract 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.

downloadUpdates

public abstract 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.

downloadUpdates

public abstract void downloadUpdates(String deviceName, String resourceGroupName, 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.

getById

public abstract 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<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String deviceName, 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<T>.

getExtendedInformation

public abstract 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.

getExtendedInformationWithResponse

public abstract Response getExtendedInformationWithResponse(String deviceName, String resourceGroupName, 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<T>.

getNetworkSettings

public abstract 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.

getNetworkSettingsWithResponse

public abstract Response getNetworkSettingsWithResponse(String deviceName, String resourceGroupName, 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<T>.

getUpdateSummary

public abstract 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.

getUpdateSummaryWithResponse

public abstract Response getUpdateSummaryWithResponse(String deviceName, String resourceGroupName, 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<T>.

installUpdates

public abstract 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.

installUpdates

public abstract void installUpdates(String deviceName, String resourceGroupName, 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.

list

public abstract PagedIterable 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<T>.

list

public abstract PagedIterable list(String expand, 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<T>.

listByResourceGroup

public abstract PagedIterable 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<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, String expand, 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<T>.

scanForUpdates

public abstract 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.

scanForUpdates

public abstract void scanForUpdates(String deviceName, String resourceGroupName, 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.

uploadCertificate

public abstract 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.

uploadCertificateWithResponse

public abstract Response uploadCertificateWithResponse(String deviceName, String resourceGroupName, UploadCertificateRequest parameters, 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<T>.