SharesOperations interface

Package:

@azure/arm-databoxedge

Interface representing a Shares operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRefresh
beginRefreshAndWait
createOrUpdate	Creates a new share or updates an existing share on the device.
delete	Deletes the share on the Data Box Edge/Data Box Gateway device.
get	Gets a share by name.
listByDataBoxEdgeDevice	Lists all the shares in a Data Box Edge/Data Box Gateway device.
refresh	Refreshes the share metadata with the data from the cloud.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Share>, Share>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Share>, Share>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginRefresh

Warning

This API is now deprecated.

use refresh instead

beginRefresh: (deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRefreshAndWait

Warning

This API is now deprecated.

use refresh instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Share>, Share>

Property Value

(deviceName: string, name: string, resourceGroupName: string, share: Share, options?: SharesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Share>, Share>

delete

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

delete: (deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: SharesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a share by name.

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

Property Value

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

listByDataBoxEdgeDevice

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

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

Property Value

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

refresh

Refreshes the share metadata with the data from the cloud.

refresh: (deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: SharesRefreshOptionalParams) => PollerLike<OperationState<void>, void>