DeviceSettings interface

Interface representing a DeviceSettings.

Methods

beginCreateOrUpdateAlertSettings(string, string, string, AlertSettings, DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams)

Creates or updates the alert settings of the specified device.

beginCreateOrUpdateAlertSettingsAndWait(string, string, string, AlertSettings, DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams)

Creates or updates the alert settings of the specified device.

beginCreateOrUpdateTimeSettings(string, string, string, TimeSettings, DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams)

Creates or updates the time settings of the specified device.

beginCreateOrUpdateTimeSettingsAndWait(string, string, string, TimeSettings, DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams)

Creates or updates the time settings of the specified device.

beginSyncRemotemanagementCertificate(string, string, string, DeviceSettingsSyncRemotemanagementCertificateOptionalParams)

sync Remote management Certificate between appliance and Service

beginSyncRemotemanagementCertificateAndWait(string, string, string, DeviceSettingsSyncRemotemanagementCertificateOptionalParams)

sync Remote management Certificate between appliance and Service

beginUpdateNetworkSettings(string, string, string, NetworkSettingsPatch, DeviceSettingsUpdateNetworkSettingsOptionalParams)

Updates the network settings on the specified device.

beginUpdateNetworkSettingsAndWait(string, string, string, NetworkSettingsPatch, DeviceSettingsUpdateNetworkSettingsOptionalParams)

Updates the network settings on the specified device.

beginUpdateSecuritySettings(string, string, string, SecuritySettingsPatch, DeviceSettingsUpdateSecuritySettingsOptionalParams)

Patch Security properties of the specified device name.

beginUpdateSecuritySettingsAndWait(string, string, string, SecuritySettingsPatch, DeviceSettingsUpdateSecuritySettingsOptionalParams)

Patch Security properties of the specified device name.

getAlertSettings(string, string, string, DeviceSettingsGetAlertSettingsOptionalParams)

Gets the alert settings of the specified device.

getNetworkSettings(string, string, string, DeviceSettingsGetNetworkSettingsOptionalParams)

Gets the network settings of the specified device.

getSecuritySettings(string, string, string, DeviceSettingsGetSecuritySettingsOptionalParams)

Returns the Security properties of the specified device name.

getTimeSettings(string, string, string, DeviceSettingsGetTimeSettingsOptionalParams)

Gets the time settings of the specified device.

Method Details

beginCreateOrUpdateAlertSettings(string, string, string, AlertSettings, DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams)

Creates or updates the alert settings of the specified device.

function beginCreateOrUpdateAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, parameters: AlertSettings, options?: DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams): Promise<PollerLike<PollOperationState<AlertSettings>, AlertSettings>>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
AlertSettings

The alert settings to be added or updated.

Returns

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

beginCreateOrUpdateAlertSettingsAndWait(string, string, string, AlertSettings, DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams)

Creates or updates the alert settings of the specified device.

function beginCreateOrUpdateAlertSettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, parameters: AlertSettings, options?: DeviceSettingsCreateOrUpdateAlertSettingsOptionalParams): Promise<AlertSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
AlertSettings

The alert settings to be added or updated.

Returns

Promise<AlertSettings>

beginCreateOrUpdateTimeSettings(string, string, string, TimeSettings, DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams)

Creates or updates the time settings of the specified device.

function beginCreateOrUpdateTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, parameters: TimeSettings, options?: DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams): Promise<PollerLike<PollOperationState<TimeSettings>, TimeSettings>>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
TimeSettings

The time settings to be added or updated.

Returns

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

beginCreateOrUpdateTimeSettingsAndWait(string, string, string, TimeSettings, DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams)

Creates or updates the time settings of the specified device.

function beginCreateOrUpdateTimeSettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, parameters: TimeSettings, options?: DeviceSettingsCreateOrUpdateTimeSettingsOptionalParams): Promise<TimeSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
TimeSettings

The time settings to be added or updated.

Returns

Promise<TimeSettings>

beginSyncRemotemanagementCertificate(string, string, string, DeviceSettingsSyncRemotemanagementCertificateOptionalParams)

sync Remote management Certificate between appliance and Service

