Share Class

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.ARMBaseModel

Share

Constructor

Share(*, share_status: str | ShareStatus, monitoring_status: str | MonitoringStatus, access_protocol: str | ShareAccessProtocol, description: str | None = None, azure_container_info: AzureContainerInfo | None = None, user_access_rights: List[UserAccessRight] | None = None, client_access_rights: List[ClientAccessRight] | None = None, refresh_details: RefreshDetails | None = None, data_policy: str | DataPolicy | None = None, **kwargs)

Parameters

Name	Description
description Required	str Description for the share.
share_status Required	str or ShareStatus Required. Current status of the share. Possible values include: "Offline", "Unknown", "OK", "Updating", "NeedsAttention".
monitoring_status Required	str or MonitoringStatus Required. Current monitoring status of the share. Possible values include: "Enabled", "Disabled".
azure_container_info Required	AzureContainerInfo Azure container mapping for the share.
access_protocol Required	str or ShareAccessProtocol Required. Access protocol to be used by the share. Possible values include: "SMB", "NFS".
user_access_rights Required	list[UserAccessRight] Mapping of users and corresponding access rights on the share (required for SMB protocol).
client_access_rights Required	list[ClientAccessRight] List of IP addresses and corresponding access rights on the share(required for NFS protocol).
refresh_details Required	RefreshDetails Details of the refresh job on this share.
data_policy Required	str or DataPolicy Data policy of the share. Possible values include: "Cloud", "Local".

Keyword-Only Parameters

Name	Description
share_status Required
monitoring_status Required
access_protocol Required
description Required
azure_container_info Required
user_access_rights Required
client_access_rights Required
refresh_details Required
data_policy Required

Variables

Name	Description
id	str The path ID that uniquely identifies the object.
name	str The object name.
type	str The hierarchical type of the object.
share_mappings	list[MountPointMap] Share mount point to the role.