Managers interface

Package:

@azure/arm-storsimple8000series

Interface representing a Managers.

Methods

createExtendedInfo(string, string, ManagerExtendedInfo, ManagersCreateExtendedInfoOptionalParams)	Creates the extended info of the manager.
createOrUpdate(string, string, Manager, ManagersCreateOrUpdateOptionalParams)	Creates or updates the manager.
delete(string, string, ManagersDeleteOptionalParams)	Deletes the manager.
deleteExtendedInfo(string, string, ManagersDeleteExtendedInfoOptionalParams)	Deletes the extended info of the manager.
get(string, string, ManagersGetOptionalParams)	Returns the properties of the specified manager name.
getActivationKey(string, string, ManagersGetActivationKeyOptionalParams)	Returns the activation key of the manager.
getDevicePublicEncryptionKey(string, string, string, ManagersGetDevicePublicEncryptionKeyOptionalParams)	Returns the public encryption key of the device.
getEncryptionSettings(string, string, ManagersGetEncryptionSettingsOptionalParams)	Returns the encryption settings of the manager.
getExtendedInfo(string, string, ManagersGetExtendedInfoOptionalParams)	Returns the extended information of the specified manager name.
getPublicEncryptionKey(string, string, ManagersGetPublicEncryptionKeyOptionalParams)	Returns the symmetric encrypted public encryption key of the manager.
list(ManagersListOptionalParams)	Retrieves all the managers in a subscription.
listByResourceGroup(string, ManagersListByResourceGroupOptionalParams)	Retrieves all the managers in a resource group.
listFeatureSupportStatus(string, string, ManagersListFeatureSupportStatusOptionalParams)	Lists the features and their support status
listMetricDefinition(string, string, ManagersListMetricDefinitionOptionalParams)	Gets the metric definitions for the specified manager.
listMetrics(string, string, string, ManagersListMetricsOptionalParams)	Gets the metrics for the specified manager.
regenerateActivationKey(string, string, ManagersRegenerateActivationKeyOptionalParams)	Re-generates and returns the activation key of the manager.
update(string, string, ManagerPatch, ManagersUpdateOptionalParams)	Updates the StorSimple Manager.
updateExtendedInfo(string, string, string, ManagerExtendedInfo, ManagersUpdateExtendedInfoOptionalParams)	Updates the extended info of the manager.

Method Details

createExtendedInfo(string, string, ManagerExtendedInfo, ManagersCreateExtendedInfoOptionalParams)

Creates the extended info of the manager.

function createExtendedInfo(resourceGroupName: string, managerName: string, parameters: ManagerExtendedInfo, options?: ManagersCreateExtendedInfoOptionalParams): Promise<ManagerExtendedInfo>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters

ManagerExtendedInfo

The manager extended information.

options

ManagersCreateExtendedInfoOptionalParams

The options parameters.

Returns

Promise<ManagerExtendedInfo>

createOrUpdate(string, string, Manager, ManagersCreateOrUpdateOptionalParams)

Creates or updates the manager.

function createOrUpdate(resourceGroupName: string, managerName: string, parameters: Manager, options?: ManagersCreateOrUpdateOptionalParams): Promise<Manager>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters

Manager

The manager.

options

ManagersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Manager>

delete(string, string, ManagersDeleteOptionalParams)

Deletes the manager.

