Incidents interface
Interface representing a Incidents.
Methods
| create |
Creates or updates the incident. |
| create |
Creates a Microsoft team to investigate the incident by sharing information and insights between participants. |
| delete(string, string, string, Incidents |
Delete the incident. |
| get(string, string, string, Incidents |
Gets an incident. |
| list(string, string, Incidents |
Gets all incidents. |
| list |
Gets all incident alerts. |
| list |
Gets all incident bookmarks. |
| list |
Gets all incident related entities. |
| run |
Triggers playbook on a specific incident |
Method Details
createOrUpdate(string, string, string, Incident, IncidentsCreateOrUpdateOptionalParams)
Creates or updates the incident.
function createOrUpdate(resourceGroupName: string, workspaceName: string, incidentId: string, incident: Incident, options?: IncidentsCreateOrUpdateOptionalParams): Promise<Incident>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
- incident
- Incident
The incident
The options parameters.
Returns
Promise<Incident>
createTeam(string, string, string, TeamProperties, IncidentsCreateTeamOptionalParams)
Creates a Microsoft team to investigate the incident by sharing information and insights between participants.
function createTeam(resourceGroupName: string, workspaceName: string, incidentId: string, teamProperties: TeamProperties, options?: IncidentsCreateTeamOptionalParams): Promise<TeamInformation>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
- teamProperties
- TeamProperties
Team properties
The options parameters.
Returns
Promise<TeamInformation>
delete(string, string, string, IncidentsDeleteOptionalParams)
Delete the incident.
function delete(resourceGroupName: string, workspaceName: string, incidentId: string, options?: IncidentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
- options
- IncidentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, IncidentsGetOptionalParams)
Gets an incident.
function get(resourceGroupName: string, workspaceName: string, incidentId: string, options?: IncidentsGetOptionalParams): Promise<Incident>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
- options
- IncidentsGetOptionalParams
The options parameters.
Returns
Promise<Incident>
list(string, string, IncidentsListOptionalParams)
Gets all incidents.
function list(resourceGroupName: string, workspaceName: string, options?: IncidentsListOptionalParams): PagedAsyncIterableIterator<Incident, Incident[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- IncidentsListOptionalParams
The options parameters.
Returns
listAlerts(string, string, string, IncidentsListAlertsOptionalParams)
Gets all incident alerts.
function listAlerts(resourceGroupName: string, workspaceName: string, incidentId: string, options?: IncidentsListAlertsOptionalParams): Promise<IncidentAlertList>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
The options parameters.
Returns
Promise<IncidentAlertList>
listBookmarks(string, string, string, IncidentsListBookmarksOptionalParams)
Gets all incident bookmarks.
function listBookmarks(resourceGroupName: string, workspaceName: string, incidentId: string, options?: IncidentsListBookmarksOptionalParams): Promise<IncidentBookmarkList>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
The options parameters.
Returns
Promise<IncidentBookmarkList>
listEntities(string, string, string, IncidentsListEntitiesOptionalParams)
Gets all incident related entities.
function listEntities(resourceGroupName: string, workspaceName: string, incidentId: string, options?: IncidentsListEntitiesOptionalParams): Promise<IncidentEntitiesResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentId
-
string
Incident ID
The options parameters.
Returns
Promise<IncidentEntitiesResponse>
runPlaybook(string, string, string, IncidentsRunPlaybookOptionalParams)
Triggers playbook on a specific incident
function runPlaybook(resourceGroupName: string, workspaceName: string, incidentIdentifier: string, options?: IncidentsRunPlaybookOptionalParams): Promise<IncidentsRunPlaybookResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- incidentIdentifier
-
string
The options parameters.
Returns
Promise<IncidentsRunPlaybookResponse>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for