IncidentCommentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SecurityInsights's

<xref:incident_comments> attribute.

Constructor

IncidentCommentsOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a comment for a given incident.
delete	Deletes a comment for a given incident.
get	Gets a comment for a given incident.
list	Gets all comments for a given incident.

create_or_update

Creates or updates a comment for a given incident.

create_or_update(resource_group_name: str, workspace_name: str, incident_id: str, incident_comment_id: str, incident_comment: IncidentComment, **kwargs: Any) -> IncidentComment

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
incident_id Required	str Incident ID.
incident_comment_id Required	str Incident comment ID.
incident_comment Required	IncidentComment The incident comment.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
IncidentComment	IncidentComment, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a comment for a given incident.

delete(resource_group_name: str, workspace_name: str, incident_id: str, incident_comment_id: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
incident_id Required	str Incident ID.
incident_comment_id Required	str Incident comment ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a comment for a given incident.

get(resource_group_name: str, workspace_name: str, incident_id: str, incident_comment_id: str, **kwargs: Any) -> IncidentComment

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
incident_id Required	str Incident ID.
incident_comment_id Required	str Incident comment ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
IncidentComment	IncidentComment, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all comments for a given incident.

list(resource_group_name: str, workspace_name: str, incident_id: str, filter: str | None = None, orderby: str | None = None, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> Iterable[IncidentCommentList]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
incident_id Required	str Incident ID.
filter	str Filters the results, based on a Boolean condition. Optional. Default value is None. Default value: None
orderby	str Sorts the results. Optional. Default value is None. Default value: None
top	int Returns only the first n results. Optional. Default value is None. Default value: None
skip_token	str Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[IncidentCommentList]	An iterator like instance of either IncidentCommentList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.securityinsight.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv218\\Lib\\site-packages\\azure\\mgmt\\securityinsight\\models\\__init__.py'>