function beginSyncRemotemanagementCertificate(deviceName: string, resourceGroupName: string, managerName: string, options?: DeviceSettingsSyncRemotemanagementCertificateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

Returns

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

beginSyncRemotemanagementCertificateAndWait(string, string, string, DeviceSettingsSyncRemotemanagementCertificateOptionalParams)

sync Remote management Certificate between appliance and Service

function beginSyncRemotemanagementCertificateAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DeviceSettingsSyncRemotemanagementCertificateOptionalParams): Promise<void>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

Returns

Promise<void>

beginUpdateNetworkSettings(string, string, string, NetworkSettingsPatch, DeviceSettingsUpdateNetworkSettingsOptionalParams)

Updates the network settings on the specified device.

function beginUpdateNetworkSettings(deviceName: string, resourceGroupName: string, managerName: string, parameters: NetworkSettingsPatch, options?: DeviceSettingsUpdateNetworkSettingsOptionalParams): Promise<PollerLike<PollOperationState<NetworkSettings>, NetworkSettings>>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
NetworkSettingsPatch

The network settings to be updated.

options
DeviceSettingsUpdateNetworkSettingsOptionalParams

The options parameters.

Returns

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

beginUpdateNetworkSettingsAndWait(string, string, string, NetworkSettingsPatch, DeviceSettingsUpdateNetworkSettingsOptionalParams)

Updates the network settings on the specified device.

function beginUpdateNetworkSettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, parameters: NetworkSettingsPatch, options?: DeviceSettingsUpdateNetworkSettingsOptionalParams): Promise<NetworkSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
NetworkSettingsPatch

The network settings to be updated.

options
DeviceSettingsUpdateNetworkSettingsOptionalParams

The options parameters.

Returns

Promise<NetworkSettings>

beginUpdateSecuritySettings(string, string, string, SecuritySettingsPatch, DeviceSettingsUpdateSecuritySettingsOptionalParams)

Patch Security properties of the specified device name.

function beginUpdateSecuritySettings(deviceName: string, resourceGroupName: string, managerName: string, parameters: SecuritySettingsPatch, options?: DeviceSettingsUpdateSecuritySettingsOptionalParams): Promise<PollerLike<PollOperationState<SecuritySettings>, SecuritySettings>>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
SecuritySettingsPatch

The security settings properties to be patched.

options
DeviceSettingsUpdateSecuritySettingsOptionalParams

The options parameters.

Returns

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

beginUpdateSecuritySettingsAndWait(string, string, string, SecuritySettingsPatch, DeviceSettingsUpdateSecuritySettingsOptionalParams)

Patch Security properties of the specified device name.

function beginUpdateSecuritySettingsAndWait(deviceName: string, resourceGroupName: string, managerName: string, parameters: SecuritySettingsPatch, options?: DeviceSettingsUpdateSecuritySettingsOptionalParams): Promise<SecuritySettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
SecuritySettingsPatch

The security settings properties to be patched.

options
DeviceSettingsUpdateSecuritySettingsOptionalParams

The options parameters.

Returns

Promise<SecuritySettings>

getAlertSettings(string, string, string, DeviceSettingsGetAlertSettingsOptionalParams)

Gets the alert settings of the specified device.

function getAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DeviceSettingsGetAlertSettingsOptionalParams): Promise<AlertSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
DeviceSettingsGetAlertSettingsOptionalParams

The options parameters.

Returns

Promise<AlertSettings>

getNetworkSettings(string, string, string, DeviceSettingsGetNetworkSettingsOptionalParams)

Gets the network settings of the specified device.

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

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
DeviceSettingsGetNetworkSettingsOptionalParams

The options parameters.

Returns

Promise<NetworkSettings>

getSecuritySettings(string, string, string, DeviceSettingsGetSecuritySettingsOptionalParams)

Returns the Security properties of the specified device name.

function getSecuritySettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DeviceSettingsGetSecuritySettingsOptionalParams): Promise<SecuritySettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
DeviceSettingsGetSecuritySettingsOptionalParams

The options parameters.

Returns

Promise<SecuritySettings>

getTimeSettings(string, string, string, DeviceSettingsGetTimeSettingsOptionalParams)

Gets the time settings of the specified device.

function getTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: DeviceSettingsGetTimeSettingsOptionalParams): Promise<TimeSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
DeviceSettingsGetTimeSettingsOptionalParams

The options parameters.

Returns

Promise<TimeSettings>