DevicesOperations Class

DevicesOperations operations.

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

api_version

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

Methods

create_or_update	Creates or updates a Data Box Edge/Gateway resource.
create_or_update_security_settings	Updates the security settings on a data box edge/gateway device.
delete	Deletes the data box edge/gateway device.
download_updates	Downloads the 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.
install_updates	Installs the updates on the data box edge/gateway 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.
scan_for_updates	Scans for updates on a data box edge/gateway device.
update	Modifies a Data Box Edge/Gateway resource.
upload_certificate	Uploads registration certificate for the device.

create_or_update

Creates or updates a Data Box Edge/Gateway resource.

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

Parameters

device_name

str

Required

The device name.

data_box_edge_device

DataBoxEdgeDevice

Required

The resource object.

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 DataBoxEdgeDevice or ClientRawResponse if raw==True

Return type

AzureOperationPoller[DataBoxEdgeDevice],

AzureOperationPoller[ClientRawResponse[DataBoxEdgeDevice]]

Exceptions

CloudError

create_or_update_security_settings

Updates the security settings on a data box edge/gateway device.

create_or_update_security_settings(device_name, resource_group_name, device_admin_password, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

device_admin_password

AsymmetricEncryptedSecret

Required

Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters.

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

delete

Deletes the data box edge/gateway device.

delete(device_name, resource_group_name, custom_headers=None, raw=False, polling=True, **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

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

download_updates

Downloads the updates on a data box edge/gateway device.

download_updates(device_name, resource_group_name, custom_headers=None, raw=False, polling=True, **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

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 the properties of the data box edge/gateway device.

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

DataBoxEdgeDevice or ClientRawResponse if raw=true

Return type

DataBoxEdgeDevice,

ClientRawResponse

Exceptions

CloudError

get_extended_information

Gets additional information for the specified data box edge/gateway device.

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

DataBoxEdgeDeviceExtendedInfo or ClientRawResponse if raw=true

Return type

DataBoxEdgeDeviceExtendedInfo,

ClientRawResponse

Exceptions

CloudError

get_network_settings

Gets the network settings of the specified data box edge/gateway device.

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

NetworkSettings or ClientRawResponse if raw=true

Return type

NetworkSettings,

ClientRawResponse

Exceptions

CloudError

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.

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

UpdateSummary or ClientRawResponse if raw=true

Return type

UpdateSummary,

ClientRawResponse

Exceptions

CloudError

install_updates

Installs the updates on the data box edge/gateway device.

install_updates(device_name, resource_group_name, custom_headers=None, raw=False, polling=True, **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

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

list_by_resource_group

Gets all the data box edge/gateway devices in a resource group.

list_by_resource_group(resource_group_name, expand=None, custom_headers=None, raw=False, **operation_config)

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= to populate the next page in the list.

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 DataBoxEdgeDevice

Return type

DataBoxEdgeDevicePaged[DataBoxEdgeDevice]

Exceptions

CloudError

list_by_subscription

Gets all the data box edge/gateway devices in a subscription.

list_by_subscription(expand=None, custom_headers=None, raw=False, **operation_config)

Parameters

expand

str

default value: None

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

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 DataBoxEdgeDevice

Return type

DataBoxEdgeDevicePaged[DataBoxEdgeDevice]

Exceptions

CloudError

scan_for_updates

Scans for updates on a data box edge/gateway device.

scan_for_updates(device_name, resource_group_name, custom_headers=None, raw=False, polling=True, **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

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

update

Modifies a Data Box Edge/Gateway resource.

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

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

tags

dict[str, str]

default value: None

The tags attached to the Data Box Edge/Gateway resource.

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

DataBoxEdgeDevice or ClientRawResponse if raw=true

Return type

DataBoxEdgeDevice,

ClientRawResponse

Exceptions

CloudError

upload_certificate

Uploads registration certificate for the device.

upload_certificate(device_name, resource_group_name, certificate, authentication_type=None, custom_headers=None, raw=False, **operation_config)

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

certificate

str

Required

The base64 encoded certificate raw data.

authentication_type

str or AuthenticationType

default value: None

The authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory'

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

UploadCertificateResponse or ClientRawResponse if raw=true

Return type

UploadCertificateResponse,

ClientRawResponse

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'>