DevicesOperations Class
DevicesOperations 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.objectDevicesOperations
Constructor
DevicesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
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/Gateway resource. |
| begin_create_or_update_security_settings |
Updates the security settings on a data box edge/gateway device. |
| begin_delete |
Deletes the data box edge/gateway device. |
| begin_download_updates |
Downloads the updates on a data box edge/gateway device. Downloads the updates on a data box edge/gateway device. |
| begin_install_updates |
Installs the updates on the data box edge/gateway device. Installs the updates on the data box edge/gateway device. |
| begin_scan_for_updates |
Scans for updates on a data box edge/gateway device. Scans for updates on a data box edge/gateway device. |
| get |
Gets the properties of the data box edge/gateway device. |
| get_extended_information |
Gets additional information for the specified data box edge/gateway device. |
| get_network_settings |
Gets the network settings of the specified data box edge/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/gateway devices in a resource group. |
| list_by_subscription |
Gets all the data box edge/gateway devices in a subscription. |
| update |
Modifies a Data Box Edge/Gateway resource. |
| upload_certificate |
Uploads registration certificate for the device. |
begin_create_or_update
Creates or updates a Data Box Edge/Gateway resource.
begin_create_or_update(device_name: str, resource_group_name: str, data_box_edge_device: _models.DataBoxEdgeDevice, **kwargs: Any) -> LROPoller[_models.DataBoxEdgeDevice]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 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
An instance of LROPoller 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/gateway device.
begin_create_or_update_security_settings(device_name: str, resource_group_name: str, security_settings: _models.SecuritySettings, **kwargs: Any) -> LROPoller[None]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 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the data box edge/gateway device.
begin_delete(device_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]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 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_download_updates
Downloads the updates on a data box edge/gateway device.
Downloads the updates on a data box edge/gateway device.
begin_download_updates(device_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]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 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_install_updates
Installs the updates on the data box edge/gateway device.
Installs the updates on the data box edge/gateway device.
begin_install_updates(device_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]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 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
An instance of LROPoller 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/gateway device.
Scans for updates on a data box edge/gateway device.
begin_scan_for_updates(device_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]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 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get
Gets the properties of the data box edge/gateway device.
get(device_name: str, resource_group_name: str, **kwargs: Any) -> _models.DataBoxEdgeDeviceParameters
- 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 data box edge/gateway device.
get_extended_information(device_name: str, resource_group_name: str, **kwargs: Any) -> _models.DataBoxEdgeDeviceExtendedInfoParameters
- 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/gateway device.
get_network_settings(device_name: str, resource_group_name: str, **kwargs: Any) -> _models.NetworkSettingsParameters
- 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.
get_update_summary(device_name: str, resource_group_name: str, **kwargs: Any) -> _models.UpdateSummaryParameters
- 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/gateway devices in a resource group.
list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) -> Iterable[_models.DataBoxEdgeDeviceList]Parameters
- expand
- str
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
Exceptions
list_by_subscription
Gets all the data box edge/gateway devices in a subscription.
list_by_subscription(expand: Optional[str] = None, **kwargs: Any) -> Iterable[_models.DataBoxEdgeDeviceList]Parameters
- expand
- str
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
Exceptions
update
Modifies a Data Box Edge/Gateway resource.
update(device_name: str, resource_group_name: str, parameters: _models.DataBoxEdgeDevicePatch, **kwargs: Any) -> _models.DataBoxEdgeDeviceParameters
- 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
upload_certificate
Uploads registration certificate for the device.
upload_certificate(device_name: str, resource_group_name: str, parameters: _models.UploadCertificateRequest, **kwargs: Any) -> _models.UploadCertificateResponseParameters
- 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.v2019_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_03_01\\models\\__init__.py'>Feedback
Submit and view feedback for