Devices interface
Interface representing a Devices.
Methods
Method Details
beginCreateOrUpdateAlertSettings(string, string, string, AlertSettings, DevicesCreateOrUpdateAlertSettingsOptionalParams)
Creates or updates the alert settings
function beginCreateOrUpdateAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, alertSettings: AlertSettings, options?: DevicesCreateOrUpdateAlertSettingsOptionalParams): Promise<PollerLike<PollOperationState<AlertSettings>, AlertSettings>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- alertSettings
- AlertSettings
The alert settings.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AlertSettings>, AlertSettings>>
beginCreateOrUpdateAlertSettingsAndWait(string, string, string, AlertSettings, DevicesCreateOrUpdateAlertSettingsOptionalParams)
Creates or updates the alert settings
function beginCreateOrUpdateAlertSettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, alertSettings: AlertSettings, options?: DevicesCreateOrUpdateAlertSettingsOptionalParams): Promise<AlertSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- alertSettings
- AlertSettings
The alert settings.
The options parameters.
Returns
Promise<AlertSettings>
beginCreateOrUpdateSecuritySettings(string, string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)
Creates or updates the security settings.
function beginCreateOrUpdateSecuritySettings(deviceName: string, resourceGroupName: string, managerName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- securitySettings
- SecuritySettings
The security settings.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginCreateOrUpdateSecuritySettingsAndWait(string, string, string, SecuritySettings, DevicesCreateOrUpdateSecuritySettingsOptionalParams)
Creates or updates the security settings.
function beginCreateOrUpdateSecuritySettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, securitySettings: SecuritySettings, options?: DevicesCreateOrUpdateSecuritySettingsOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- securitySettings
- SecuritySettings
The security settings.
The options parameters.
Returns
Promise<void>
beginDeactivate(string, string, string, DevicesDeactivateOptionalParams)
Deactivates the device.
function beginDeactivate(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeactivateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesDeactivateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeactivateAndWait(string, string, string, DevicesDeactivateOptionalParams)
Deactivates the device.
function beginDeactivateAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeactivateOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesDeactivateOptionalParams
The options parameters.
Returns
Promise<void>
beginDelete(string, string, string, DevicesDeleteOptionalParams)
Deletes the device.
function beginDelete(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, DevicesDeleteOptionalParams)
Deletes the device.
function beginDeleteAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeleteOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginDownloadUpdates(string, string, string, DevicesDownloadUpdatesOptionalParams)
Downloads updates on the device.
function beginDownloadUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDownloadUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDownloadUpdatesAndWait(string, string, string, DevicesDownloadUpdatesOptionalParams)
Downloads updates on the device.
function beginDownloadUpdatesAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDownloadUpdatesOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<void>
beginFailover(string, string, string, FailoverRequest, DevicesFailoverOptionalParams)
Fails over the device to another device.
function beginFailover(deviceName: string, resourceGroupName: string, managerName: string, failoverRequest: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- failoverRequest
- FailoverRequest
The failover request.
- options
- DevicesFailoverOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginFailoverAndWait(string, string, string, FailoverRequest, DevicesFailoverOptionalParams)
Fails over the device to another device.
function beginFailoverAndWait(deviceName: string, resourceGroupName: string, managerName: string, failoverRequest: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- failoverRequest
- FailoverRequest
The failover request.
- options
- DevicesFailoverOptionalParams
The options parameters.
Returns
Promise<void>
beginInstallUpdates(string, string, string, DevicesInstallUpdatesOptionalParams)
Installs the updates on the device.
function beginInstallUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginInstallUpdatesAndWait(string, string, string, DevicesInstallUpdatesOptionalParams)
Installs the updates on the device.
function beginInstallUpdatesAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<void>
beginPatch(string, string, string, DevicePatch, DevicesPatchOptionalParams)
Patches the device.
function beginPatch(deviceName: string, resourceGroupName: string, managerName: string, devicePatch: DevicePatch, options?: DevicesPatchOptionalParams): Promise<PollerLike<PollOperationState<Device>, Device>>Parameters
- deviceName
-
string
The device Name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- devicePatch
- DevicePatch
Patch representation of the device.
- options
- DevicesPatchOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Device>, Device>>
beginPatchAndWait(string, string, string, DevicePatch, DevicesPatchOptionalParams)
Patches the device.
function beginPatchAndWait(deviceName: string, resourceGroupName: string, managerName: string, devicePatch: DevicePatch, options?: DevicesPatchOptionalParams): Promise<Device>Parameters
- deviceName
-
string
The device Name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- devicePatch
- DevicePatch
Patch representation of the device.
- options
- DevicesPatchOptionalParams
The options parameters.
Returns
Promise<Device>
beginScanForUpdates(string, string, string, DevicesScanForUpdatesOptionalParams)
Scans for updates on the device.
function beginScanForUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginScanForUpdatesAndWait(string, string, string, DevicesScanForUpdatesOptionalParams)
Scans for updates on the device.
function beginScanForUpdatesAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<void>
get(string, string, string, DevicesGetOptionalParams)
Returns the properties of the specified device name.
function get(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetOptionalParams): Promise<Device>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesGetOptionalParams
The options parameters.
Returns
Promise<Device>
getAlertSettings(string, string, string, DevicesGetAlertSettingsOptionalParams)
Returns the alert settings of the specified device name.
function getAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetAlertSettingsOptionalParams): Promise<AlertSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<AlertSettings>
getNetworkSettings(string, string, string, DevicesGetNetworkSettingsOptionalParams)
Returns the network settings of the specified device name.
function getNetworkSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetNetworkSettingsOptionalParams): Promise<NetworkSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<NetworkSettings>
getTimeSettings(string, string, string, DevicesGetTimeSettingsOptionalParams)
Returns the time settings of the specified device name.
function getTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetTimeSettingsOptionalParams): Promise<TimeSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<TimeSettings>
getUpdateSummary(string, string, string, DevicesGetUpdateSummaryOptionalParams)
Returns the update summary of the specified device name.
function getUpdateSummary(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetUpdateSummaryOptionalParams): Promise<Updates>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
Promise<Updates>
listByManager(string, string, DevicesListByManagerOptionalParams)
Retrieves all the devices in a manager.
function listByManager(resourceGroupName: string, managerName: string, options?: DevicesListByManagerOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listFailoverTarget(string, string, string, DevicesListFailoverTargetOptionalParams)
Retrieves all the devices which can be used as failover targets for the given device.
function listFailoverTarget(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListFailoverTargetOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>Parameters
- deviceName
-
string
The device name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetricDefinition(string, string, string, DevicesListMetricDefinitionOptionalParams)
Retrieves metric definition of all metrics aggregated at device.
function listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>Parameters
- deviceName
-
string
The name of the appliance.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetrics(string, string, string, DevicesListMetricsOptionalParams)
Retrieves the device metrics.
function listMetrics(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>Parameters
- deviceName
-
string
The name of the appliance.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- DevicesListMetricsOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript