FileServers interface

Interface representing a FileServers.

Methods

beginBackupNow(string, string, string, string, FileServersBackupNowOptionalParams)

Backup the file server now.

beginBackupNowAndWait(string, string, string, string, FileServersBackupNowOptionalParams)

Backup the file server now.

beginCreateOrUpdate(string, string, string, string, FileServer, FileServersCreateOrUpdateOptionalParams)

Creates or updates the file server.

beginCreateOrUpdateAndWait(string, string, string, string, FileServer, FileServersCreateOrUpdateOptionalParams)

Creates or updates the file server.

beginDelete(string, string, string, string, FileServersDeleteOptionalParams)

Deletes the file server.

beginDeleteAndWait(string, string, string, string, FileServersDeleteOptionalParams)

Deletes the file server.

get(string, string, string, string, FileServersGetOptionalParams)

Returns the properties of the specified file server name.

listByDevice(string, string, string, FileServersListByDeviceOptionalParams)

Retrieves all the file servers in a device.

listByManager(string, string, FileServersListByManagerOptionalParams)

Retrieves all the file servers in a manager.

listMetricDefinition(string, string, string, string, FileServersListMetricDefinitionOptionalParams)

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

listMetrics(string, string, string, string, FileServersListMetricsOptionalParams)

Gets the file server metrics.

Method Details

beginBackupNow(string, string, string, string, FileServersBackupNowOptionalParams)

Backup the file server now.

function beginBackupNow(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersBackupNowOptionalParams): Promise<PollerLike<PollOperationState<void>, 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
FileServersBackupNowOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginBackupNowAndWait(string, string, string, string, FileServersBackupNowOptionalParams)

Backup the file server now.

function beginBackupNowAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersBackupNowOptionalParams): Promise<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
FileServersBackupNowOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, string, string, FileServer, FileServersCreateOrUpdateOptionalParams)

Creates or updates the file server.

function beginCreateOrUpdate(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, fileServer: FileServer, options?: FileServersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<FileServer>, FileServer>>

Parameters

deviceName

string

The device name.

fileServerName

string

The file server name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

fileServer
FileServer

The file server.

options
FileServersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<FileServer>, FileServer>>

beginCreateOrUpdateAndWait(string, string, string, string, FileServer, FileServersCreateOrUpdateOptionalParams)

Creates or updates the file server.

function beginCreateOrUpdateAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, fileServer: FileServer, options?: FileServersCreateOrUpdateOptionalParams): Promise<FileServer>

Parameters

deviceName

string

The device name.

fileServerName

string

The file server name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

fileServer
FileServer

The file server.

options
FileServersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FileServer>

beginDelete(string, string, string, string, FileServersDeleteOptionalParams)

Deletes the file server.

function beginDelete(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, 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
FileServersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, FileServersDeleteOptionalParams)

Deletes the file server.

function beginDeleteAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersDeleteOptionalParams): Promise<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
FileServersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, FileServersGetOptionalParams)

Returns the properties of the specified file server name.

function get(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersGetOptionalParams): Promise<FileServer>

Parameters

deviceName

string

The device name.

fileServerName

string

The file server name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
FileServersGetOptionalParams

The options parameters.

Returns

Promise<FileServer>

listByDevice(string, string, string, FileServersListByDeviceOptionalParams)

Retrieves all the file servers in a device.

function listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: FileServersListByDeviceOptionalParams): PagedAsyncIterableIterator<FileServer, FileServer[], PageSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
FileServersListByDeviceOptionalParams

The options parameters.

Returns

listByManager(string, string, FileServersListByManagerOptionalParams)

Retrieves all the file servers in a manager.

function listByManager(resourceGroupName: string, managerName: string, options?: FileServersListByManagerOptionalParams): PagedAsyncIterableIterator<FileServer, FileServer[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
FileServersListByManagerOptionalParams

The options parameters.

Returns

listMetricDefinition(string, string, string, string, FileServersListMetricDefinitionOptionalParams)

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

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

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
FileServersListMetricDefinitionOptionalParams

The options parameters.

Returns

listMetrics(string, string, string, string, FileServersListMetricsOptionalParams)

Gets the file server metrics.

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

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 options parameters.

Returns