Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileShares

Package version

Class representing a FileShares.

Hierarchy

  • FileShares

Index

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, fileServerName: string, shareName: string, fileShare: FileShare, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Creates or updates the file share.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • fileShare: FileShare

      The file share.

    • 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, shareName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Deletes the file share.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share 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, shareName: string, fileShare: FileShare, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileSharesCreateOrUpdateResponse>
  • Creates or updates the file share.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • fileShare: FileShare

      The file share.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileSharesCreateOrUpdateResponse>

    Promise<Models.FileSharesCreateOrUpdateResponse>

deleteMethod

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

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share 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, shareName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileSharesGetResponse>
  • get(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileShare>): void
  • get(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileShare>): void
  • Returns the properties of the specified file share name.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileSharesGetResponse>

    Promise<Models.FileSharesGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FileShare>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileShare>

      The callback

    Returns void

listByDevice

  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileSharesListByDeviceResponse>
  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileShareList>): void
  • listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileShareList>): void
  • Retrieves all the file shares 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.FileSharesListByDeviceResponse>

    Promise<Models.FileSharesListByDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<FileShareList>

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

      The callback

    Returns void

listByFileServer

  • listByFileServer(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileSharesListByFileServerResponse>
  • listByFileServer(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<FileShareList>): void
  • listByFileServer(deviceName: string, fileServerName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileShareList>): void
  • Retrieves all the file shares in a 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<Models.FileSharesListByFileServerResponse>

    Promise<Models.FileSharesListByFileServerResponse>

  • 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<FileShareList>

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

      The callback

    Returns void

listMetricDefinition

  • listMetricDefinition(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<Models.FileSharesListMetricDefinitionResponse>
  • listMetricDefinition(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricDefinitionList>): void
  • listMetricDefinition(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MetricDefinitionList>): void
  • Retrieves metric definitions of all metrics aggregated at the file share.

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.FileSharesListMetricDefinitionResponse>

    Promise<Models.FileSharesListMetricDefinitionResponse>

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricDefinitionList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • 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, shareName: string, resourceGroupName: string, managerName: string, options?: Models.FileSharesListMetricsOptionalParams): Promise<Models.FileSharesListMetricsResponse>
  • listMetrics(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<MetricList>): void
  • listMetrics(deviceName: string, fileServerName: string, shareName: string, resourceGroupName: string, managerName: string, options: FileSharesListMetricsOptionalParams, callback: msRest.ServiceCallback<MetricList>): void
  • Gets the file share metrics

    Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.FileSharesListMetricsOptionalParams

    Returns Promise<Models.FileSharesListMetricsResponse>

    Promise<Models.FileSharesListMetricsResponse>

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • fileServerName: string

      The file server name.

    • shareName: string

      The file share name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: FileSharesListMetricsOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<MetricList>

      The callback

    Returns void

Generated using TypeDoc