SharesOperations Class

SharesOperations operations.

Inheritance

builtins.object

SharesOperations

Constructor

SharesOperations(client, config, serializer, deserializer)

Parameters

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

api_version

The API version. Constant value: "2019-03-01".

Methods

create_or_update	Creates a new share or updates an existing share on the device.
delete	Deletes the share on the data box edge/gateway device.
get	Gets a share by name.
list_by_data_box_edge_device	Lists all the shares in a data box edge/gateway device.
refresh	Refreshes the share metadata with the data from the cloud.

create_or_update

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

create_or_update(device_name, name, share, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The share name.

share

Share

Required

The share properties.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Share or ClientRawResponse if raw==True

Return type

AzureOperationPoller[Share],

AzureOperationPoller[ClientRawResponse[Share]]

Exceptions

CloudError

delete

Deletes the share on the data box edge/gateway device.

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The share name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

get

Gets a share by name.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The share name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Share or ClientRawResponse if raw=true

Return type

Share,

ClientRawResponse

Exceptions

CloudError

list_by_data_box_edge_device

Lists all the shares in a data box edge/gateway device.

list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of Share

Return type

SharePaged[Share]

Exceptions

CloudError

refresh

Refreshes the share metadata with the data from the cloud.

refresh(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The share name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

Attributes

models

models = <module 'azure.mgmt.edgegateway.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\edgegateway\\models\\__init__.py'>