AlertsOperations Class

AlertsOperations 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

AlertsOperations

Constructor

AlertsOperations(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_resource_group_level_alerts	Get an alert that is associated a resource group or a resource in a resource group.
get_subscription_level_alert	Get an alert that is associated with a subscription.
list	List all the alerts that are associated with the subscription.
list_by_resource_group	List all the alerts that are associated with the resource group.
list_resource_group_level_alerts_by_region	List all the alerts that are associated with the resource group that are stored in a specific location.
list_subscription_level_alerts_by_region	List all the alerts that are associated with the subscription that are stored in a specific location.
update_resource_group_level_alert_state_to_dismiss	Update the alert's state.
update_resource_group_level_alert_state_to_reactivate	Update the alert's state.
update_resource_group_level_state_to_resolve	Update the alert's state.
update_subscription_level_alert_state_to_dismiss	Update the alert's state.
update_subscription_level_alert_state_to_reactivate	Update the alert's state.
update_subscription_level_state_to_resolve	Update the alert's state.

get_resource_group_level_alerts

Get an alert that is associated a resource group or a resource in a resource group.

async get_resource_group_level_alerts(alert_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.security.models._models_py3.Alert

Parameters

alert_name

str

Required

Name of the alert object.

resource_group_name

str

Required

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

cls

callable

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

Returns

Alert, or the result of cls(response)

Return type

Alert

Exceptions

HttpResponseError

get_subscription_level_alert

Get an alert that is associated with a subscription.

async get_subscription_level_alert(alert_name: str, **kwargs) -> azure.mgmt.security.models._models_py3.Alert

Parameters

alert_name

str

Required

Name of the alert object.

cls

callable

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

Returns

Alert, or the result of cls(response)

Return type

Alert

Exceptions

HttpResponseError

list

List all the alerts that are associated with the subscription.

list(**kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.AlertList]

Parameters

cls

callable

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

Returns

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

Return type

AsyncItemPaged[AlertList]

Exceptions

HttpResponseError

list_by_resource_group

List all the alerts that are associated with the resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.AlertList]

Parameters

resource_group_name

str

Required

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

cls

callable

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

Returns

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

Return type

AsyncItemPaged[AlertList]

Exceptions

HttpResponseError

list_resource_group_level_alerts_by_region

List all the alerts that are associated with the resource group that are stored in a specific location.

list_resource_group_level_alerts_by_region(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.AlertList]

Parameters

resource_group_name

str

Required

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

cls

callable

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

Returns

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

Return type

AsyncItemPaged[AlertList]

Exceptions

HttpResponseError

list_subscription_level_alerts_by_region

List all the alerts that are associated with the subscription that are stored in a specific location.

list_subscription_level_alerts_by_region(**kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.AlertList]

Parameters

cls

callable

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

Returns

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

Return type

AsyncItemPaged[AlertList]

Exceptions

HttpResponseError

update_resource_group_level_alert_state_to_dismiss

Update the alert's state.

async update_resource_group_level_alert_state_to_dismiss(alert_name: str, resource_group_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

resource_group_name

str

Required

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

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update_resource_group_level_alert_state_to_reactivate

Update the alert's state.

async update_resource_group_level_alert_state_to_reactivate(alert_name: str, resource_group_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

resource_group_name

str

Required

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

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update_resource_group_level_state_to_resolve

Update the alert's state.

async update_resource_group_level_state_to_resolve(alert_name: str, resource_group_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

resource_group_name

str

Required

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

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update_subscription_level_alert_state_to_dismiss

Update the alert's state.

async update_subscription_level_alert_state_to_dismiss(alert_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update_subscription_level_alert_state_to_reactivate

Update the alert's state.

async update_subscription_level_alert_state_to_reactivate(alert_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update_subscription_level_state_to_resolve

Update the alert's state.

async update_subscription_level_state_to_resolve(alert_name: str, **kwargs) -> None

Parameters

alert_name

str

Required

Name of the alert object.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

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