Package version:

Interface Devices

Interface representing a Devices.

Hierarchy

Devices

Methods

authorizeForServiceEncryptionKeyRollover

authorizeForServiceEncryptionKeyRollover(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams): Promise<void>
Authorizes the specified device for service data encryption key rollover.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:202

beginConfigure

beginConfigure(resourceGroupName: string, managerName: string, parameters: ConfigureDeviceRequest, options?: DevicesConfigureOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Complete minimal setup before using the device.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: ConfigureDeviceRequest
  
  The minimal properties to configure a device.
- Optional options: DevicesConfigureOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:122

beginConfigureAndWait

beginConfigureAndWait(resourceGroupName: string, managerName: string, parameters: ConfigureDeviceRequest, options?: DevicesConfigureOptionalParams): Promise<void>
Complete minimal setup before using the device.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: ConfigureDeviceRequest
  
  The minimal properties to configure a device.
- Optional options: DevicesConfigureOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:135

beginDeactivate

beginDeactivate(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeactivateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deactivates the device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesDeactivateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:215

beginDeactivateAndWait

beginDeactivateAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeactivateOptionalParams): Promise<void>
Deactivates the device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesDeactivateOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:228

beginDelete

beginDelete(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes the device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:161

beginDeleteAndWait

beginDeleteAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesDeleteOptionalParams): Promise<void>
Deletes the device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:174

beginFailover

beginFailover(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Failovers a set of volume containers from a specified source device to a target device.
Parameters
- sourceDeviceName: string
  
  The source device name on which failover is performed.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: FailoverRequest
  
  FailoverRequest containing the source device and the list of volume containers to be failed over.
- Optional options: DevicesFailoverOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:308

beginFailoverAndWait

beginFailoverAndWait(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<void>
Failovers a set of volume containers from a specified source device to a target device.
Parameters
- sourceDeviceName: string
  
  The source device name on which failover is performed.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: FailoverRequest
  
  FailoverRequest containing the source device and the list of volume containers to be failed over.
- Optional options: DevicesFailoverOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:324

beginInstallUpdates

beginInstallUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Downloads and 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: DevicesInstallUpdatesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:241

beginInstallUpdatesAndWait

beginInstallUpdatesAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesInstallUpdatesOptionalParams): Promise<void>
Downloads and 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: DevicesInstallUpdatesOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:254

beginScanForUpdates

beginScanForUpdates(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: DevicesScanForUpdatesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/devices.ts:267

beginScanForUpdatesAndWait

beginScanForUpdatesAndWait(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesScanForUpdatesOptionalParams): Promise<void>
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: DevicesScanForUpdatesOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/devices.ts:280

get

get(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetOptionalParams): Promise<Device>
Returns the properties of the specified device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesGetOptionalParams
  
  The options parameters.
Returns Promise<Device>
- Defined in operationsInterfaces/devices.ts:148

getUpdateSummary

getUpdateSummary(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesGetUpdateSummaryOptionalParams): Promise<Updates>
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: DevicesGetUpdateSummaryOptionalParams
  
  The options parameters.
Returns Promise<Updates>
- Defined in operationsInterfaces/devices.ts:293

listByManager

listByManager(resourceGroupName: string, managerName: string, options?: DevicesListByManagerOptionalParams): PagedAsyncIterableIterator<Device>
Returns the list of devices for the specified manager.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesListByManagerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Device>
- Defined in operationsInterfaces/devices.ts:50

listFailoverSets

listFailoverSets(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListFailoverSetsOptionalParams): PagedAsyncIterableIterator<FailoverSet>
Returns all failover sets for a given device and their eligibility for participating in a failover. A failover set refers to a set of volume containers that need to be failed-over as a single unit to maintain data integrity.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesListFailoverSetsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FailoverSet>
- Defined in operationsInterfaces/devices.ts:64

listFailoverTargets

listFailoverTargets(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: ListFailoverTargetsRequest, options?: DevicesListFailoverTargetsOptionalParams): PagedAsyncIterableIterator<FailoverTarget>
Given a list of volume containers to be failed over from a source device, this method returns the eligibility result, as a failover target, for all devices under that resource.
Parameters
- sourceDeviceName: string
  
  The source device name on which failover is performed.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: ListFailoverTargetsRequest
  
  ListFailoverTargetsRequest containing the list of volume containers to be failed over.
- Optional options: DevicesListFailoverTargetsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FailoverTarget>
- Defined in operationsInterfaces/devices.ts:108

listMetricDefinition

listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition>
Gets the metric definitions for the specified device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: DevicesListMetricDefinitionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>
- Defined in operationsInterfaces/devices.ts:92

listMetrics

listMetrics(deviceName: string, resourceGroupName: string, managerName: string, filter: string, options?: DevicesListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics>
Gets the metrics for the specified device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- filter: string
  
  OData Filter options
- Optional options: DevicesListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metrics>
- Defined in operationsInterfaces/devices.ts:78

update

update(deviceName: string, resourceGroupName: string, managerName: string, parameters: DevicePatch, options?: DevicesUpdateOptionalParams): Promise<Device>
Patches the device.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: DevicePatch
  
  Patch representation of the device.
- Optional options: DevicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<Device>
- Defined in operationsInterfaces/devices.ts:188

Interface Devices

Hierarchy

Index

Methods

Methods

authorizeForServiceEncryptionKeyRollover

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams

Returns Promise<void>

beginConfigure

Parameters

resourceGroupName: string

managerName: string

parameters: ConfigureDeviceRequest

Optional options: DevicesConfigureOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginConfigureAndWait

Parameters

resourceGroupName: string

managerName: string

parameters: ConfigureDeviceRequest

Optional options: DevicesConfigureOptionalParams

Returns Promise<void>

beginDeactivate

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesDeactivateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeactivateAndWait

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesDeactivateOptionalParams

Returns Promise<void>

beginDelete

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesDeleteOptionalParams

Returns Promise<void>

beginFailover

Parameters

sourceDeviceName: string

resourceGroupName: string

managerName: string

parameters: FailoverRequest

Optional options: DevicesFailoverOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginFailoverAndWait

Parameters

sourceDeviceName: string

resourceGroupName: string

managerName: string

parameters: FailoverRequest

Optional options: DevicesFailoverOptionalParams

Returns Promise<void>

beginInstallUpdates

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: DevicesInstallUpdatesOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginInstallUpdatesAndWait

Parameters

deviceName: string

`Optional` options: DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams

`Optional` options: DevicesConfigureOptionalParams

`Optional` options: DevicesConfigureOptionalParams

`Optional` options: DevicesDeactivateOptionalParams

`Optional` options: DevicesDeactivateOptionalParams

`Optional` options: DevicesDeleteOptionalParams

`Optional` options: DevicesDeleteOptionalParams

`Optional` options: DevicesFailoverOptionalParams

`Optional` options: DevicesFailoverOptionalParams

`Optional` options: DevicesInstallUpdatesOptionalParams

`Optional` options: DevicesInstallUpdatesOptionalParams

`Optional` options: DevicesScanForUpdatesOptionalParams

`Optional` options: DevicesScanForUpdatesOptionalParams

`Optional` options: DevicesGetOptionalParams

`Optional` options: DevicesGetUpdateSummaryOptionalParams

`Optional` options: DevicesListByManagerOptionalParams

`Optional` options: DevicesListFailoverSetsOptionalParams

`Optional` options: DevicesListFailoverTargetsOptionalParams

`Optional` options: DevicesListMetricDefinitionOptionalParams

`Optional` options: DevicesListMetricsOptionalParams