DevicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:devices> attribute.

Constructor

DevicesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a Data Box Edge/Data Box Gateway resource.
begin_create_or_update_security_settings	Updates the security settings on a Data Box Edge/Data Box Gateway device.
begin_delete	Deletes the Data Box Edge/Data Box Gateway device.
begin_download_updates	Downloads the updates on a Data Box Edge/Data Box Gateway device. Downloads the updates on a Data Box Edge/Data Box Gateway device.
begin_install_updates	Installs the updates on the Data Box Edge/Data Box Gateway device. Installs the updates on the Data Box Edge/Data Box Gateway device.
begin_scan_for_updates	Scans for updates on a Data Box Edge/Data Box Gateway device. Scans for updates on a Data Box Edge/Data Box Gateway device.
get	Gets the properties of the Data Box Edge/Data Box Gateway device.
get_extended_information	Gets additional information for the specified Data Box Edge/Data Box Gateway device.
get_network_settings	Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
get_update_summary	Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device. Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.
list_by_resource_group	Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
list_by_subscription	Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
update	Modifies a Data Box Edge/Data Box Gateway resource.
upload_certificate	Uploads registration certificate for the device.

begin_create_or_update

Creates or updates a Data Box Edge/Data Box Gateway resource.

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

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.
data_box_edge_device Required	DataBoxEdgeDevice or IO[bytes] The resource object. Is either a DataBoxEdgeDevice type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_security_settings

Updates the security settings on a Data Box Edge/Data Box Gateway device.

async begin_create_or_update_security_settings(device_name: str, resource_group_name: str, security_settings: _models.SecuritySettings, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.
security_settings Required	SecuritySettings or IO[bytes] The security settings. Is either a SecuritySettings type or a IO[bytes] type. 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_delete

Deletes the Data Box Edge/Data Box Gateway device.

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

Parameters

Name	Description
device_name Required	str The device 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_download_updates

Downloads the updates on a Data Box Edge/Data Box Gateway device.

Downloads the updates on a Data Box Edge/Data Box Gateway device.

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

Parameters

Name	Description
device_name Required	str The device 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_install_updates

Installs the updates on the Data Box Edge/Data Box Gateway device.

Installs the updates on the Data Box Edge/Data Box Gateway device.

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

Parameters

Name	Description
device_name Required	str The device 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_scan_for_updates

Scans for updates on a Data Box Edge/Data Box Gateway device.

Scans for updates on a Data Box Edge/Data Box Gateway device.

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

Parameters

Name	Description
device_name Required	str The device 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 the properties of the Data Box Edge/Data Box Gateway device.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get_extended_information

Gets additional information for the specified Data Box Edge/Data Box Gateway device.

async get_extended_information(device_name: str, resource_group_name: str, **kwargs: Any) -> DataBoxEdgeDeviceExtendedInfo

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get_network_settings

Gets the network settings of the specified Data Box Edge/Data Box Gateway device.

async get_network_settings(device_name: str, resource_group_name: str, **kwargs: Any) -> NetworkSettings

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get_update_summary

Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.

Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.

async get_update_summary(device_name: str, resource_group_name: str, **kwargs: Any) -> UpdateSummary

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

list_by_resource_group(resource_group_name: str, expand: str | None = None, **kwargs: Any) -> AsyncIterable[DataBoxEdgeDevice]

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
expand	str Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

list_by_subscription(expand: str | None = None, **kwargs: Any) -> AsyncIterable[DataBoxEdgeDevice]

Parameters

Name	Description
expand	str Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Modifies a Data Box Edge/Data Box Gateway resource.

async update(device_name: str, resource_group_name: str, parameters: _models.DataBoxEdgeDevicePatch, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DataBoxEdgeDevice

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

upload_certificate

Uploads registration certificate for the device.

async upload_certificate(device_name: str, resource_group_name: str, parameters: _models.UploadCertificateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.UploadCertificateResponse

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.
parameters Required	UploadCertificateRequest or IO[bytes] The upload certificate request. Is either a UploadCertificateRequest type or a IO[bytes] type. Required.

Returns

Type	Description
UploadCertificateResponse	UploadCertificateResponse 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'>