Devices interface

Interface representing a Devices.

Methods

beginCreateOrUpdateSecuritySettings(string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)

Updates the security settings on a Data Box Edge/Data Box Gateway device.

beginCreateOrUpdateSecuritySettingsAndWait(string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)

Updates the security settings on a Data Box Edge/Data Box Gateway device.

beginDelete(string, string, DevicesDeleteOptionalParams)

Deletes the Data Box Edge/Data Box Gateway device.

beginDeleteAndWait(string, string, DevicesDeleteOptionalParams)

Deletes the Data Box Edge/Data Box Gateway device.

beginDownloadUpdates(string, string, DevicesDownloadUpdatesOptionalParams)

Downloads the updates on a Data Box Edge/Data Box Gateway device.

beginDownloadUpdatesAndWait(string, string, DevicesDownloadUpdatesOptionalParams)

Downloads the updates on a Data Box Edge/Data Box Gateway device.

beginInstallUpdates(string, string, DevicesInstallUpdatesOptionalParams)

Installs the updates on the Data Box Edge/Data Box Gateway device.

beginInstallUpdatesAndWait(string, string, DevicesInstallUpdatesOptionalParams)

Installs the updates on the Data Box Edge/Data Box Gateway device.

beginScanForUpdates(string, string, DevicesScanForUpdatesOptionalParams)

Scans for updates on a Data Box Edge/Data Box Gateway device.

beginScanForUpdatesAndWait(string, string, DevicesScanForUpdatesOptionalParams)

Scans for updates on a Data Box Edge/Data Box Gateway device.

createOrUpdate(string, string, DataBoxEdgeDevice, DevicesCreateOrUpdateOptionalParams)

Creates or updates a Data Box Edge/Data Box Gateway resource.

generateCertificate(string, string, DevicesGenerateCertificateOptionalParams)

Generates certificate for activation key.

get(string, string, DevicesGetOptionalParams)

Gets the properties of the Data Box Edge/Data Box Gateway device.

getExtendedInformation(string, string, DevicesGetExtendedInformationOptionalParams)

Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.

getNetworkSettings(string, string, DevicesGetNetworkSettingsOptionalParams)

Gets the network settings of the specified Data Box Edge/Data Box Gateway device.

getUpdateSummary(string, string, DevicesGetUpdateSummaryOptionalParams)

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.

listByResourceGroup(string, DevicesListByResourceGroupOptionalParams)

Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

listBySubscription(DevicesListBySubscriptionOptionalParams)

Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

update(string, string, DataBoxEdgeDevicePatch, DevicesUpdateOptionalParams)

Modifies a Data Box Edge/Data Box Gateway resource.

updateExtendedInformation(string, string, DataBoxEdgeDeviceExtendedInfoPatch, DevicesUpdateExtendedInformationOptionalParams)

Gets additional information for the specified Data Box Edge/Data Box Gateway device.

uploadCertificate(string, string, UploadCertificateRequest, DevicesUploadCertificateOptionalParams)

Uploads registration certificate for the device.

Method Details

beginCreateOrUpdateSecuritySettings(string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)

Updates the security settings on a Data Box Edge/Data Box Gateway device.

