Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileServers

Package version

Class representing a FileServers.

Hierarchy

  • FileServers

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreate

  • beginCreate(resourceGroupName: string, workspaceName: string, fileServerName: string, parameters: FileServerCreateParameters, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates a File Server in the given workspace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

  • Deletes a File Server.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

create

  • create(resourceGroupName: string, workspaceName: string, fileServerName: string, parameters: FileServerCreateParameters, options?: msRest.RequestOptionsBase): Promise<Models.FileServersCreateResponse>

  • Creates a File Server in the given workspace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersCreateResponse>

    Promise<Models.FileServersCreateResponse>

deleteMethod

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

  • Deletes a File Server.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

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

  • Gets information about a File Server.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersGetResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<FileServer>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileServer>

      The callback

    Returns void

listByWorkspace

  • listByWorkspace(resourceGroupName: string, workspaceName: string, options?: Models.FileServersListByWorkspaceOptionalParams): Promise<Models.FileServersListByWorkspaceResponse>
  • listByWorkspace(resourceGroupName: string, workspaceName: string, callback: msRest.ServiceCallback<FileServerListResult>): void
  • listByWorkspace(resourceGroupName: string, workspaceName: string, options: FileServersListByWorkspaceOptionalParams, callback: msRest.ServiceCallback<FileServerListResult>): void

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

    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.

    • Optional options: Models.FileServersListByWorkspaceOptionalParams

    Returns Promise<Models.FileServersListByWorkspaceResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<FileServerListResult>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<FileServerListResult>

      The callback

    Returns void

listByWorkspaceNext

  • listByWorkspaceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.FileServersListByWorkspaceNextResponse>
  • listByWorkspaceNext(nextPageLink: string, callback: msRest.ServiceCallback<FileServerListResult>): void
  • listByWorkspaceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileServerListResult>): void

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

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileServersListByWorkspaceNextResponse>

    Promise<Models.FileServersListByWorkspaceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<FileServerListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileServerListResult>

      The callback

    Returns void

Generated using TypeDoc