Share via

LabAnnouncementProperties Class

  • Reference

Properties of a lab's announcement banner.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

LabAnnouncementProperties(*, title: str | None = None, markdown: str | None = None, enabled: str | EnableStatus | None = None, expiration_date: datetime | None = None, expired: bool | None = None, **kwargs)

Parameters

Name Description
title
Required
str

The plain text title for the lab announcement.
markdown
Required
str

The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
enabled
Required
str or EnableStatus

Is the lab announcement active/enabled at this time?. Possible values include: "Enabled", "Disabled".
expiration_date
Required
datetime

The time at which the announcement expires (null for never).
expired
Required
bool

Has this announcement expired?.

Keyword-Only Parameters

Name Description
title
Default value: None
markdown
Default value: None
enabled
Default value: None
expiration_date
Default value: None
expired
Default value: None

Variables

Name Description
provisioning_state
str

The provisioning status of the resource.
unique_identifier
str

The unique immutable identifier of a resource (Guid).