Managers interface

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.

getEncryptionKey(string, string, ManagersGetEncryptionKeyOptionalParams)

Returns the symmetric encryption key of the manager.

getEncryptionSettings(string, string, ManagersGetEncryptionSettingsOptionalParams)

Returns the encryption settings of the manager.

getExtendedInfo(string, string, ManagersGetExtendedInfoOptionalParams)

Returns the extended information of the specified manager name.

list(ManagersListOptionalParams)

Retrieves all the managers in a subscription.

listByResourceGroup(string, ManagersListByResourceGroupOptionalParams)

Retrieves all the managers in a resource group.

listMetricDefinition(string, string, ManagersListMetricDefinitionOptionalParams)

Retrieves metric definition of all metrics aggregated at manager.

listMetrics(string, string, ManagersListMetricsOptionalParams)

Gets the manager metrics

update(string, string, ManagerPatch, ManagersUpdateOptionalParams)

Updates the StorSimple Manager.

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

Updates the extended info of the manager.

uploadRegistrationCertificate(string, string, string, UploadCertificateRequest, ManagersUploadRegistrationCertificateOptionalParams)

Upload Vault Cred Certificate. Returns UploadCertificateResponse

Method Details

createExtendedInfo(string, string, ManagerExtendedInfo, ManagersCreateExtendedInfoOptionalParams)

Creates the extended info of the manager.

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

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

managerExtendedInfo
ManagerExtendedInfo

The manager extended information.

options
ManagersCreateExtendedInfoOptionalParams

The options parameters.

Returns

createOrUpdate(string, string, Manager, ManagersCreateOrUpdateOptionalParams)

Creates or updates the manager.

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

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

manager
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>

getEncryptionKey(string, string, ManagersGetEncryptionKeyOptionalParams)

Returns the symmetric encryption key of the manager.

function getEncryptionKey(resourceGroupName: string, managerName: string, options?: ManagersGetEncryptionKeyOptionalParams): Promise<SymmetricEncryptedSecret>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
ManagersGetEncryptionKeyOptionalParams

The options parameters.

Returns

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

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

list(ManagersListOptionalParams)

Retrieves all the managers in a subscription.

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

Parameters

options
ManagersListOptionalParams

The options parameters.

Returns

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

listMetricDefinition(string, string, ManagersListMetricDefinitionOptionalParams)

Retrieves metric definition of all metrics aggregated at 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

listMetrics(string, string, ManagersListMetricsOptionalParams)

Gets the manager metrics

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

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
ManagersListMetricsOptionalParams

The options parameters.

Returns

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, managerExtendedInfo: 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

managerExtendedInfo
ManagerExtendedInfo

The manager extended information.

options
ManagersUpdateExtendedInfoOptionalParams

The options parameters.

Returns

uploadRegistrationCertificate(string, string, string, UploadCertificateRequest, ManagersUploadRegistrationCertificateOptionalParams)

Upload Vault Cred Certificate. Returns UploadCertificateResponse

function uploadRegistrationCertificate(certificateName: string, resourceGroupName: string, managerName: string, uploadCertificateRequestrequest: UploadCertificateRequest, options?: ManagersUploadRegistrationCertificateOptionalParams): Promise<UploadCertificateResponse>

Parameters

certificateName

string

Certificate Name

resourceGroupName

string

The resource group name

managerName

string

The manager name

uploadCertificateRequestrequest
UploadCertificateRequest

UploadCertificateRequest Request

options
ManagersUploadRegistrationCertificateOptionalParams

The options parameters.

Returns