FileServers class

Class representing a FileServers.

Constructors

FileServers(BatchAIManagementClientContext)

Create a FileServers.

Methods

beginCreate(string, string, string, FileServerCreateParameters, RequestOptionsBase)

Creates a File Server in the given workspace.

beginDeleteMethod(string, string, string, RequestOptionsBase)

Deletes a File Server.

create(string, string, string, FileServerCreateParameters, RequestOptionsBase)

Creates a File Server in the given workspace.

deleteMethod(string, string, string, RequestOptionsBase)

Deletes a File Server.

get(string, string, string, RequestOptionsBase)

Gets information about a File Server.

get(string, string, string, RequestOptionsBase, ServiceCallback<FileServer>)
get(string, string, string, ServiceCallback<FileServer>)
listByWorkspace(string, string, FileServersListByWorkspaceOptionalParams)

Gets a list of File Servers associated with the specified workspace.

listByWorkspace(string, string, FileServersListByWorkspaceOptionalParams, ServiceCallback<FileServerListResult>)
listByWorkspace(string, string, ServiceCallback<FileServerListResult>)
listByWorkspaceNext(string, RequestOptionsBase)

Gets a list of File Servers associated with the specified workspace.

listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<FileServerListResult>)
listByWorkspaceNext(string, ServiceCallback<FileServerListResult>)

Constructor Details

FileServers(BatchAIManagementClientContext)

Create a FileServers.

new FileServers(client: BatchAIManagementClientContext)

Parameters

client
BatchAIManagementClientContext

Reference to the service client.

Method Details

beginCreate(string, string, string, FileServerCreateParameters, RequestOptionsBase)

Creates a File Server in the given workspace.

function beginCreate(resourceGroupName: string, workspaceName: string, fileServerName: string, parameters: FileServerCreateParameters, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters
FileServerCreateParameters

The parameters to provide for File Server creation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod(string, string, string, RequestOptionsBase)

Deletes a File Server.

function beginDeleteMethod(resourceGroupName: string, workspaceName: string, fileServerName: string, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

create(string, string, string, FileServerCreateParameters, RequestOptionsBase)

Creates a File Server in the given workspace.

function create(resourceGroupName: string, workspaceName: string, fileServerName: string, parameters: FileServerCreateParameters, options?: RequestOptionsBase): Promise<FileServersCreateResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters
FileServerCreateParameters

The parameters to provide for File Server creation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.FileServersCreateResponse>

deleteMethod(string, string, string, RequestOptionsBase)

Deletes a File Server.

function deleteMethod(resourceGroupName: string, workspaceName: string, fileServerName: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

get(string, string, string, RequestOptionsBase)

Gets information about a File Server.

function get(resourceGroupName: string, workspaceName: string, fileServerName: string, options?: RequestOptionsBase): Promise<FileServersGetResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.FileServersGetResponse>

get(string, string, string, RequestOptionsBase, ServiceCallback<FileServer>)

function get(resourceGroupName: string, workspaceName: string, fileServerName: string, options: RequestOptionsBase, callback: ServiceCallback<FileServer>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<FileServer>

The callback

get(string, string, string, ServiceCallback<FileServer>)

function get(resourceGroupName: string, workspaceName: string, fileServerName: string, callback: ServiceCallback<FileServer>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

fileServerName

string

The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

callback

ServiceCallback<FileServer>

The callback

listByWorkspace(string, string, FileServersListByWorkspaceOptionalParams)

Gets a list of File Servers associated with the specified workspace.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: FileServersListByWorkspaceOptionalParams): Promise<FileServersListByWorkspaceResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
FileServersListByWorkspaceOptionalParams

The optional parameters

Returns

Promise<Models.FileServersListByWorkspaceResponse>

listByWorkspace(string, string, FileServersListByWorkspaceOptionalParams, ServiceCallback<FileServerListResult>)

function listByWorkspace(resourceGroupName: string, workspaceName: string, options: FileServersListByWorkspaceOptionalParams, callback: ServiceCallback<FileServerListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
FileServersListByWorkspaceOptionalParams

The optional parameters

callback

ServiceCallback<FileServerListResult>

The callback

listByWorkspace(string, string, ServiceCallback<FileServerListResult>)

function listByWorkspace(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<FileServerListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

callback

ServiceCallback<FileServerListResult>

The callback

listByWorkspaceNext(string, RequestOptionsBase)

Gets a list of File Servers associated with the specified workspace.

function listByWorkspaceNext(nextPageLink: string, options?: RequestOptionsBase): Promise<FileServersListByWorkspaceNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.FileServersListByWorkspaceNextResponse>

listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<FileServerListResult>)

function listByWorkspaceNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<FileServerListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<FileServerListResult>

The callback

listByWorkspaceNext(string, ServiceCallback<FileServerListResult>)

function listByWorkspaceNext(nextPageLink: string, callback: ServiceCallback<FileServerListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<FileServerListResult>

The callback