RecommendationProperties Class
Recommendation resource specific properties.
Constructor
RecommendationProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
creation_time
|
Timestamp when this instance was created. |
|
recommendation_id
|
A GUID value that each recommendation object is associated with. |
|
resource_id
|
Full ARM resource ID string that this recommendation object is associated with. |
|
resource_scope
|
Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Known values are: "ServerFarm", "Subscription", and "WebSite". |
|
rule_name
|
Unique name of the rule. |
|
display_name
|
UI friendly name of the rule (may not be unique). |
|
message
|
Recommendation text. |
|
level
|
Level indicating how critical this recommendation can impact. Known values are: "Critical", "Warning", "Information", and "NonUrgentSuggestion". |
|
channels
|
List of channels that this recommendation can apply. Known values are: "Notification", "Api", "Email", "Webhook", and "All". |
|
category_tags
|
The list of category tags that this recommendation belongs to. |
|
action_name
|
Name of action recommended by this object. |
|
enabled
|
True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. |
|
states
|
The list of states of this recommendation. If it's null then it should be considered "Active". |
|
start_time
|
The beginning time in UTC of a range that the recommendation refers to. |
|
end_time
|
The end time in UTC of a range that the recommendation refers to. |
|
next_notification_time
|
When to notify this recommendation next in UTC. Null means that this will never be notified anymore. |
|
notification_expiration_time
|
Date and time in UTC when this notification expires. |
|
notified_time
|
Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. |
|
score
|
A metric value measured by the rule. |
|
is_dynamic
|
True if this is associated with a dynamically added rule. |
|
extension_name
|
Extension name of the portal if exists. |
|
blade_name
|
Deep link to a blade on the portal. |
|
forward_link
|
Forward link to an external document associated with the rule. |
Attributes
action_name
Name of action recommended by this object.
action_name: str | None
blade_name
Deep link to a blade on the portal.
blade_name: str | None
category_tags
The list of category tags that this recommendation belongs to.
category_tags: list[str] | None
channels
"Notification", "Api", "Email", "Webhook", and "All".
channels: str | _models.Channels | None
creation_time
Timestamp when this instance was created.
creation_time: datetime | None
display_name
UI friendly name of the rule (may not be unique).
display_name: str | None
enabled
True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
enabled: int | None
end_time
The end time in UTC of a range that the recommendation refers to.
end_time: datetime | None
extension_name
Extension name of the portal if exists.
extension_name: str | None
forward_link
Forward link to an external document associated with the rule.
forward_link: str | None
is_dynamic
True if this is associated with a dynamically added rule.
is_dynamic: bool | None
level
"Critical", "Warning", "Information", and "NonUrgentSuggestion".
level: str | _models.NotificationLevel | None
message
Recommendation text.
message: str | None
next_notification_time
When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
next_notification_time: datetime | None
notification_expiration_time
Date and time in UTC when this notification expires.
notification_expiration_time: datetime | None
notified_time
Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.
notified_time: datetime | None
recommendation_id
A GUID value that each recommendation object is associated with.
recommendation_id: str | None
resource_id
Full ARM resource ID string that this recommendation object is associated with.
resource_id: str | None
resource_scope
Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Known values are: "ServerFarm", "Subscription", and "WebSite".
resource_scope: str | _models.ResourceScopeType | None
rule_name
Unique name of the rule.
rule_name: str | None
score
A metric value measured by the rule.
score: float | None
start_time
The beginning time in UTC of a range that the recommendation refers to.
start_time: datetime | None
states
The list of states of this recommendation. If it's null then it should be considered "Active".
states: list[str] | None