Shares interface

Package:

@azure/arm-databoxedge

Interface representing a Shares.

Methods

beginCreateOrUpdate(string, string, string, Share, SharesCreateOrUpdateOptionalParams)	Creates a new share or updates an existing share on the device.
beginCreateOrUpdateAndWait(string, string, string, Share, SharesCreateOrUpdateOptionalParams)	Creates a new share or updates an existing share on the device.
beginDelete(string, string, string, SharesDeleteOptionalParams)	Deletes the share on the Data Box Edge/Data Box Gateway device.
beginDeleteAndWait(string, string, string, SharesDeleteOptionalParams)	Deletes the share on the Data Box Edge/Data Box Gateway device.
beginRefresh(string, string, string, SharesRefreshOptionalParams)	Refreshes the share metadata with the data from the cloud.
beginRefreshAndWait(string, string, string, SharesRefreshOptionalParams)	Refreshes the share metadata with the data from the cloud.
get(string, string, string, SharesGetOptionalParams)	Gets a share by name.
listByDataBoxEdgeDevice(string, string, SharesListByDataBoxEdgeDeviceOptionalParams)	Lists all the shares in a Data Box Edge/Data Box Gateway device.

Method Details

beginCreateOrUpdate(string, string, string, Share, SharesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Share>, Share>>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

share

Share

The share properties.

options

SharesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Share>, Share>>

beginCreateOrUpdateAndWait(string, string, string, Share, SharesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams): Promise<Share>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

share

Share

The share properties.

options

SharesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Share>

beginDelete(string, string, string, SharesDeleteOptionalParams)

Deletes the share on the Data Box Edge/Data Box Gateway device.

function beginDelete(deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

options

SharesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, SharesDeleteOptionalParams)

Deletes the share on the Data Box Edge/Data Box Gateway device.

function beginDeleteAndWait(deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

options

SharesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRefresh(string, string, string, SharesRefreshOptionalParams)

Refreshes the share metadata with the data from the cloud.

function beginRefresh(deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

options

SharesRefreshOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginRefreshAndWait(string, string, string, SharesRefreshOptionalParams)

Refreshes the share metadata with the data from the cloud.

function beginRefreshAndWait(deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

options

SharesRefreshOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, SharesGetOptionalParams)

Gets a share by name.

function get(deviceName: string, name: string, resourceGroupName: string, options?: SharesGetOptionalParams): Promise<Share>

Parameters

deviceName

string

The device name.

name

string

The share name.

resourceGroupName

string

The resource group name.

options

SharesGetOptionalParams

The options parameters.

Returns

Promise<Share>

listByDataBoxEdgeDevice(string, string, SharesListByDataBoxEdgeDeviceOptionalParams)

Lists all the shares in a Data Box Edge/Data Box Gateway device.

function listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: SharesListByDataBoxEdgeDeviceOptionalParams): PagedAsyncIterableIterator<Share, Share[], PageSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

SharesListByDataBoxEdgeDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Share, Share[], PageSettings>