function beginCreateOrUpdateSecuritySettings(deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

securitySettings
SecuritySettings

The security settings.

options
DevicesCreateOrUpdateSecuritySettingsOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCreateOrUpdateSecuritySettingsAndWait(string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)

Updates the security settings on a Data Box Edge/Data Box Gateway device.

function beginCreateOrUpdateSecuritySettingsAndWait(deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

securitySettings
SecuritySettings

The security settings.

options
DevicesCreateOrUpdateSecuritySettingsOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, DevicesDeleteOptionalParams)

Deletes the Data Box Edge/Data Box Gateway device.

function beginDelete(deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, DevicesDeleteOptionalParams)

Deletes the Data Box Edge/Data Box Gateway device.

function beginDeleteAndWait(deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDownloadUpdates(string, string, DevicesDownloadUpdatesOptionalParams)

Downloads the updates on a Data Box Edge/Data Box Gateway device.

function beginDownloadUpdates(deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesDownloadUpdatesOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDownloadUpdatesAndWait(string, string, DevicesDownloadUpdatesOptionalParams)

Downloads the updates on a Data Box Edge/Data Box Gateway device.

function beginDownloadUpdatesAndWait(deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesDownloadUpdatesOptionalParams

The options parameters.

Returns

Promise<void>

beginInstallUpdates(string, string, DevicesInstallUpdatesOptionalParams)

Installs the updates on the Data Box Edge/Data Box Gateway device.

function beginInstallUpdates(deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesInstallUpdatesOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginInstallUpdatesAndWait(string, string, DevicesInstallUpdatesOptionalParams)

Installs the updates on the Data Box Edge/Data Box Gateway device.

function beginInstallUpdatesAndWait(deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesInstallUpdatesOptionalParams

The options parameters.

Returns

Promise<void>

beginScanForUpdates(string, string, DevicesScanForUpdatesOptionalParams)

Scans for updates on a Data Box Edge/Data Box Gateway device.

function beginScanForUpdates(deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesScanForUpdatesOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginScanForUpdatesAndWait(string, string, DevicesScanForUpdatesOptionalParams)

Scans for updates on a Data Box Edge/Data Box Gateway device.

function beginScanForUpdatesAndWait(deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesScanForUpdatesOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, DataBoxEdgeDevice, DevicesCreateOrUpdateOptionalParams)

Creates or updates a Data Box Edge/Data Box Gateway resource.

function createOrUpdate(deviceName: string, resourceGroupName: string, dataBoxEdgeDevice: DataBoxEdgeDevice, options?: DevicesCreateOrUpdateOptionalParams): Promise<DataBoxEdgeDevice>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

dataBoxEdgeDevice
DataBoxEdgeDevice

The resource object.

options
DevicesCreateOrUpdateOptionalParams

The options parameters.

Returns

generateCertificate(string, string, DevicesGenerateCertificateOptionalParams)

Generates certificate for activation key.

function generateCertificate(deviceName: string, resourceGroupName: string, options?: DevicesGenerateCertificateOptionalParams): Promise<GenerateCertResponse>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesGenerateCertificateOptionalParams

The options parameters.

Returns

get(string, string, DevicesGetOptionalParams)

Gets the properties of the Data Box Edge/Data Box Gateway device.

function get(deviceName: string, resourceGroupName: string, options?: DevicesGetOptionalParams): Promise<DataBoxEdgeDevice>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesGetOptionalParams

The options parameters.

Returns

getExtendedInformation(string, string, DevicesGetExtendedInformationOptionalParams)

Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.

function getExtendedInformation(deviceName: string, resourceGroupName: string, options?: DevicesGetExtendedInformationOptionalParams): Promise<DataBoxEdgeDeviceExtendedInfo>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesGetExtendedInformationOptionalParams

The options parameters.

Returns

getNetworkSettings(string, string, DevicesGetNetworkSettingsOptionalParams)

Gets the network settings of the specified Data Box Edge/Data Box Gateway device.

function getNetworkSettings(deviceName: string, resourceGroupName: string, options?: DevicesGetNetworkSettingsOptionalParams): Promise<NetworkSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesGetNetworkSettingsOptionalParams

The options parameters.

Returns

Promise<NetworkSettings>

getUpdateSummary(string, string, DevicesGetUpdateSummaryOptionalParams)

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.

function getUpdateSummary(deviceName: string, resourceGroupName: string, options?: DevicesGetUpdateSummaryOptionalParams): Promise<UpdateSummary>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
DevicesGetUpdateSummaryOptionalParams

The options parameters.

Returns

Promise<UpdateSummary>

listByResourceGroup(string, DevicesListByResourceGroupOptionalParams)

Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: DevicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DataBoxEdgeDevice, DataBoxEdgeDevice[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

options
DevicesListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(DevicesListBySubscriptionOptionalParams)

Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

function listBySubscription(options?: DevicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DataBoxEdgeDevice, DataBoxEdgeDevice[], PageSettings>

Parameters

options
DevicesListBySubscriptionOptionalParams

The options parameters.

Returns

update(string, string, DataBoxEdgeDevicePatch, DevicesUpdateOptionalParams)

Modifies a Data Box Edge/Data Box Gateway resource.

function update(deviceName: string, resourceGroupName: string, parameters: DataBoxEdgeDevicePatch, options?: DevicesUpdateOptionalParams): Promise<DataBoxEdgeDevice>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

parameters
DataBoxEdgeDevicePatch

The resource parameters.

options
DevicesUpdateOptionalParams

The options parameters.

Returns

updateExtendedInformation(string, string, DataBoxEdgeDeviceExtendedInfoPatch, DevicesUpdateExtendedInformationOptionalParams)

Gets additional information for the specified Data Box Edge/Data Box Gateway device.

function updateExtendedInformation(deviceName: string, resourceGroupName: string, parameters: DataBoxEdgeDeviceExtendedInfoPatch, options?: DevicesUpdateExtendedInformationOptionalParams): Promise<DataBoxEdgeDeviceExtendedInfo>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

parameters
DataBoxEdgeDeviceExtendedInfoPatch

The patch object.

options
DevicesUpdateExtendedInformationOptionalParams

The options parameters.

Returns

uploadCertificate(string, string, UploadCertificateRequest, DevicesUploadCertificateOptionalParams)

Uploads registration certificate for the device.

function uploadCertificate(deviceName: string, resourceGroupName: string, parameters: UploadCertificateRequest, options?: DevicesUploadCertificateOptionalParams): Promise<UploadCertificateResponse>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

parameters
UploadCertificateRequest

The upload certificate request.

options
DevicesUploadCertificateOptionalParams

The options parameters.

Returns