NotificationChannelsOperations Class

NotificationChannelsOperations 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

NotificationChannelsOperations

Constructor

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

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, **kwargs: Any) -> _models.NotificationChannel

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the notification channel.

notification_channel

NotificationChannel

Required

A notification.

cls

callable

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

Returns

NotificationChannel, or the result of cls(response)

Return type

NotificationChannel

Exceptions

HttpResponseError

delete

Delete notification channel.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the notification channel.

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

get

Get notification channel.

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.NotificationChannel

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the notification channel.

expand

str

default value: None

Specify the $expand query. Example: 'properties($select=webHookUrl)'.

cls

callable

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

Returns

NotificationChannel, or the result of cls(response)

Return type

NotificationChannel

Exceptions

HttpResponseError

list

List notification channels in a given lab.

list(resource_group_name: str, lab_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.NotificationChannelList]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

expand

str

default value: None

Specify the $expand query. Example: 'properties($select=webHookUrl)'.

filter

str

default value: None

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

top

int

default value: None

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

orderby

str

default value: None

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

cls

callable

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

Returns

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

Return type

ItemPaged[NotificationChannelList]

Exceptions

HttpResponseError

notify

Send notification to provided channel.

notify(resource_group_name: str, lab_name: str, name: str, event_name: Optional[Union[str, _models.NotificationChannelEventType]] = None, json_payload: Optional[str] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the notification channel.

event_name

str or NotificationChannelEventType

default value: None

The type of event (i.e. AutoShutdown, Cost).

json_payload

str

default value: None

Properties for the notification in json format.

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

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

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the notification channel.

notification_channel

NotificationChannelFragment

Required

A notification.

cls

callable

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

Returns

NotificationChannel, or the result of cls(response)

Return type

NotificationChannel

Exceptions

HttpResponseError

Attributes

models

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