azure.mgmt.securityinsight.operations.IncidentsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.securityinsight.operations.IncidentsOperations
name: IncidentsOperations
fullName: azure.mgmt.securityinsight.operations.IncidentsOperations
module: azure.mgmt.securityinsight.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.securityinsight.SecurityInsights>'s\n\
  >\n> <xref:incidents> attribute.\n>"
constructor:
  syntax: IncidentsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates the incident.
  signature: 'create_or_update(resource_group_name: str, workspace_name: str, incident_id:
    str, incident: _models.Incident, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.Incident'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident
    description: The incident. Is either a model type or a IO type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.securityinsight.models.Incident>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Incident or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.Incident>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.create_team
  name: create_team
  summary: 'Creates a Microsoft team to investigate the incident by sharing information
    and insights

    between participants.'
  signature: 'create_team(resource_group_name: str, workspace_name: str, incident_id:
    str, team_properties: _models.TeamInformation, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.TeamInformation'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: team_properties
    description: Team properties. Is either a model type or a IO type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.securityinsight.models.TeamInformation>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: TeamInformation or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.TeamInformation>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.delete
  name: delete
  summary: Delete the incident.
  signature: 'delete(resource_group_name: str, workspace_name: str, incident_id: str,
    **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.get
  name: get
  summary: Gets an incident.
  signature: 'get(resource_group_name: str, workspace_name: str, incident_id: str,
    **kwargs: Any) -> Incident'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Incident or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.Incident>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.list
  name: list
  summary: Gets all incidents.
  signature: 'list(resource_group_name: str, workspace_name: str, filter: str | None
    = None, orderby: str | None = None, top: int | None = None, skip_token: str |
    None = None, **kwargs: Any) -> Iterable[Incident]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'Filters the results, based on a Boolean condition. Optional. Default
      value is

      None.'
    isRequired: true
    types:
    - <xref:str>
  - name: orderby
    description: Sorts the results. Optional. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: Returns only the first n results. Optional. Default value is None.
    isRequired: true
    types:
    - <xref:int>
  - name: skip_token
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either Incident or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.securityinsight.models.Incident>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.list_alerts
  name: list_alerts
  summary: Gets all incident alerts.
  signature: 'list_alerts(resource_group_name: str, workspace_name: str, incident_id:
    str, **kwargs: Any) -> IncidentAlertList'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IncidentAlertList or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.IncidentAlertList>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.list_bookmarks
  name: list_bookmarks
  summary: Gets all incident bookmarks.
  signature: 'list_bookmarks(resource_group_name: str, workspace_name: str, incident_id:
    str, **kwargs: Any) -> IncidentBookmarkList'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IncidentBookmarkList or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.IncidentBookmarkList>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.list_entities
  name: list_entities
  summary: Gets all incident related entities.
  signature: 'list_entities(resource_group_name: str, workspace_name: str, incident_id:
    str, **kwargs: Any) -> IncidentEntitiesResponse'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_id
    description: Incident ID. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IncidentEntitiesResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.IncidentEntitiesResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.run_playbook
  name: run_playbook
  summary: Triggers playbook on a specific incident.
  signature: 'run_playbook(resource_group_name: str, workspace_name: str, incident_identifier:
    str, request_body: _models.ManualTriggerRequestBody | None = None, *, content_type:
    str = ''application/json'', **kwargs: Any) -> JSON'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: workspace_name
    description: The name of the workspace. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: incident_identifier
    description: Required.
    isRequired: true
    types:
    - <xref:str>
  - name: request_body
    description: Is either a model type or a IO type. Default value is None.
    isRequired: true
    types:
    - <xref:azure.mgmt.securityinsight.models.ManualTriggerRequestBody>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: JSON or the result of cls(response)
    types:
    - <xref:azure.mgmt.securityinsight.models.FileFormat.JSON>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.securityinsight.operations.IncidentsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.securityinsight.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\securityinsight\\models\\__init__.py'>