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(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersCreateExtendedInfoResponse>
  • createExtendedInfo(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void
  • createExtendedInfo(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void

  • Creates the extended info of the manager.

    Parameters

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

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

    • managerExtendedInfo: 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(manager: Manager, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersCreateOrUpdateResponse>
  • createOrUpdate(manager: Manager, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<Manager>): void
  • createOrUpdate(manager: Manager, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Manager>): void

  • Creates or updates the manager.

    Parameters

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

    • manager: Manager

      The manager.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<Manager>

      The callback

    Returns void

  • Parameters

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

getEncryptionKey

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

  • Returns the symmetric encryption key of the manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersGetEncryptionKeyResponse>

    Promise<Models.ManagersGetEncryptionKeyResponse>

  • 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

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

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

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

  • Retrieves metric definition of all metrics aggregated at 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, options?: Models.ManagersListMetricsOptionalParams): Promise<Models.ManagersListMetricsResponse>
  • listMetrics(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricList>): void
  • listMetrics(resourceGroupName: string, managerName: string, options: ManagersListMetricsOptionalParams, callback: msRest.ServiceCallback<MetricList>): void

  • Gets the manager metrics

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.ManagersListMetricsOptionalParams

    Returns Promise<Models.ManagersListMetricsResponse>

    Promise<Models.ManagersListMetricsResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

  • Parameters

    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(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersUpdateExtendedInfoResponse>
  • updateExtendedInfo(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void
  • updateExtendedInfo(managerExtendedInfo: ManagerExtendedInfo, resourceGroupName: string, managerName: string, ifMatch: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ManagerExtendedInfo>): void

  • Updates the extended info of the manager.

    Parameters

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

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

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

uploadRegistrationCertificate

  • uploadRegistrationCertificate(certificateName: string, uploadCertificateRequestrequest: UploadCertificateRequest, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ManagersUploadRegistrationCertificateResponse>
  • uploadRegistrationCertificate(certificateName: string, uploadCertificateRequestrequest: UploadCertificateRequest, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<UploadCertificateResponse>): void
  • uploadRegistrationCertificate(certificateName: string, uploadCertificateRequestrequest: UploadCertificateRequest, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<UploadCertificateResponse>): void

  • Upload Vault Cred Certificate. Returns UploadCertificateResponse

    Parameters

    • certificateName: string

      Certificate Name

    • uploadCertificateRequestrequest: UploadCertificateRequest

      UploadCertificateRequest Request

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ManagersUploadRegistrationCertificateResponse>

    Promise<Models.ManagersUploadRegistrationCertificateResponse>

  • Parameters

    • certificateName: string

      Certificate Name

    • uploadCertificateRequestrequest: UploadCertificateRequest

      UploadCertificateRequest Request

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<UploadCertificateResponse>

      The callback

    Returns void

  • Parameters

    • certificateName: string

      Certificate Name

    • uploadCertificateRequestrequest: UploadCertificateRequest

      UploadCertificateRequest Request

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<UploadCertificateResponse>

      The callback

    Returns void

Generated using TypeDoc