Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Managers

Package version

Class representing a Managers.

Hierarchy

  • Managers

Index

Constructors

Methods

Constructors

constructor

Methods

createExtendedInfo

  • createExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersCreateExtendedInfoResponse>
  • createExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void
  • createExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void

  • Creates the extended info of the manager.

    Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersCreateExtendedInfoResponse>

    Promise<Models.ManagersCreateExtendedInfoResponse>

  • Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

  • Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

createOrUpdate

  • createOrUpdate(parameters: Manager, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersCreateOrUpdateResponse>
  • createOrUpdate(parameters: Manager, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Manager>): void
  • createOrUpdate(parameters: Manager, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Manager>): void

  • Creates or updates the manager.

    Parameters

    • parameters: Manager

      The manager.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersCreateOrUpdateResponse>

    Promise<Models.ManagersCreateOrUpdateResponse>

  • Parameters

    • parameters: Manager

      The manager.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

  • Parameters

    • parameters: Manager

      The manager.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

deleteExtendedInfo

  • deleteExtendedInfo(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteExtendedInfo(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<void>): void
  • deleteExtendedInfo(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes the extended info of the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteMethod

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

  • Deletes the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetResponse>
  • get(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Manager>): void
  • get(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Manager>): void

  • Returns the properties of the specified manager name.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetResponse>

    Promise<Models.ManagersGetResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

getActivationKey

  • getActivationKey(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetActivationKeyResponse>
  • getActivationKey(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Key>): void
  • getActivationKey(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Key>): void

  • Returns the activation key of the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetActivationKeyResponse>

    Promise<Models.ManagersGetActivationKeyResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Key>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Key>

      The callback

    Returns void

getDevicePublicEncryptionKey

  • getDevicePublicEncryptionKey(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetDevicePublicEncryptionKeyResponse>
  • getDevicePublicEncryptionKey(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<PublicKey>): void
  • getDevicePublicEncryptionKey(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PublicKey>): void

  • Returns the public encryption key of 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<Models.ManagersGetDevicePublicEncryptionKeyResponse>

    Promise<Models.ManagersGetDevicePublicEncryptionKeyResponse>

  • Parameters

    • deviceName: string

      The device name

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<PublicKey>

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

      The callback

    Returns void

getEncryptionSettings

  • getEncryptionSettings(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetEncryptionSettingsResponse>
  • getEncryptionSettings(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<EncryptionSettings>): void
  • getEncryptionSettings(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EncryptionSettings>): void

  • Returns the encryption settings of the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetEncryptionSettingsResponse>

    Promise<Models.ManagersGetEncryptionSettingsResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<EncryptionSettings>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<EncryptionSettings>

      The callback

    Returns void

getExtendedInfo

  • getExtendedInfo(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetExtendedInfoResponse>
  • getExtendedInfo(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void
  • getExtendedInfo(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void

  • Returns the extended information of the specified manager name.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetExtendedInfoResponse>

    Promise<Models.ManagersGetExtendedInfoResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

getPublicEncryptionKey

  • getPublicEncryptionKey(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersGetPublicEncryptionKeyResponse>
  • getPublicEncryptionKey(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<SymmetricEncryptedSecret>): void
  • getPublicEncryptionKey(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SymmetricEncryptedSecret>): void

  • Returns the symmetric encrypted public encryption key of the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetPublicEncryptionKeyResponse>

    Promise<Models.ManagersGetPublicEncryptionKeyResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<SymmetricEncryptedSecret>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SymmetricEncryptedSecret>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.ManagersListResponse>
  • list(callback: msRest.ServiceCallback<ManagerList>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerList>): void

  • Retrieves all the managers in a subscription.

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersListResponse>

    Promise<Models.ManagersListResponse>

  • Parameters

    • callback: msRest.ServiceCallback<ManagerList>

      The callback

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ManagerList>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ManagerList>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerList>): void

  • Retrieves all the managers in a resource group.

    Parameters

    • resourceGroupName: string

      The resource group name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersListByResourceGroupResponse>

    Promise<Models.ManagersListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • callback: msRest.ServiceCallback<ManagerList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ManagerList>

      The callback

    Returns void

listFeatureSupportStatus

  • listFeatureSupportStatus(resourceGroupName: string, managerName: string, options?: Models.ManagersListFeatureSupportStatusOptionalParams): Promise<Models.ManagersListFeatureSupportStatusResponse>
  • listFeatureSupportStatus(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FeatureList>): void
  • listFeatureSupportStatus(resourceGroupName: string, managerName: string, options: ManagersListFeatureSupportStatusOptionalParams, callback: msRest.ServiceCallback<FeatureList>): void

  • Lists the features and their support status

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.ManagersListFeatureSupportStatusOptionalParams

    Returns Promise<Models.ManagersListFeatureSupportStatusResponse>

    Promise<Models.ManagersListFeatureSupportStatusResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FeatureList>

      The callback

    Returns void

  • Parameters

    Returns void

listMetricDefinition

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

  • Gets the metric definitions for the specified manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersListMetricDefinitionResponse>

    Promise<Models.ManagersListMetricDefinitionResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricDefinitionList>

      The callback

    Returns void

  • Parameters

    • 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(resourceGroupName: string, managerName: string, filter: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersListMetricsResponse>
  • listMetrics(resourceGroupName: string, managerName: string, filter: string, callback: msRest.ServiceCallback<MetricList>): void
  • listMetrics(resourceGroupName: string, managerName: string, filter: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MetricList>): void

  • Gets the metrics for the specified manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • filter: string

      OData Filter options

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersListMetricsResponse>

    Promise<Models.ManagersListMetricsResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • filter: string

      OData Filter options

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • filter: string

      OData Filter options

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

regenerateActivationKey

  • regenerateActivationKey(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersRegenerateActivationKeyResponse>
  • regenerateActivationKey(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Key>): void
  • regenerateActivationKey(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Key>): void

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

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersRegenerateActivationKeyResponse>

    Promise<Models.ManagersRegenerateActivationKeyResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Key>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Key>

      The callback

    Returns void

update

  • update(parameters: ManagerPatch, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersUpdateResponse>
  • update(parameters: ManagerPatch, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Manager>): void
  • update(parameters: ManagerPatch, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Manager>): void

  • Updates the StorSimple Manager.

    Parameters

    • parameters: ManagerPatch

      The manager update parameters.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersUpdateResponse>

    Promise<Models.ManagersUpdateResponse>

  • Parameters

    • parameters: ManagerPatch

      The manager update parameters.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

  • Parameters

    • parameters: ManagerPatch

      The manager update parameters.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

updateExtendedInfo

  • updateExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersUpdateExtendedInfoResponse>
  • updateExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void
  • updateExtendedInfo(parameters: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void

  • Updates the extended info of the manager.

    Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • ifMatch: string

      Pass the ETag of ExtendedInfo fetched from GET call

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersUpdateExtendedInfoResponse>

    Promise<Models.ManagersUpdateExtendedInfoResponse>

  • Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • ifMatch: string

      Pass the ETag of ExtendedInfo fetched from GET call

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

  • Parameters

    • parameters: ManagerExtendedInfo

      The manager extended information.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • ifMatch: string

      Pass the ETag of ExtendedInfo fetched from GET call

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ManagerExtendedInfo>

      The callback

    Returns void

Generated using TypeDoc