TriggersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:triggers> attribute.

Constructor

TriggersOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a trigger.

begin_delete

Deletes the trigger on the gateway device.

get

Get a specific trigger by name.

list_by_data_box_edge_device

Lists all the triggers configured in the device.

begin_create_or_update

Creates or updates a trigger.

async begin_create_or_update(device_name: str, name: str, resource_group_name: str, trigger: _models.Trigger, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Trigger]

Parameters

Name Description
device_name
Required
str

Creates or updates a trigger. Required.

name
Required
str

The trigger name. Required.

resource_group_name
Required
str

The resource group name. Required.

trigger
Required

The trigger. Is either a Trigger type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

begin_delete

Deletes the trigger on the gateway device.

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

Parameters

Name Description
device_name
Required
str

The device name. Required.

name
Required
str

The trigger name. Required.

resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description

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

Exceptions

Type Description

get

Get a specific trigger by name.

async get(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> Trigger

Parameters

Name Description
device_name
Required
str

The device name. Required.

name
Required
str

The trigger name. Required.

resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description

Trigger or the result of cls(response)

Exceptions

Type Description

list_by_data_box_edge_device

Lists all the triggers configured in the device.

list_by_data_box_edge_device(device_name: str, resource_group_name: str, filter: str | None = None, **kwargs: Any) -> AsyncIterable[Trigger]

Parameters

Name Description
device_name
Required
str

The device name. Required.

resource_group_name
Required
str

The resource group name. Required.

filter
str

Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property. Default value is None.

Default value: None

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>