Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileServers

Package version

Class representing a FileServers.

Hierarchy

  • FileServers

Index

Constructors

Methods

Constructors

constructor

Methods

backupNow

  • backupNow(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Backup the file server now.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

beginBackupNow

  • beginBackupNow(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Backup the file server now.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, fileServerName: string, fileServer: FileServer, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates or updates the file server.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • fileServer: FileServer

      The file server.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes the file server.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(deviceName: string, fileServerName: string, fileServer: FileServer, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileServersCreateOrUpdateResponse>

  • Creates or updates the file server.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • fileServer: FileServer

      The file server.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersCreateOrUpdateResponse>

    Promise<Models.FileServersCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes the file server.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileServersGetResponse>
  • get(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileServer>): void
  • get(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileServer>): void

  • Returns the properties of the specified file server name.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersGetResponse>

    Promise<Models.FileServersGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FileServer>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileServer>

      The callback

    Returns void

listByDevice

  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileServersListByDeviceResponse>
  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileServerList>): void
  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileServerList>): void

  • Retrieves all the file servers in a 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.FileServersListByDeviceResponse>

    Promise<Models.FileServersListByDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FileServerList>

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

      The callback

    Returns void

listByManager

  • listByManager(resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileServersListByManagerResponse>
  • listByManager(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileServerList>): void
  • listByManager(resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileServerList>): void

  • Retrieves all the file servers in a manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersListByManagerResponse>

    Promise<Models.FileServersListByManagerResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FileServerList>

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

      The callback

    Returns void

listMetricDefinition

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

  • Retrieves metric definitions of all metrics aggregated at the file server.

    Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersListMetricDefinitionResponse>

    Promise<Models.FileServersListMetricDefinitionResponse>

  • Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricDefinitionList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server.

    • 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(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: Models.FileServersListMetricsOptionalParams): Promise<Models.FileServersListMetricsResponse>
  • listMetrics(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricList>): void
  • listMetrics(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options: FileServersListMetricsOptionalParams, callback: msRest.ServiceCallback<MetricList>): void

  • Gets the file server metrics.

    Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.FileServersListMetricsOptionalParams

    Returns Promise<Models.FileServersListMetricsResponse>

    Promise<Models.FileServersListMetricsResponse>

  • Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The name of the device.

    • fileServerName: string

      The name of the file server name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: FileServersListMetricsOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

Generated using TypeDoc