Devices interface
Interface representing a Devices.
Methods
Method Details
authorizeForServiceEncryptionKeyRollover(string, string, string, DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams)
Authorizes the specified device for service data encryption key rollover.
function authorizeForServiceEncryptionKeyRollover(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesAuthorizeForServiceEncryptionKeyRolloverOptionalParams): 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>
beginConfigure(string, string, ConfigureDeviceRequest, DevicesConfigureOptionalParams)
Complete minimal setup before using the device.
function beginConfigure(resourceGroupName: string, managerName: string, parameters: ConfigureDeviceRequest, options?: DevicesConfigureOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- parameters
- ConfigureDeviceRequest
The minimal properties to configure a device.
- options
- DevicesConfigureOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginConfigureAndWait(string, string, ConfigureDeviceRequest, DevicesConfigureOptionalParams)
Complete minimal setup before using the device.
function beginConfigureAndWait(resourceGroupName: string, managerName: string, parameters: ConfigureDeviceRequest, options?: DevicesConfigureOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- parameters
- ConfigureDeviceRequest
The minimal properties to configure a device.
- options
- DevicesConfigureOptionalParams
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>
beginFailover(string, string, string, FailoverRequest, DevicesFailoverOptionalParams)
Failovers a set of volume containers from a specified source device to a target device.
function beginFailover(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- DevicesFailoverOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginFailoverAndWait(string, string, string, FailoverRequest, DevicesFailoverOptionalParams)
Failovers a set of volume containers from a specified source device to a target device.
function beginFailoverAndWait(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: FailoverRequest, options?: DevicesFailoverOptionalParams): Promise<void>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.
- options
- DevicesFailoverOptionalParams
The options parameters.
Returns
Promise<void>
beginInstallUpdates(string, string, string, DevicesInstallUpdatesOptionalParams)
Downloads and 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)
Downloads and 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>
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.
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>
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)
Returns the list of devices for the specified 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
listFailoverSets(string, string, string, DevicesListFailoverSetsOptionalParams)
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.
function listFailoverSets(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListFailoverSetsOptionalParams): PagedAsyncIterableIterator<FailoverSet, FailoverSet[], PageSettings>Parameters
- deviceName
-
string
The device name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listFailoverTargets(string, string, string, ListFailoverTargetsRequest, DevicesListFailoverTargetsOptionalParams)
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.
function listFailoverTargets(sourceDeviceName: string, resourceGroupName: string, managerName: string, parameters: ListFailoverTargetsRequest, options?: DevicesListFailoverTargetsOptionalParams): PagedAsyncIterableIterator<FailoverTarget, FailoverTarget[], PageSettings>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.
The options parameters.
Returns
listMetricDefinition(string, string, string, DevicesListMetricDefinitionOptionalParams)
Gets the metric definitions for the specified device.
function listMetricDefinition(deviceName: string, resourceGroupName: string, managerName: string, options?: DevicesListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>Parameters
- deviceName
-
string
The device name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetrics(string, string, string, string, DevicesListMetricsOptionalParams)
Gets the metrics for the specified device.
function listMetrics(deviceName: string, resourceGroupName: string, managerName: string, filter: string, options?: DevicesListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>Parameters
- deviceName
-
string
The device name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- filter
-
string
OData Filter options
- options
- DevicesListMetricsOptionalParams
The options parameters.
Returns
update(string, string, string, DevicePatch, DevicesUpdateOptionalParams)
Patches the device.
function update(deviceName: string, resourceGroupName: string, managerName: string, parameters: DevicePatch, options?: DevicesUpdateOptionalParams): Promise<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.
- options
- DevicesUpdateOptionalParams
The options parameters.
Returns
Promise<Device>
Azure SDK for JavaScript