DevicesOperations Class

DevicesOperations async 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
DevicesOperations

Constructor

DevicesOperations(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

models

Alias to model classes used in this operation group.

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.

generate_certificate

Generates certificate for activation key.

get

Gets the properties of the Data Box Edge/Data Box Gateway device.

get_extended_information

Gets additional information for the specified Azure Stack 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.

update_extended_information

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

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: DataBoxEdgeDevice, **kwargs) -> AsyncLROPoller[DataBoxEdgeDevice]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

data_box_edge_device
DataBoxEdgeDevice
Required

The resource object.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either DataBoxEdgeDevice or the result of cls(response)

Return type

Exceptions

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: SecuritySettings, **kwargs) -> AsyncLROPoller[None]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

security_settings
SecuritySettings
Required

The security settings.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes the Data Box Edge/Data Box Gateway device.

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

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

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) -> AsyncLROPoller[None]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

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) -> AsyncLROPoller[None]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

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) -> AsyncLROPoller[None]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

generate_certificate

Generates certificate for activation key.

async generate_certificate(device_name: str, resource_group_name: str, **kwargs) -> GenerateCertResponse

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

GenerateCertResponse, or the result of cls(response)

Return type

Exceptions

get

Gets the properties of the Data Box Edge/Data Box Gateway device.

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

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

DataBoxEdgeDevice, or the result of cls(response)

Return type

Exceptions

get_extended_information

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

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

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

DataBoxEdgeDeviceExtendedInfo, or the result of cls(response)

Return type

Exceptions

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) -> NetworkSettings

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

NetworkSettings, or the result of cls(response)

Return type

Exceptions

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) -> UpdateSummary

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

UpdateSummary, or the result of cls(response)

Return type

Exceptions

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) -> AsyncIterable[DataBoxEdgeDeviceList]

Parameters

resource_group_name
str
Required

The resource group name.

expand
str
default value: None

Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=:code: to populate the next page in the list.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataBoxEdgeDeviceList or the result of cls(response)

Return type

Exceptions

list_by_subscription

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

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

Parameters

expand
str
default value: None

Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=:code: to populate the next page in the list.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataBoxEdgeDeviceList or the result of cls(response)

Return type

Exceptions

update

Modifies a Data Box Edge/Data Box Gateway resource.

async update(device_name: str, resource_group_name: str, parameters: DataBoxEdgeDevicePatch, **kwargs) -> DataBoxEdgeDevice

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
DataBoxEdgeDevicePatch
Required

The resource parameters.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

DataBoxEdgeDevice, or the result of cls(response)

Return type

Exceptions

update_extended_information

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

async update_extended_information(device_name: str, resource_group_name: str, parameters: DataBoxEdgeDeviceExtendedInfoPatch, **kwargs) -> DataBoxEdgeDeviceExtendedInfo

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
DataBoxEdgeDeviceExtendedInfoPatch
Required

The patch object.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

DataBoxEdgeDeviceExtendedInfo, or the result of cls(response)

Return type

Exceptions

upload_certificate

Uploads registration certificate for the device.

async upload_certificate(device_name: str, resource_group_name: str, parameters: UploadCertificateRequest, **kwargs) -> UploadCertificateResponse

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
UploadCertificateRequest
Required

The upload certificate request.

Keyword-Only Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

UploadCertificateResponse, or the result of cls(response)

Return type

Exceptions

Attributes

models

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