IotAlertsOperations Class

IotAlertsOperations 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

IotAlertsOperations

Constructor

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

models

Alias to model classes used in this operation group.

Methods

get	Get IoT alert.
get_at_scope	Get IoT alert.
list	List IoT alerts.
list_at_scope	List IoT alerts.

get

Get IoT alert.

async get(resource_group_name: str, solution_name: str, iot_alert_id: str, **kwargs) -> azure.mgmt.security.models._models_py3.IotAlert

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

solution_name

str

Required

The name of the IoT Security solution.

iot_alert_id

str

Required

Id of the alert.

cls

callable

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

Returns

IotAlert, or the result of cls(response)

Return type

IotAlert

Exceptions

HttpResponseError

get_at_scope

Get IoT alert.

async get_at_scope(scope: str, iot_alert_id: str, **kwargs) -> azure.mgmt.security.models._models_py3.IotAlertModel

Parameters

scope

str

Required

Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName}).

iot_alert_id

str

Required

Id of the alert.

cls

callable

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

Returns

IotAlertModel, or the result of cls(response)

Return type

IotAlertModel

Exceptions

HttpResponseError

list

List IoT alerts.

list(resource_group_name: str, solution_name: str, min_start_time_utc: Optional[str] = None, max_start_time_utc: Optional[str] = None, alert_type: Optional[str] = None, compromised_entity: Optional[str] = None, limit: Optional[int] = None, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.IotAlertList]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

solution_name

str

Required

The name of the IoT Security solution.

min_start_time_utc

str

default value: None

Filter by minimum startTimeUtc (ISO 8601 format).

max_start_time_utc

str

default value: None

Filter by maximum startTimeUtc (ISO 8601 format).

alert_type

str

default value: None

Filter by alert type.

compromised_entity

str

default value: None

Filter by compromised device.

limit

int

default value: None

Limit the number of items returned in a single page.

skip_token

str

default value: None

Skip token used for pagination.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[IotAlertList]

Exceptions

HttpResponseError

list_at_scope

List IoT alerts.

list_at_scope(scope: str, min_start_time_utc: Optional[str] = None, max_start_time_utc: Optional[str] = None, alert_type: Optional[str] = None, device_management_type: Optional[Union[str, azure.mgmt.security.models._security_center_enums.ManagementState]] = None, compromised_entity: Optional[str] = None, limit: Optional[int] = None, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.IotAlertListModel]

Parameters

scope

str

Required

Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName}).

min_start_time_utc

str

default value: None

Filter by minimum startTimeUtc (ISO 8601 format).

max_start_time_utc

str

default value: None

Filter by maximum startTimeUtc (ISO 8601 format).

alert_type

str

default value: None

Filter by alert type.

device_management_type

str or ManagementState

default value: None

Get devices only from specific type, Managed or Unmanaged.

compromised_entity

str

default value: None

Filter by compromised device.

limit

int

default value: None

Limit the number of items returned in a single page.

skip_token

str

default value: None

Skip token used for pagination.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[IotAlertListModel]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.security.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\security\\models\\__init__.py'>