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.v2019_03_01.models._models_py3.ARMBaseModel

Share

Constructor

Share(*, share_status: Union[str, azure.mgmt.databoxedge.v2019_03_01.models._data_box_edge_management_client_enums.ShareStatus], monitoring_status: Union[str, azure.mgmt.databoxedge.v2019_03_01.models._data_box_edge_management_client_enums.MonitoringStatus], access_protocol: Union[str, azure.mgmt.databoxedge.v2019_03_01.models._data_box_edge_management_client_enums.ShareAccessProtocol], description: Optional[str] = None, azure_container_info: Optional[azure.mgmt.databoxedge.v2019_03_01.models._models_py3.AzureContainerInfo] = None, user_access_rights: Optional[List[azure.mgmt.databoxedge.v2019_03_01.models._models_py3.UserAccessRight]] = None, client_access_rights: Optional[List[azure.mgmt.databoxedge.v2019_03_01.models._models_py3.ClientAccessRight]] = None, refresh_details: Optional[azure.mgmt.databoxedge.v2019_03_01.models._models_py3.RefreshDetails] = None, data_policy: Optional[Union[str, azure.mgmt.databoxedge.v2019_03_01.models._data_box_edge_management_client_enums.DataPolicy]] = None, **kwargs)

Parameters

description

str

Required

Description for the share.

share_status

str or ShareStatus

Required

Required. Current status of the share. Possible values include: "Online", "Offline".

monitoring_status

str or MonitoringStatus

Required

Required. Current monitoring status of the share. Possible values include: "Enabled", "Disabled".

azure_container_info

AzureContainerInfo

Required

Azure container mapping for the share.

access_protocol

str or ShareAccessProtocol

Required

Required. Access protocol to be used by the share. Possible values include: "SMB", "NFS".

user_access_rights

list[UserAccessRight]

Required

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

client_access_rights

list[ClientAccessRight]

Required

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

refresh_details

RefreshDetails

Required

Details of the refresh job on this share.

data_policy

str or DataPolicy

Required

Data policy of the share. Possible values include: "Cloud", "Local".

Variables

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.