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

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.

begin_create_or_update(device_name: str, resource_group_name: str, data_box_edge_device: azure.mgmt.datab.models._models_py3.DataBoxEdgeDevice, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.DataBoxEdgeDevice')]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

data_box_edge_device
<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDevice>
Required

The resource object.

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

AsyncLROPoller[<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDevice>]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_create_or_update_security_settings

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

begin_create_or_update_security_settings(device_name: str, resource_group_name: str, security_settings: azure.mgmt.datab.models._models_py3.SecuritySettings, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

security_settings
<xref:azure.mgmt.databoxedge.v2020_12_01.models.SecuritySettings>
Required

The security settings.

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

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the Data Box Edge/Data Box Gateway device.

begin_delete(device_name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

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

~azure.core.exceptions.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.

begin_download_updates(device_name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

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

~azure.core.exceptions.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.

begin_install_updates(device_name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

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

~azure.core.exceptions.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.

begin_scan_for_updates(device_name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

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

~azure.core.exceptions.HttpResponseError

generate_certificate

Generates certificate for activation key.

generate_certificate(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.GenerateCertResponse

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

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

Returns

GenerateCertResponse, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.GenerateCertResponse>

Exceptions

~azure.core.exceptions.HttpResponseError

get

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

get(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.DataBoxEdgeDevice

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

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

Returns

DataBoxEdgeDevice, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDevice>

Exceptions

~azure.core.exceptions.HttpResponseError

get_extended_information

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

get_extended_information(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.DataBoxEdgeDeviceExtendedInfo

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

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

Returns

DataBoxEdgeDeviceExtendedInfo, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDeviceExtendedInfo>

Exceptions

~azure.core.exceptions.HttpResponseError

get_network_settings

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

get_network_settings(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.NetworkSettings

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

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

Returns

NetworkSettings, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.NetworkSettings>

Exceptions

~azure.core.exceptions.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.

get_update_summary(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.UpdateSummary

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

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

Returns

UpdateSummary, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.UpdateSummary>

Exceptions

~azure.core.exceptions.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: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.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.

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

AsyncItemPaged[<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDeviceList>]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_subscription

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

list_by_subscription(expand: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.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.

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

AsyncItemPaged[<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDeviceList>]

Exceptions

~azure.core.exceptions.HttpResponseError

update

Modifies a Data Box Edge/Data Box Gateway resource.

update(device_name: str, resource_group_name: str, parameters: azure.mgmt.datab.models._models_py3.DataBoxEdgeDevicePatch, **kwargs) -> azure.mgmt.datab.models._models_py3.DataBoxEdgeDevice

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDevicePatch>
Required

The resource 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

<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDevice>

Exceptions

~azure.core.exceptions.HttpResponseError

update_extended_information

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

update_extended_information(device_name: str, resource_group_name: str, parameters: azure.mgmt.datab.models._models_py3.DataBoxEdgeDeviceExtendedInfoPatch, **kwargs) -> azure.mgmt.datab.models._models_py3.DataBoxEdgeDeviceExtendedInfo

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDeviceExtendedInfoPatch>
Required

The patch object.

cls
callable

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

Returns

DataBoxEdgeDeviceExtendedInfo, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.DataBoxEdgeDeviceExtendedInfo>

Exceptions

~azure.core.exceptions.HttpResponseError

upload_certificate

Uploads registration certificate for the device.

upload_certificate(device_name: str, resource_group_name: str, parameters: azure.mgmt.datab.models._models_py3.UploadCertificateRequest, **kwargs) -> azure.mgmt.datab.models._models_py3.UploadCertificateResponse

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

parameters
<xref:azure.mgmt.databoxedge.v2020_12_01.models.UploadCertificateRequest>
Required

The upload certificate request.

cls
callable

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

Returns

UploadCertificateResponse, or the result of cls(response)

Return type

<xref:azure.mgmt.databoxedge.v2020_12_01.models.UploadCertificateResponse>

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datab.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\datab\\models\\__init__.py'>