function delete(resourceGroupName: string, managerName: string, options?: ManagersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteExtendedInfo(string, string, ManagersDeleteExtendedInfoOptionalParams)

Deletes the extended info of the manager.

function deleteExtendedInfo(resourceGroupName: string, managerName: string, options?: ManagersDeleteExtendedInfoOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersDeleteExtendedInfoOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ManagersGetOptionalParams)

Returns the properties of the specified manager name.

function get(resourceGroupName: string, managerName: string, options?: ManagersGetOptionalParams): Promise<Manager>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetOptionalParams

The options parameters.

Returns

Promise<Manager>

getActivationKey(string, string, ManagersGetActivationKeyOptionalParams)

Returns the activation key of the manager.

function getActivationKey(resourceGroupName: string, managerName: string, options?: ManagersGetActivationKeyOptionalParams): Promise<Key>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetActivationKeyOptionalParams

The options parameters.

Returns

Promise<Key>

getDevicePublicEncryptionKey(string, string, string, ManagersGetDevicePublicEncryptionKeyOptionalParams)

Returns the public encryption key of the device.

function getDevicePublicEncryptionKey(deviceName: string, resourceGroupName: string, managerName: string, options?: ManagersGetDevicePublicEncryptionKeyOptionalParams): Promise<PublicKey>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetDevicePublicEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<PublicKey>

getEncryptionSettings(string, string, ManagersGetEncryptionSettingsOptionalParams)

Returns the encryption settings of the manager.

function getEncryptionSettings(resourceGroupName: string, managerName: string, options?: ManagersGetEncryptionSettingsOptionalParams): Promise<EncryptionSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetEncryptionSettingsOptionalParams

The options parameters.

Returns

Promise<EncryptionSettings>

getExtendedInfo(string, string, ManagersGetExtendedInfoOptionalParams)

Returns the extended information of the specified manager name.

function getExtendedInfo(resourceGroupName: string, managerName: string, options?: ManagersGetExtendedInfoOptionalParams): Promise<ManagerExtendedInfo>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetExtendedInfoOptionalParams

The options parameters.

Returns

Promise<ManagerExtendedInfo>

getPublicEncryptionKey(string, string, ManagersGetPublicEncryptionKeyOptionalParams)

Returns the symmetric encrypted public encryption key of the manager.

function getPublicEncryptionKey(resourceGroupName: string, managerName: string, options?: ManagersGetPublicEncryptionKeyOptionalParams): Promise<SymmetricEncryptedSecret>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersGetPublicEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<SymmetricEncryptedSecret>

list(ManagersListOptionalParams)

Retrieves all the managers in a subscription.

function list(options?: ManagersListOptionalParams): PagedAsyncIterableIterator<Manager, Manager[], PageSettings>

Parameters

options

ManagersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Manager, Manager[], PageSettings>

listByResourceGroup(string, ManagersListByResourceGroupOptionalParams)

Retrieves all the managers in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ManagersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Manager, Manager[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

options

ManagersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Manager, Manager[], PageSettings>

listFeatureSupportStatus(string, string, ManagersListFeatureSupportStatusOptionalParams)

Lists the features and their support status

function listFeatureSupportStatus(resourceGroupName: string, managerName: string, options?: ManagersListFeatureSupportStatusOptionalParams): PagedAsyncIterableIterator<Feature, Feature[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersListFeatureSupportStatusOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Feature, Feature[], PageSettings>

listMetricDefinition(string, string, ManagersListMetricDefinitionOptionalParams)

Gets the metric definitions for the specified manager.

function listMetricDefinition(resourceGroupName: string, managerName: string, options?: ManagersListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersListMetricDefinitionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

listMetrics(string, string, string, ManagersListMetricsOptionalParams)

Gets the metrics for the specified manager.

function listMetrics(resourceGroupName: string, managerName: string, filter: string, options?: ManagersListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

filter

string

OData Filter options

options

ManagersListMetricsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>

regenerateActivationKey(string, string, ManagersRegenerateActivationKeyOptionalParams)

Re-generates and returns the activation key of the manager.

function regenerateActivationKey(resourceGroupName: string, managerName: string, options?: ManagersRegenerateActivationKeyOptionalParams): Promise<Key>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options

ManagersRegenerateActivationKeyOptionalParams

The options parameters.

Returns

Promise<Key>

update(string, string, ManagerPatch, ManagersUpdateOptionalParams)

Updates the StorSimple Manager.

function update(resourceGroupName: string, managerName: string, parameters: ManagerPatch, options?: ManagersUpdateOptionalParams): Promise<Manager>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters

ManagerPatch

The manager update parameters.

options

ManagersUpdateOptionalParams

The options parameters.

Returns

Promise<Manager>

updateExtendedInfo(string, string, string, ManagerExtendedInfo, ManagersUpdateExtendedInfoOptionalParams)

Updates the extended info of the manager.

function updateExtendedInfo(resourceGroupName: string, managerName: string, ifMatch: string, parameters: ManagerExtendedInfo, options?: ManagersUpdateExtendedInfoOptionalParams): Promise<ManagerExtendedInfo>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

ifMatch

string

Pass the ETag of ExtendedInfo fetched from GET call

parameters

ManagerExtendedInfo

The manager extended information.

options

ManagersUpdateExtendedInfoOptionalParams

The options parameters.

Returns

Promise<ManagerExtendedInfo>