azure.mgmt.edgegateway.operations module

class azure.mgmt.edgegateway.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

list(custom_headers=None, raw=False, **operation_config)

List all the supported operations.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.DevicesOperations(client, config, serializer, deserializer)

Bases: object

DevicesOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates or updates a Data Box Edge/Gateway resource.

Parameters

• device_name (str) – The device name.

• data_box_edge_device (DataBoxEdgeDevice) – The resource object.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<DataBoxEdgeDevice> if raw==True

Return type

AzureOperationPoller[DataBoxEdgeDevice] or AzureOperationPoller[ClientRawResponse[DataBoxEdgeDevice]]

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• device_admin_password (AsymmetricEncryptedSecret) – 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) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

Deletes the data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

Gets the properties of the data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DataBoxEdgeDevice or ClientRawResponse if raw=true

Return type

DataBoxEdgeDevice or ClientRawResponse

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DataBoxEdgeDeviceExtendedInfo or ClientRawResponse if raw=true

Return type

DataBoxEdgeDeviceExtendedInfo or ClientRawResponse

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

NetworkSettings or ClientRawResponse if raw=true

Return type

NetworkSettings or ClientRawResponse

Raises

CloudError

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

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.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

UpdateSummary or ClientRawResponse if raw=true

Return type

UpdateSummary or ClientRawResponse

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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

Parameters

• resource_group_name (str) – The resource group name.

• 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.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DataBoxEdgeDevice

Return type

DataBoxEdgeDevicePaged[DataBoxEdgeDevice]

Raises

CloudError

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

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

Parameters

• 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.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of DataBoxEdgeDevice

Return type

DataBoxEdgeDevicePaged[DataBoxEdgeDevice]

Raises

CloudError

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

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

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

Modifies a Data Box Edge/Gateway resource.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• tags (dict[str, str]) – The tags attached to the Data Box Edge/Gateway resource.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DataBoxEdgeDevice or ClientRawResponse if raw=true

Return type

DataBoxEdgeDevice or ClientRawResponse

Raises

CloudError

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

Uploads registration certificate for the device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• certificate (str) – The base64 encoded certificate raw data.

• authentication_type (str or AuthenticationType) – The authentication type. Possible values include: ‘Invalid’, ‘AzureActiveDirectory’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

UploadCertificateResponse or ClientRawResponse if raw=true

Return type

UploadCertificateResponse or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.AlertsOperations(client, config, serializer, deserializer)

Bases: object

AlertsOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets an alert by name.

Parameters

• device_name (str) – The device name.

• name (str) – The alert name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Alert or ClientRawResponse if raw=true

Return type

Alert or ClientRawResponse

Raises

CloudError

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

Gets all the alerts for a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Alert

Return type

AlertPaged[Alert]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations(client, config, serializer, deserializer)

Bases: object

BandwidthSchedulesOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates or updates a bandwidth schedule.

Parameters

• device_name (str) – The device name.

• name (str) – The bandwidth schedule name which needs to be added/updated.

• parameters (BandwidthSchedule) – The bandwidth schedule to be added or updated.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BandwidthSchedule or ClientRawResponse<BandwidthSchedule> if raw==True

Return type

