Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Devices

Package version

Class representing a Devices.

Hierarchy

  • Devices

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdateAlertSettings

  • beginCreateOrUpdateAlertSettings(deviceName: string, alertSettings: AlertSettings, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates or updates the alert settings

    Parameters

    • deviceName: string

      The device name.

    • alertSettings: AlertSettings

      The alert settings.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginCreateOrUpdateSecuritySettings

  • beginCreateOrUpdateSecuritySettings(deviceName: string, securitySettings: SecuritySettings, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates or updates the security settings.

    Parameters

    • deviceName: string

      The device name.

    • securitySettings: SecuritySettings

      The security settings.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeactivate

  • beginDeactivate(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deactivates the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDownloadUpdates

  • beginDownloadUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Downloads udpates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginFailover

  • beginFailover(deviceName: string, failoverRequest: FailoverRequest, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Fails over the device to another device.

    Parameters

    • deviceName: string

      The device name.

    • failoverRequest: FailoverRequest

      The failover request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginInstallUpdates

  • beginInstallUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Installs the updates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginPatch

  • beginPatch(deviceName: string, devicePatch: DevicePatch, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Patches the device.

    Parameters

    • deviceName: string

      The device Name.

    • devicePatch: DevicePatch

      Patch representation of the device.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginScanForUpdates

  • beginScanForUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Scans for updates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdateAlertSettings

  • createOrUpdateAlertSettings(deviceName: string, alertSettings: AlertSettings, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesCreateOrUpdateAlertSettingsResponse>

  • Creates or updates the alert settings

    Parameters

    • deviceName: string

      The device name.

    • alertSettings: AlertSettings

      The alert settings.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesCreateOrUpdateAlertSettingsResponse>

    Promise<Models.DevicesCreateOrUpdateAlertSettingsResponse>

createOrUpdateSecuritySettings

  • createOrUpdateSecuritySettings(deviceName: string, securitySettings: SecuritySettings, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Creates or updates the security settings.

    Parameters

    • deviceName: string

      The device name.

    • securitySettings: SecuritySettings

      The security settings.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

deactivate

  • deactivate(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deactivates the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

deleteMethod

  • deleteMethod(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

downloadUpdates

  • downloadUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Downloads udpates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

failover

  • failover(deviceName: string, failoverRequest: FailoverRequest, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Fails over the device to another device.

    Parameters

    • deviceName: string

      The device name.

    • failoverRequest: FailoverRequest

      The failover request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(deviceName: string, resourceGroupName: string, managerName: string, options?: Models.DevicesGetOptionalParams): Promise<Models.DevicesGetResponse>
  • get(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Device>): void
  • get(deviceName: string, resourceGroupName: string, managerName: string, options: DevicesGetOptionalParams, callback: msRest.ServiceCallback<Device>): void

  • Returns the properties of the specified device name.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.DevicesGetOptionalParams

    Returns Promise<Models.DevicesGetResponse>

    Promise<Models.DevicesGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Device>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: DevicesGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Device>

      The callback

    Returns void

getAlertSettings

  • getAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesGetAlertSettingsResponse>
  • getAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<AlertSettings>): void
  • getAlertSettings(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertSettings>): void

  • Returns the alert settings of the specified device name.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesGetAlertSettingsResponse>

    Promise<Models.DevicesGetAlertSettingsResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<AlertSettings>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertSettings>

      The callback

    Returns void

getNetworkSettings

  • getNetworkSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesGetNetworkSettingsResponse>
  • getNetworkSettings(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<NetworkSettings>): void
  • getNetworkSettings(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NetworkSettings>): void

  • Returns the network settings of the specified device name.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesGetNetworkSettingsResponse>

    Promise<Models.DevicesGetNetworkSettingsResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<NetworkSettings>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NetworkSettings>

      The callback

    Returns void

getTimeSettings

  • getTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesGetTimeSettingsResponse>
  • getTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<TimeSettings>): void
  • getTimeSettings(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TimeSettings>): void

  • Returns the time settings of the specified device name.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesGetTimeSettingsResponse>

    Promise<Models.DevicesGetTimeSettingsResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<TimeSettings>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TimeSettings>

      The callback

    Returns void

getUpdateSummary

  • getUpdateSummary(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesGetUpdateSummaryResponse>
  • getUpdateSummary(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Updates>): void
  • getUpdateSummary(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Updates>): void

  • Returns the update summary of the specified device name.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesGetUpdateSummaryResponse>

    Promise<Models.DevicesGetUpdateSummaryResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Updates>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Updates>

      The callback

    Returns void

installUpdates

  • installUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Installs the updates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

listByManager

  • listByManager(resourceGroupName: string, managerName: string, options?: Models.DevicesListByManagerOptionalParams): Promise<Models.DevicesListByManagerResponse>
  • listByManager(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<DeviceList>): void
  • listByManager(resourceGroupName: string, managerName: string, options: DevicesListByManagerOptionalParams, callback: msRest.ServiceCallback<DeviceList>): void

  • Retrieves all the devices in a manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.DevicesListByManagerOptionalParams

    Returns Promise<Models.DevicesListByManagerResponse>

    Promise<Models.DevicesListByManagerResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<DeviceList>

      The callback

    Returns void

  • Parameters

    Returns void

listFailoverTarget

  • listFailoverTarget(deviceName: string, resourceGroupName: string, managerName: string, options?: Models.DevicesListFailoverTargetOptionalParams): Promise<Models.DevicesListFailoverTargetResponse>
  • listFailoverTarget(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<DeviceList>): void
  • listFailoverTarget(deviceName: string, resourceGroupName: string, managerName: string, options: DevicesListFailoverTargetOptionalParams, callback: msRest.ServiceCallback<DeviceList>): void

  • Retrieves all the devices which can be used as failover targets for the given device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.DevicesListFailoverTargetOptionalParams

    Returns Promise<Models.DevicesListFailoverTargetResponse>

    Promise<Models.DevicesListFailoverTargetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<DeviceList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: DevicesListFailoverTargetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<DeviceList>

      The callback

    Returns void

listMetricDefinition

  • listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesListMetricDefinitionResponse>
  • listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricDefinitionList>): void
  • listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MetricDefinitionList>): void

  • Retrieves metric definition of all metrics aggregated at device.

    Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesListMetricDefinitionResponse>

    Promise<Models.DevicesListMetricDefinitionResponse>

  • Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricDefinitionList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MetricDefinitionList>

      The callback

    Returns void

listMetrics

  • listMetrics(deviceName: string, resourceGroupName: string, managerName: string, options?: Models.DevicesListMetricsOptionalParams): Promise<Models.DevicesListMetricsResponse>
  • listMetrics(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricList>): void
  • listMetrics(deviceName: string, resourceGroupName: string, managerName: string, options: DevicesListMetricsOptionalParams, callback: msRest.ServiceCallback<MetricList>): void

  • Retrieves the device metrics.

    Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.DevicesListMetricsOptionalParams

    Returns Promise<Models.DevicesListMetricsResponse>

    Promise<Models.DevicesListMetricsResponse>

  • Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The name of the appliance.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: DevicesListMetricsOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

patch

  • patch(deviceName: string, devicePatch: DevicePatch, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.DevicesPatchResponse>

  • Patches the device.

    Parameters

    • deviceName: string

      The device Name.

    • devicePatch: DevicePatch

      Patch representation of the device.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DevicesPatchResponse>

    Promise<Models.DevicesPatchResponse>

scanForUpdates

  • scanForUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Scans for updates on the device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

Generated using TypeDoc