NotificationChannelsOperations Class

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

Constructor

NotificationChannelsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

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.

async create_or_update(resource_group_name: str, lab_name: str, name: str, notification_channel: NotificationChannel, **kwargs) -> NotificationChannel

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the notification channel.
notification_channel Required	NotificationChannel A notification.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
NotificationChannel	NotificationChannel, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete notification channel.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the notification channel.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get notification channel.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the notification channel.
expand Required	str Specify the $expand query. Example: 'properties($select=webHookUrl)'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[NotificationChannelList]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
expand Required	str Specify the $expand query. Example: 'properties($select=webHookUrl)'. Default value: None
filter Required	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value: None
top Required	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value: None
orderby Required	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[NotificationChannelList]	An iterator like instance of either NotificationChannelList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

notify

Send notification to provided channel.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the notification channel.
event_name Required	str or NotificationChannelEventType The type of event (i.e. AutoShutdown, Cost). Default value: None
json_payload Required	str Properties for the notification in json format. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

async update(resource_group_name: str, lab_name: str, name: str, notification_channel: NotificationChannelFragment, **kwargs) -> NotificationChannel

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
name Required	str The name of the notification channel.
notification_channel Required	NotificationChannelFragment A notification.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>