AzureOperationPoller[BandwidthSchedule] or AzureOperationPoller[ClientRawResponse[BandwidthSchedule]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified bandwidth schedule.

Parameters

• device_name (str) – The device name.

• name (str) – The bandwidth schedule name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets the properties of the specified bandwidth schedule.

Parameters

• device_name (str) – The device name.

• name (str) – The bandwidth schedule name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BandwidthSchedule or ClientRawResponse if raw=true

Return type

BandwidthSchedule or ClientRawResponse

Raises

CloudError

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

Gets all the bandwidth schedules for a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of BandwidthSchedule

Return type

BandwidthSchedulePaged[BandwidthSchedule]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.JobsOperations(client, config, serializer, deserializer)

Bases: object

JobsOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets the details of a specified job on a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The job name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Job or ClientRawResponse if raw=true

Return type

Job or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.OperationsStatusOperations(client, config, serializer, deserializer)

Bases: object

OperationsStatusOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets the details of a specified job on a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The job name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Job or ClientRawResponse if raw=true

Return type

Job or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.OrdersOperations(client, config, serializer, deserializer)

Bases: object

OrdersOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates or updates an order.

Parameters

• device_name (str) – The device name.

• order (Order) – The order to be created or updated.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Order or ClientRawResponse<Order> if raw==True

Return type

AzureOperationPoller[Order] or AzureOperationPoller[ClientRawResponse[Order]]

Raises

CloudError

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

Deletes the order related to the device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

Gets a specific order by name.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Order or ClientRawResponse if raw=true

Return type

Order or ClientRawResponse

Raises

CloudError

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

Lists all the orders related to a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Order

Return type

OrderPaged[Order]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.RolesOperations(client, config, serializer, deserializer)

Bases: object

RolesOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Create or update a role.

Parameters

• device_name (str) – The device name.

• name (str) – The role name.

• role (Role) – The role properties.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Role or ClientRawResponse<Role> if raw==True

Return type

AzureOperationPoller[Role] or AzureOperationPoller[ClientRawResponse[Role]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the role on the data box edge device.

Parameters

• device_name (str) – The device name.

• name (str) – The role name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets a specific role by name.

Parameters

• device_name (str) – The device name.

• name (str) – The role name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Role or ClientRawResponse if raw=true

Return type

Role or ClientRawResponse

Raises

CloudError

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

Lists all the roles configured in a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Role

Return type

RolePaged[Role]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.SharesOperations(client, config, serializer, deserializer)

Bases: object

SharesOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates a new share or updates an existing share on the device.

Parameters

• device_name (str) – The device name.

• name (str) – The share name.

• share (Share) – The share properties.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Share or ClientRawResponse<Share> if raw==True

Return type

AzureOperationPoller[Share] or AzureOperationPoller[ClientRawResponse[Share]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the share on the data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The share name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets a share by name.

Parameters

• device_name (str) – The device name.

• name (str) – The share name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Share or ClientRawResponse if raw=true

Return type

Share or ClientRawResponse

Raises

CloudError

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

Lists all the shares in a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Share

Return type

SharePaged[Share]

Raises

CloudError

refresh(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Refreshes the share metadata with the data from the cloud.

Parameters

• device_name (str) – The device name.

• name (str) – The share name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations(client, config, serializer, deserializer)

Bases: object

StorageAccountCredentialsOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates or updates the storage account credential.

Parameters

• device_name (str) – The device name.

• name (str) – The storage account credential name.

• storage_account_credential (StorageAccountCredential) – The storage account credential.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns StorageAccountCredential or ClientRawResponse<StorageAccountCredential> if raw==True

Return type

AzureOperationPoller[StorageAccountCredential] or AzureOperationPoller[ClientRawResponse[StorageAccountCredential]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the storage account credential.

Parameters

• device_name (str) – The device name.

• name (str) – The storage account credential name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets the properties of the specified storage account credential.

Parameters

• device_name (str) – The device name.

• name (str) – The storage account credential name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StorageAccountCredential or ClientRawResponse if raw=true

Return type

StorageAccountCredential or ClientRawResponse

Raises

CloudError

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

Gets all the storage account credentials in a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of StorageAccountCredential

Return type

StorageAccountCredentialPaged[StorageAccountCredential]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.TriggersOperations(client, config, serializer, deserializer)

Bases: object

TriggersOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

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

Creates or updates a trigger.

Parameters

• device_name (str) – Creates or updates a trigger

• name (str) – The trigger name.

• trigger (Trigger) – The trigger.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Trigger or ClientRawResponse<Trigger> if raw==True

Return type

AzureOperationPoller[Trigger] or AzureOperationPoller[ClientRawResponse[Trigger]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the trigger on the gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The trigger name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Get a specific trigger by name.

Parameters

• device_name (str) – The device name.

• name (str) – The trigger name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Trigger or ClientRawResponse if raw=true

Return type

Trigger or ClientRawResponse

Raises

CloudError

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

Lists all the triggers configured in the device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• expand (str) – Specify $filter=’CustomContextTag eq <tag>’ to filter on custom context tag property

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Trigger

Return type

TriggerPaged[Trigger]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>

class azure.mgmt.edgegateway.operations.UsersOperations(client, config, serializer, deserializer)

Bases: object

UsersOperations operations.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – The API version. Constant value: “2019-03-01”.

create_or_update(device_name, name, resource_group_name, encrypted_password=None, share_access_rights=None, custom_headers=None, raw=False, polling=True, **operation_config)

Creates a new user or updates an existing user’s information on a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The user name.

• resource_group_name (str) – The resource group name.

• encrypted_password (AsymmetricEncryptedSecret) – The password details.

• share_access_rights (list[ShareAccessRight]) – List of shares that the user has rights on. This field should not be specified during user creation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True

Return type

AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]

Raises

CloudError

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the user on a databox edge/gateway device.

Parameters

• device_name (str) – The device name.

• name (str) – The user name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Gets the properties of the specified user.

Parameters

• device_name (str) – The device name.

• name (str) – The user name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

User or ClientRawResponse if raw=true

Return type

User or ClientRawResponse

Raises

CloudError

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

Gets all the users registered on a data box edge/gateway device.

Parameters

• device_name (str) – The device name.

• resource_group_name (str) – The resource group name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of User

Return type

UserPaged[User]

Raises

CloudError

models = <module 'azure.mgmt.edgegateway.models' from '/home/vsts/work/1/s/sdk/edgegateway/azure-mgmt-edgegateway/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/edgegateway/models/__init__.py'>