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.

Inheritance

azure.mgmt.web.v2021_02_01.models._models_py3.ProxyOnlyResource

Recommendation

Constructor

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

Parameters

kind

str

Required

Kind of resource.

creation_time

datetime

Required

Timestamp when this instance was created.

recommendation_id

str

Required

A GUID value that each recommendation object is associated with.

resource_id

str

Required

Full ARM resource ID string that this recommendation object is associated with.

resource_scope

str or ResourceScopeType

Required

Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Possible values include: "ServerFarm", "Subscription", "WebSite".

rule_name

str

Required

Unique name of the rule.

display_name

str

Required

UI friendly name of the rule (may not be unique).

message

str

Required

Recommendation text.

level

str or NotificationLevel

Required

Level indicating how critical this recommendation can impact. Possible values include: "Critical", "Warning", "Information", "NonUrgentSuggestion".

channels

str or Channels

Required

List of channels that this recommendation can apply. Possible values include: "Notification", "Api", "Email", "Webhook", "All".

action_name

str

Required

Name of action recommended by this object.

enabled

int

Required

True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.

states

list[str]

Required

The list of states of this recommendation. If it's null then it should be considered "Active".

start_time

datetime

Required

The beginning time in UTC of a range that the recommendation refers to.

end_time

datetime

Required

The end time in UTC of a range that the recommendation refers to.

next_notification_time

datetime

Required

When to notify this recommendation next in UTC. Null means that this will never be notified anymore.

notification_expiration_time

datetime

Required

Date and time in UTC when this notification expires.

notified_time

datetime

Required

Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.

score

float

Required

A metric value measured by the rule.

is_dynamic

bool

Required

True if this is associated with a dynamically added rule.

extension_name

str

Required

Extension name of the portal if exists.

blade_name

str

Required

Deep link to a blade on the portal.

forward_link

str

Required

Forward link to an external document associated with the rule.

Variables

id

str

Resource Id.

name

str

Resource Name.

type

str

Resource type.

category_tags

list[str]

The list of category tags that this recommendation belongs to.