Share interface

Package:

@azure/arm-databoxedge

Represents a share on the Data Box Edge/Gateway device.

Extends

ARMBaseModel

Properties

accessProtocol	Access protocol to be used by the share.
azureContainerInfo	Azure container mapping for the share.
clientAccessRights	List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy	Data policy of the share.
description	Description for the share.
monitoringStatus	Current monitoring status of the share.
refreshDetails	Details of the refresh job on this share.
shareMappings	Share mount point to the role. NOTE: This property will not be serialized. It can only be populated by the server.
shareStatus	Current status of the share.
systemData	Share on ASE device NOTE: This property will not be serialized. It can only be populated by the server.
userAccessRights	Mapping of users and corresponding access rights on the share (required for SMB protocol).

Inherited Properties

id	The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.
name	The object name. NOTE: This property will not be serialized. It can only be populated by the server.
type	The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accessProtocol

Access protocol to be used by the share.

accessProtocol: string

Property Value

string

azureContainerInfo

Azure container mapping for the share.

azureContainerInfo?: AzureContainerInfo

Property Value

AzureContainerInfo

clientAccessRights

List of IP addresses and corresponding access rights on the share(required for NFS protocol).

clientAccessRights?: ClientAccessRight[]

Property Value

ClientAccessRight[]

dataPolicy

Data policy of the share.

dataPolicy?: string

Property Value

string

description

Description for the share.

description?: string

Property Value

string

monitoringStatus

Current monitoring status of the share.

monitoringStatus: string

Property Value

string

refreshDetails

Details of the refresh job on this share.

refreshDetails?: RefreshDetails

Property Value

RefreshDetails

shareMappings

Share mount point to the role. NOTE: This property will not be serialized. It can only be populated by the server.

shareMappings?: MountPointMap[]

Property Value

MountPointMap[]

shareStatus

Current status of the share.

shareStatus: string

Property Value

string

systemData

Share on ASE device NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

userAccessRights

Mapping of users and corresponding access rights on the share (required for SMB protocol).

userAccessRights?: UserAccessRight[]

Property Value

UserAccessRight[]

Inherited Property Details

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ARMBaseModel.id

name

The object name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ARMBaseModel.name

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ARMBaseModel.type