Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Shares

Package version

Class representing a Shares.

Hierarchy

  • Shares

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, name: string, share: Share, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • summary

    Creates a new share or updates an existing share on the device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • share: Share

      The share properties.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

  • Deletes the share on the data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginRefresh

  • beginRefresh(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • summary

    Refreshes the share metadata with the data from the cloud.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(deviceName: string, name: string, share: Share, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.SharesCreateOrUpdateResponse>
  • summary

    Creates a new share or updates an existing share on the device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • share: Share

      The share properties.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SharesCreateOrUpdateResponse>

    Promise<Models.SharesCreateOrUpdateResponse>

deleteMethod

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

  • Deletes the share on the data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.SharesGetResponse>
  • get(deviceName: string, name: string, resourceGroupName: string, callback: msRest.ServiceCallback<Share>): void
  • get(deviceName: string, name: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Share>): void
  • summary

    Gets a share by name.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SharesGetResponse>

    Promise<Models.SharesGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<Share>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Share>

      The callback

    Returns void

listByDataBoxEdgeDevice

  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.SharesListByDataBoxEdgeDeviceResponse>
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, callback: msRest.ServiceCallback<ShareList>): void
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ShareList>): void
  • summary

    Lists all the shares in a data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SharesListByDataBoxEdgeDeviceResponse>

    Promise<Models.SharesListByDataBoxEdgeDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<ShareList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ShareList>

      The callback

    Returns void

listByDataBoxEdgeDeviceNext

  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.SharesListByDataBoxEdgeDeviceNextResponse>
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, callback: msRest.ServiceCallback<ShareList>): void
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ShareList>): void
  • summary

    Lists all the shares in a data box edge/gateway device.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SharesListByDataBoxEdgeDeviceNextResponse>

    Promise<Models.SharesListByDataBoxEdgeDeviceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ShareList>

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

      The callback

    Returns void

refresh

  • refresh(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • summary

    Refreshes the share metadata with the data from the cloud.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The share name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

Generated using TypeDoc