Package version:

Interface FileServers

Interface representing a FileServers.

Hierarchy

FileServers

Index

Methods

beginBackupNow beginBackupNowAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByDevice listByManager listMetricDefinition listMetrics

Methods

beginBackupNow

beginBackupNow(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersBackupNowOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: FileServersBackupNowOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/fileServers.ts:176

beginBackupNowAndWait

beginBackupNowAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersBackupNowOptionalParams): Promise<void>
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: FileServersBackupNowOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/fileServers.ts:191

beginCreateOrUpdate

beginCreateOrUpdate(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, fileServer: FileServer, options?: FileServersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<FileServer>, FileServer>>
Creates or updates 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
- fileServer: FileServer
  
  The file server.
- Optional options: FileServersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<FileServer>, FileServer>>
- Defined in operationsInterfaces/fileServers.ts:108

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, fileServer: FileServer, options?: FileServersCreateOrUpdateOptionalParams): Promise<FileServer>
Creates or updates 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
- fileServer: FileServer
  
  The file server.
- Optional options: FileServersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<FileServer>
- Defined in operationsInterfaces/fileServers.ts:130

beginDelete

beginDelete(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: FileServersDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/fileServers.ts:146

beginDeleteAndWait

beginDeleteAndWait(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersDeleteOptionalParams): Promise<void>
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: FileServersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/fileServers.ts:161

get

get(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersGetOptionalParams): Promise<FileServer>
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: FileServersGetOptionalParams
  
  The options parameters.
Returns Promise<FileServer>
- Defined in operationsInterfaces/fileServers.ts:92

listByDevice

listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: FileServersListByDeviceOptionalParams): PagedAsyncIterableIterator<FileServer>
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: FileServersListByDeviceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FileServer>
- Defined in operationsInterfaces/fileServers.ts:37

listByManager

listByManager(resourceGroupName: string, managerName: string, options?: FileServersListByManagerOptionalParams): PagedAsyncIterableIterator<FileServer>
Retrieves all the file servers in a manager.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: FileServersListByManagerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FileServer>
- Defined in operationsInterfaces/fileServers.ts:79

listMetricDefinition

listMetricDefinition(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition>
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: FileServersListMetricDefinitionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>
- Defined in operationsInterfaces/fileServers.ts:66

listMetrics

listMetrics(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: FileServersListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics>
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: FileServersListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metrics>
- Defined in operationsInterfaces/fileServers.ts:51

Interface FileServers

Hierarchy

Index

Methods

Methods

beginBackupNow

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

Optional options: FileServersBackupNowOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginBackupNowAndWait

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

Optional options: FileServersBackupNowOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

fileServer: FileServer

Optional options: FileServersCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<FileServer>, FileServer>>

beginCreateOrUpdateAndWait

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

fileServer: FileServer

Optional options: FileServersCreateOrUpdateOptionalParams

Returns Promise<FileServer>

beginDelete

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

Optional options: FileServersDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

Optional options: FileServersDeleteOptionalParams

Returns Promise<void>

get

Parameters

deviceName: string

fileServerName: string

resourceGroupName: string

managerName: string

Optional options: FileServersGetOptionalParams

Returns Promise<FileServer>

listByDevice

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: FileServersListByDeviceOptionalParams

Returns PagedAsyncIterableIterator<FileServer>

listByManager

Parameters

resourceGroupName: string

managerName: string

Optional options: FileServersListByManagerOptionalParams

Returns PagedAsyncIterableIterator<FileServer>

listMetricDefinition

Parameters

deviceName: string

fileServerName: string

`Optional` options: FileServersBackupNowOptionalParams

`Optional` options: FileServersBackupNowOptionalParams

`Optional` options: FileServersCreateOrUpdateOptionalParams

`Optional` options: FileServersCreateOrUpdateOptionalParams

`Optional` options: FileServersDeleteOptionalParams

`Optional` options: FileServersDeleteOptionalParams

`Optional` options: FileServersGetOptionalParams

`Optional` options: FileServersListByDeviceOptionalParams

`Optional` options: FileServersListByManagerOptionalParams

`Optional` options: FileServersListMetricDefinitionOptionalParams

`Optional` options: FileServersListMetricsOptionalParams