SharesOperations Class

SharesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SharesOperations

Constructor

SharesOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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.

begin_create_or_update(device_name: str, name: str, resource_group_name: str, share: '_models.Share', **kwargs: Any) -> LROPoller['_models.Share']

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[Share]	An instance of LROPoller 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.

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

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller 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.

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

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller 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.

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

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable['_models.ShareList']

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2020_05_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2020_05_01_preview\\models\\__init__.py'>