Microsoft.AlertsManagement (preview:2025-03-01)

2025/04/28 • 11 new methods

Issue_List (new)
Description :  List all issues under the parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IssueResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_Get (new)
Description :  Get issue properties
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_Create (new)
Description :  Create a new issue or updates an existing one
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_Update (new)
Description :  Update an issue
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: False ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: False ,
}
string ,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
title:
{
Description: The issue title ,
Required: True ,
}
string ,
status:
{
Description: The issue status ,
Enum:
{
New: The issue is new ,
InProgress: The issue is in progress ,
Mitigated: The issue is mitigated ,
Closed: The issue is closed ,
Canceled: The issue is canceled ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The issue severity ,
Required: True ,
}
string ,
investigations:
{
Description: The list of investigations in the issue ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
impactTime:
{
Description: The issue impact time (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
investigationsCount:
{
Description: The number of investigations in the issue ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_Delete (new)
Description :  Delete an issue
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_AddOrUpdateAlerts (new)
Description :  Add or update alerts in the issue
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/addOrUpdateAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
value:
{
Description: A list of related alerts ,
Required: True ,
}
[
{
id:
{
Description: The alert ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The alerts's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the alert to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: A list of related alerts ,
Required: True ,
}
[
{
id:
{
Description: The alert ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The alerts's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the alert to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_AddOrUpdateResources (new)
Description :  Add or update resources in the issue
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/addOrUpdateResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
value:
{
Description: A list of related resources ,
Required: True ,
}
[
{
id:
{
Description: The resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The resource's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the resource to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: A list of related resources ,
Required: True ,
}
[
{
id:
{
Description: The resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The resource's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the resource to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_FetchInvestigationResult (new)
Description :  Fetch investigation results
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/fetchInvestigationResult
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
investigationId:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier of the investigation ,
Required: True ,
}
string ,
entityType:
{
Description: The type of the investigation ,
Enum:
{
Investigation: Investigation entity ,
Finding: Finding entity ,
Evidence: Evidence entity ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The origin of the investigation ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
runParameters:
{
Description: The parameters used to run the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
children:
{
Description: The children of this investigation, findings and evidences ,
Required: True ,
}
[
{
id:
{
Description: The identifier of the entity ,
Required: True ,
}
string ,
entityType:
{
Description: The type of the entity ,
Enum:
{
Investigation: Investigation entity ,
Finding: Finding entity ,
Evidence: Evidence entity ,
}
,
Required: True ,
}
enum ,
relevance:
{
Description: The relevance of the entity ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: The health state of the entity ,
Enum:
{
Unknown: The health state of the result is unknown ,
Healthy: The result is healthy ,
Unhealthy: The result is unhealthy ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The origin of the entity ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
createdAt:
{
Description: The creation time of the entity (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of the entity (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the entity ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
summary:
{
Description: The summary of the entity ,
Required: False ,
}
{
title:
{
Description: The title of the entity ,
Required: True ,
}
string ,
whatHappened:
{
Description: Description of what happened ,
Required: True ,
}
string ,
possibleExplanation:
{
Description: Possible explanation of the entity ,
Required: True ,
}
string ,
whatCanBeDoneNext:
{
Description: Suggestions for next steps ,
Required: True ,
}
string ,
}
,
details:
{
Description: The details of the entity ,
Required: False ,
}
{
detailsType:
{
Description: The type of details ,
Enum:
{
Investigation: The details is for an investigation ,
Finding: The details is for a finding ,
AzureMetric: The details is for an azure metric ,
AbnormalEvent: The details is for a abnormal event ,
RelatedAlert: The details is for a related alert ,
ResourceHealth: The details is for resource health ,
Diagnostics: The details for diagnostics ,
}
,
Required: True ,
}
enum ,
category:
{
Description: The details category ,
Enum:
{
Investigation: The category is for an investigation ,
Metric: The category is for a metric ,
Log: The category is for a log ,
Alert: The category is for an alert ,
ResourceHealth: The category is for resource health ,
Diagnostics: The category is for diagnostics ,
}
,
Required: True ,
}
enum ,
resourceIds:
{
Description: The resource ids related to the anomaly ,
Required: False ,
}
[
string ,
]
,
}
,
children:
{
Description: The children of this investigation entity ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_ListAlerts (new)
Description :  List all alerts in the issue - this method uses pagination to return all alerts
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/listAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
filter:
{
Description: The filter to apply on the operation. For example, to filter by relevance, use "$filter=relevance eq 'Relevant'" ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The RelatedAlert items on this page ,
Required: True ,
}
[
{
id:
{
Description: The alert ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The alerts's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the alert to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_ListResources (new)
Description :  List all resources in the issue - this method uses pagination to return all resources
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/listResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
filter:
{
Description: The filter to apply on the operation. For example, to filter by relevance, use "$filter=relevance eq 'Relevant'" ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The RelatedResource items on this page ,
Required: True ,
}
[
{
id:
{
Description: The resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
relevance:
{
Description: The resource's relevance status ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: True ,
}
enum ,
origin:
{
Description: The source that related the resource to the issue ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
addedAt:
{
Description: The time this relation was added to the issue (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The last update time of this relation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_StartInvestigation (new)
Description :  Start a new investigation
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AlertsManagement/issues/{issueName}/startInvestigation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to use for this investigation - by default, the impact time from the issue is used (in UTC) ,
Format: date-time ,
Required: False ,
}
string ,
investigationScopes:
{
Description: The scope of the investigation (resources and alerts) - by default, the resources and alerts related to the issue are used ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of the investigation ,
Format: uuid ,
Required: True ,
}
string ,
execution:
{
Description: The execution details of the investigation ,
Required: True ,
}
{
runState:
{
Description: The state of the investigation execution ,
Enum:
{
None: The investigation execution didn't start ,
InProgress: The investigation execution is in progress ,
Succeeded: The investigation execution completed successfully ,
Failed: The investigation execution failed ,
Canceled: The investigation execution was canceled ,
}
,
Required: True ,
}
enum ,
completedAt:
{
Description: The time at which the investigation execution completed (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: The creation time of the investigation (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
runParameters:
{
Description: The parameters that were used to start the investigation ,
Required: True ,
}
{
impactTime:
{
Description: The impact time to investigate (in UTC) ,
Format: date-time ,
Required: True ,
}
string ,
alerts:
{
Description: The alerts used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resources:
{
Description: The resources used to run the investigation ,
Required: True ,
}
[
{
id:
{
Description: The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
origin:
{
Description: The origin of the scope ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system ,
Required: True ,
}
string ,
addedByType:
{
Description: The source of the origin - Manual or Automatic ,
Enum:
{
Manual: The data was added manually by a user ,
Automatic: The data was added automatically ,
}
,
Required: True ,
}
enum ,
}
,
relevance:
{
Description: The relevance of the scope ,
Enum:
{
None: No relevance status for the resource ,
Relevant: The resource is relevant to the issue ,
Irrelevant: The resource is irrelevant to the issue ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}