NotificationChannelsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DevTestLabsClient's

<xref:notification_channels> attribute.

Constructor

NotificationChannelsOperations(*args, **kwargs)

Methods

create_or_update

Create or replace an existing notification channel.
delete

Delete notification channel.
get

Get notification channel.
list

List notification channels in a given lab.
notify

Send notification to provided channel.
update

Allows modifying tags of notification channels. All other properties will be ignored.

create_or_update

Create or replace an existing notification channel.

create_or_update(resource_group_name: str, lab_name: str, name: str, notification_channel: _models.NotificationChannel, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NotificationChannel

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the notification channel. Required.
notification_channel
Required
NotificationChannel or IO[bytes]

A notification. Is either a NotificationChannel type or a IO[bytes] type. Required.

Returns

Type Description
NotificationChannel

NotificationChannel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete notification channel.

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the notification channel. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get notification channel.

get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs: Any) -> NotificationChannel

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the notification channel. Required.
expand
str

Specify the $expand query. Example: 'properties($select=webHookUrl)'. Default value is None.

Default value: None

Returns

Type Description
NotificationChannel

NotificationChannel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List notification channels in a given lab.

list(resource_group_name: str, lab_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[NotificationChannel]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
expand
str

Specify the $expand query. Example: 'properties($select=webHookUrl)'. Default value is None.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[NotificationChannel]

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

Exceptions

Type Description
HttpResponseError

notify

Send notification to provided channel.

notify(resource_group_name: str, lab_name: str, name: str, event_name: str | NotificationChannelEventType | None = None, json_payload: str | None = None, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the notification channel. Required.
event_name
str or NotificationChannelEventType

The type of event (i.e. AutoShutdown, Cost). Known values are: "AutoShutdown" and "Cost". Default value is None.

Default value: None
json_payload
str

Properties for the notification in json format. Default value is None.

Default value: None

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Allows modifying tags of notification channels. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> NotificationChannel

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the notification channel. Required.
tags
dict[str, str]

The tags of the resource. Default value is None.

Default value: None

Returns

Type Description
NotificationChannel

NotificationChannel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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