SharesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:shares> attribute.

Constructor

SharesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a new share or updates an existing share on the device. Creates a new share or updates an existing share on the device.
begin_delete	Deletes the share on the Data Box Edge/Data Box Gateway device.
begin_refresh	Refreshes the share metadata with the data from the cloud. Refreshes the share metadata with the data from the cloud.
get	Gets a share by name. Gets a share by name.
list_by_data_box_edge_device	Lists all the shares in a Data Box Edge/Data Box Gateway device. Lists all the shares in a Data Box Edge/Data Box Gateway device.

begin_create_or_update

Creates a new share or updates an existing share on the device.

Creates a new share or updates an existing share on the device.

async begin_create_or_update(device_name: str, name: str, resource_group_name: str, share: _models.Share, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Share]

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The share name. Required.
resource_group_name Required	str The resource group name. Required.
share Required	Share or IO[bytes] The share properties. Is either a Share type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Share]	An instance of AsyncLROPoller that returns either Share or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the share on the Data Box Edge/Data Box Gateway device.

async begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The share name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_refresh

Refreshes the share metadata with the data from the cloud.

Refreshes the share metadata with the data from the cloud.

async begin_refresh(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The share name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a share by name.

Gets a share by name.

async get(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> Share

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The share name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
Share	Share or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_data_box_edge_device

Lists all the shares in a Data Box Edge/Data Box Gateway device.

Lists all the shares in a Data Box Edge/Data Box Gateway device.

list_by_data_box_edge_device(device_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[Share]

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
AsyncItemPaged[Share]	An iterator like instance of either Share or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>