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 server.

Constructor

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

Keyword-Only Parameters

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

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.
description	str Description for the share.
share_status	str or ShareStatus Current status of the share. Required. Known values are: "Offline", "Unknown", "OK", "Updating", and "NeedsAttention".
monitoring_status	str or MonitoringStatus Current monitoring status of the share. Required. Known values are: "Enabled" and "Disabled".
azure_container_info	AzureContainerInfo Azure container mapping for the share.
access_protocol	str or ShareAccessProtocol Access protocol to be used by the share. Required. Known values are: "SMB" and "NFS".
user_access_rights	list[UserAccessRight] Mapping of users and corresponding access rights on the share (required for SMB protocol).
client_access_rights	list[ClientAccessRight] List of IP addresses and corresponding access rights on the share(required for NFS protocol).
refresh_details	RefreshDetails Details of the refresh job on this share.
share_mappings	list[MountPointMap] Share mount point to the role.
data_policy	str or DataPolicy Data policy of the share. Known values are: "Cloud" and "Local".