Share interface

Package:

@azure/arm-databoxedge

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

Extends

ProxyResource

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.
shareStatus	Current status of the share.
userAccessRights	Mapping of users and corresponding access rights on the share (required for SMB protocol).

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

shareMappings?: MountPointMap[]

Property Value

MountPointMap[]

shareStatus

Current status of the share.

shareStatus: string

Property Value

string

userAccessRights

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

userAccessRights?: UserAccessRight[]

Property Value

UserAccessRight[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type