DevicesOperations interface

Package:

@azure/arm-databoxedge

Interface representing a Devices operations.

Properties

beginCreateOrUpdateSecuritySettings
beginCreateOrUpdateSecuritySettingsAndWait
beginDelete
beginDeleteAndWait
beginDownloadUpdates
beginDownloadUpdatesAndWait
beginInstallUpdates
beginInstallUpdatesAndWait
beginScanForUpdates
beginScanForUpdatesAndWait
createOrUpdate	Creates or updates a Data Box Edge/Data Box Gateway resource.
createOrUpdateSecuritySettings	Updates the security settings on a Data Box Edge/Data Box Gateway device.
delete	Deletes the Data Box Edge/Data Box Gateway device.
downloadUpdates	Downloads the updates on a Data Box Edge/Data Box Gateway device.
generateCertificate	Generates certificate for activation key.
get	Gets the properties of the Data Box Edge/Data Box Gateway device.
getExtendedInformation	Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
getNetworkSettings	Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
getUpdateSummary	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.
installUpdates	Installs the updates on the Data Box Edge/Data Box Gateway device.
listByResourceGroup	Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
listBySubscription	Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
scanForUpdates	Scans for updates on a Data Box Edge/Data Box Gateway device.
update	Modifies a Data Box Edge/Data Box Gateway resource.
updateExtendedInformation	Gets additional information for the specified Data Box Edge/Data Box Gateway device.
uploadCertificate	Uploads registration certificate for the device.

Property Details

beginCreateOrUpdateSecuritySettings

Warning

This API is now deprecated.

use createOrUpdateSecuritySettings instead

beginCreateOrUpdateSecuritySettings: (deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginCreateOrUpdateSecuritySettingsAndWait

Warning

This API is now deprecated.

use createOrUpdateSecuritySettings instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDownloadUpdates

Warning

This API is now deprecated.

use downloadUpdates instead

beginDownloadUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDownloadUpdatesAndWait

Warning

This API is now deprecated.

use downloadUpdates instead

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

Property Value

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

beginInstallUpdates

Warning

This API is now deprecated.

use installUpdates instead

beginInstallUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginInstallUpdatesAndWait

Warning

This API is now deprecated.

use installUpdates instead

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

Property Value

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

beginScanForUpdates

Warning

This API is now deprecated.

use scanForUpdates instead

beginScanForUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginScanForUpdatesAndWait

Warning

This API is now deprecated.

use scanForUpdates instead

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

Property Value

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

createOrUpdate

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

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

Property Value

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

createOrUpdateSecuritySettings

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

createOrUpdateSecuritySettings: (deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, resourceGroupName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams) => PollerLike<OperationState<void>, void>

delete

Deletes the Data Box Edge/Data Box Gateway device.

delete: (deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

downloadUpdates

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

downloadUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesDownloadUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

generateCertificate

Generates certificate for activation key.

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

Property Value

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

get

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

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

Property Value

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

getExtendedInformation

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

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

Property Value

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

getNetworkSettings

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

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

Property Value

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

getUpdateSummary

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.

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

Property Value

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

installUpdates

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

installUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesInstallUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

listByResourceGroup

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

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

Property Value

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

listBySubscription

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

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

Property Value

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

scanForUpdates

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

scanForUpdates: (deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, resourceGroupName: string, options?: DevicesScanForUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

update

Modifies a Data Box Edge/Data Box Gateway resource.

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

Property Value

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

updateExtendedInformation

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

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

Property Value

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

uploadCertificate

Uploads registration certificate for the device.

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

Property Value

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