Recommendation Class

Represents a recommendation result generated by the recommendation engine.

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

Constructor

Recommendation(*, kind: str | None = None, creation_time: datetime | None = None, recommendation_id: str | None = None, resource_id: str | None = None, resource_scope: str | _models.ResourceScopeType | None = None, rule_name: str | None = None, display_name: str | None = None, message: str | None = None, level: str | _models.NotificationLevel | None = None, channels: str | _models.Channels | None = None, action_name: str | None = None, enabled: int | None = None, states: List[str] | None = None, start_time: datetime | None = None, end_time: datetime | None = None, next_notification_time: datetime | None = None, notification_expiration_time: datetime | None = None, notified_time: datetime | None = None, score: float | None = None, is_dynamic: bool | None = None, extension_name: str | None = None, blade_name: str | None = None, forward_link: str | None = None, **kwargs: Any)

Keyword-Only Parameters

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

Variables

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