Microsoft.Monitor (preview:2025-05-03)

2025/10/02 • 36 new, 3 updated, 11 deleted methods

HealthModels_ListByParentResource (new)
Description :  List HealthModel resources by AzureMonitorWorkspaceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HealthModel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
HealthModels_Get (new)
Description :  Get a HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
HealthModels_Create (new)
Description :  Create a HealthModel
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A HealthModel resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
HealthModels_Update (new)
Description :  Update a HealthModel
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
queryEndpoint:
{
Description: The data plane endpoint for querying health data ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
discovery:
{
Description: Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. ,
Required: False ,
}
{
scope:
{
Description: The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. ,
Required: True ,
}
string ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
HealthModels_Delete (new)
Description :  Delete a HealthModel
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
AuthenticationSettings_ListByHealthModel (new)
Description :  List AuthenticationSetting resources by HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/authenticationsettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthenticationSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
authenticationKind:
{
Description: Kind of the authentication setting ,
Enum:
{
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
AuthenticationSettings_Get (new)
Description :  Get a AuthenticationSetting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/authenticationsettings/{authenticationSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
authenticationSettingName:
{
Description: Name of the authentication setting. Must be unique within a health model. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
authenticationKind:
{
Description: Kind of the authentication setting ,
Enum:
{
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
AuthenticationSettings_CreateOrUpdate (new)
Description :  Create a AuthenticationSetting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/authenticationsettings/{authenticationSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
authenticationSettingName:
{
Description: Name of the authentication setting. Must be unique within a health model. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
authenticationKind:
{
Description: Kind of the authentication setting ,
Enum:
{
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
authenticationKind:
{
Description: Kind of the authentication setting ,
Enum:
{
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
authenticationKind:
{
Description: Kind of the authentication setting ,
Enum:
{
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
AuthenticationSettings_Delete (new)
Description :  Delete a AuthenticationSetting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/authenticationsettings/{authenticationSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
authenticationSettingName:
{
Description: Name of the authentication setting. Must be unique within a health model. ,
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 ,
}
,
]
,
}
,
}
DiscoveryRules_ListByHealthModel (new)
Description :  List DiscoveryRule resources by HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/discoveryrules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
timestamp:
{
Description: Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used. ,
Format: date-time ,
Required: False ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DiscoveryRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
discoveryRuleKind:
{
Description: Kind of the discovery rule ,
Enum:
{
ResourceGraphQuery: No description available. ,
ApplicationInsightsTopology: No description available. ,
}
,
Required: True ,
}
enum ,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. ,
Required: True ,
}
string ,
discoverRelationships:
{
Description: Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. ,
Enum:
{
Enabled: Automatically attempt to discover relationships ,
Disabled: Do not automatically attempt to discover relationships ,
}
,
Required: True ,
}
enum ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
deletionDate:
{
Description: Date when the discovery rule was (soft-)deleted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error details if the last discovery operation failed. ,
Required: False ,
}
{
message:
{
Description: Error message ,
Required: True ,
}
string ,
context:
{
Description: Additional context information, like resource IDs or query details ,
Required: False ,
}
[
string ,
]
,
}
,
entityName:
{
Description: Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. ,
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 ,
}
,
]
,
}
,
}
DiscoveryRules_Get (new)
Description :  Get a DiscoveryRule
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/discoveryrules/{discoveryRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
discoveryRuleName:
{
Description: Name of the discovery rule. Must be unique within a health model. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
discoveryRuleKind:
{
Description: Kind of the discovery rule ,
Enum:
{
ResourceGraphQuery: No description available. ,
ApplicationInsightsTopology: No description available. ,
}
,
Required: True ,
}
enum ,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. ,
Required: True ,
}
string ,
discoverRelationships:
{
Description: Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. ,
Enum:
{
Enabled: Automatically attempt to discover relationships ,
Disabled: Do not automatically attempt to discover relationships ,
}
,
Required: True ,
}
enum ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
deletionDate:
{
Description: Date when the discovery rule was (soft-)deleted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error details if the last discovery operation failed. ,
Required: False ,
}
{
message:
{
Description: Error message ,
Required: True ,
}
string ,
context:
{
Description: Additional context information, like resource IDs or query details ,
Required: False ,
}
[
string ,
]
,
}
,
entityName:
{
Description: Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. ,
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 ,
}
,
]
,
}
,
}
DiscoveryRules_CreateOrUpdate (new)
Description :  Create a DiscoveryRule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/discoveryrules/{discoveryRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
discoveryRuleName:
{
Description: Name of the discovery rule. Must be unique within a health model. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
discoveryRuleKind:
{
Description: Kind of the discovery rule ,
Enum:
{
ResourceGraphQuery: No description available. ,
ApplicationInsightsTopology: No description available. ,
}
,
Required: True ,
}
enum ,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. ,
Required: True ,
}
string ,
discoverRelationships:
{
Description: Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. ,
Enum:
{
Enabled: Automatically attempt to discover relationships ,
Disabled: Do not automatically attempt to discover relationships ,
}
,
Required: True ,
}
enum ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
deletionDate:
{
Description: Date when the discovery rule was (soft-)deleted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error details if the last discovery operation failed. ,
Required: False ,
}
{
message:
{
Description: Error message ,
Required: True ,
}
string ,
context:
{
Description: Additional context information, like resource IDs or query details ,
Required: False ,
}
[
string ,
]
,
}
,
entityName:
{
Description: Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
discoveryRuleKind:
{
Description: Kind of the discovery rule ,
Enum:
{
ResourceGraphQuery: No description available. ,
ApplicationInsightsTopology: No description available. ,
}
,
Required: True ,
}
enum ,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. ,
Required: True ,
}
string ,
discoverRelationships:
{
Description: Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. ,
Enum:
{
Enabled: Automatically attempt to discover relationships ,
Disabled: Do not automatically attempt to discover relationships ,
}
,
Required: True ,
}
enum ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
deletionDate:
{
Description: Date when the discovery rule was (soft-)deleted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error details if the last discovery operation failed. ,
Required: False ,
}
{
message:
{
Description: Error message ,
Required: True ,
}
string ,
context:
{
Description: Additional context information, like resource IDs or query details ,
Required: False ,
}
[
string ,
]
,
}
,
entityName:
{
Description: Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
discoveryRuleKind:
{
Description: Kind of the discovery rule ,
Enum:
{
ResourceGraphQuery: No description available. ,
ApplicationInsightsTopology: No description available. ,
}
,
Required: True ,
}
enum ,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. ,
Required: True ,
}
string ,
discoverRelationships:
{
Description: Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. ,
Enum:
{
Enabled: Automatically attempt to discover relationships ,
Disabled: Do not automatically attempt to discover relationships ,
}
,
Required: True ,
}
enum ,
addRecommendedSignals:
{
Description: Whether to add all recommended signals to the discovered entities. ,
Enum:
{
Enabled: Automatically add recommended signals ,
Disabled: Do not automatically add recommended signals ,
}
,
Required: True ,
}
enum ,
deletionDate:
{
Description: Date when the discovery rule was (soft-)deleted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error details if the last discovery operation failed. ,
Required: False ,
}
{
message:
{
Description: Error message ,
Required: True ,
}
string ,
context:
{
Description: Additional context information, like resource IDs or query details ,
Required: False ,
}
[
string ,
]
,
}
,
entityName:
{
Description: Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. ,
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 ,
}
,
]
,
}
,
}
DiscoveryRules_Delete (new)
Description :  Delete a DiscoveryRule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/discoveryrules/{discoveryRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
discoveryRuleName:
{
Description: Name of the discovery rule. Must be unique within a health model. ,
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 ,
}
,
]
,
}
,
}
Entities_ListByHealthModel (new)
Description :  List Entity resources by HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/entities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
timestamp:
{
Description: Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used. ,
Format: date-time ,
Required: False ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Entity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
kind:
{
Description: Entity kind ,
Required: False ,
}
string ,
canvasPosition:
{
Description: Positioning of the entity on the model canvas ,
Required: False ,
}
{
x:
{
Description: X Coordinate ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Y Coordinate ,
Format: float ,
Required: True ,
}
number ,
}
,
icon:
{
Description: Visual icon definition. If not set, a default icon is used. ,
Required: False ,
}
{
iconName:
{
Description: Name of the built-in icon, or 'Custom' to use customData ,
Required: True ,
}
string ,
customData:
{
Description: Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. ,
Required: False ,
}
string ,
}
,
healthObjective:
{
Description: Health objective as a percentage of time the entity should be healthy. ,
Format: float ,
Required: False ,
}
number ,
impact:
{
Description: Impact of the entity in health state propagation ,
Enum:
{
Standard: Standard impact ,
Limited: Limited impact ,
Suppressed: Suppressed impact ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
signals:
{
Description: Signal groups which are assigned to this entity ,
Required: False ,
}
{
azureResource:
{
Description: Azure Resource Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureResourceId:
{
Description: Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureLogAnalytics:
{
Description: Log Analytics Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
logAnalyticsWorkspaceResourceId:
{
Description: Log Analytics Workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureMonitorWorkspace:
{
Description: Azure Monitor Workspace Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureMonitorWorkspaceResourceId:
{
Description: Azure Monitor workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
dependencies:
{
Description: Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. ,
Required: False ,
}
{
aggregationType:
{
Description: Aggregation type for child dependencies. ,
Enum:
{
WorstOf: Default behavior: Worst child health state is propagated. ,
Thresholds: Based on configurable thresholds. ,
}
,
Required: True ,
}
enum ,
degradedThreshold:
{
Description: Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
unhealthyThreshold:
{
Description: Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
}
,
}
,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the entity cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the entity was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of this entity ,
Enum:
{
Healthy: Healthy status ,
Degraded: Degraded status ,
Error: Error status (Unhealthy) ,
Unknown: Unknown status ,
Deleted: Deleted status ,
}
,
Required: False ,
}
enum ,
alerts:
{
Description: Alert configuration for this entity ,
Required: False ,
}
{
unhealthy:
{
Description: Alert to be triggered on state change to unhealthy ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
degraded:
{
Description: Alert to be triggered on state change to degraded ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
Entities_Get (new)
Description :  Get a Entity
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/entities/{entityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the entity. Must be unique within a health model. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
kind:
{
Description: Entity kind ,
Required: False ,
}
string ,
canvasPosition:
{
Description: Positioning of the entity on the model canvas ,
Required: False ,
}
{
x:
{
Description: X Coordinate ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Y Coordinate ,
Format: float ,
Required: True ,
}
number ,
}
,
icon:
{
Description: Visual icon definition. If not set, a default icon is used. ,
Required: False ,
}
{
iconName:
{
Description: Name of the built-in icon, or 'Custom' to use customData ,
Required: True ,
}
string ,
customData:
{
Description: Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. ,
Required: False ,
}
string ,
}
,
healthObjective:
{
Description: Health objective as a percentage of time the entity should be healthy. ,
Format: float ,
Required: False ,
}
number ,
impact:
{
Description: Impact of the entity in health state propagation ,
Enum:
{
Standard: Standard impact ,
Limited: Limited impact ,
Suppressed: Suppressed impact ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
signals:
{
Description: Signal groups which are assigned to this entity ,
Required: False ,
}
{
azureResource:
{
Description: Azure Resource Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureResourceId:
{
Description: Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureLogAnalytics:
{
Description: Log Analytics Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
logAnalyticsWorkspaceResourceId:
{
Description: Log Analytics Workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureMonitorWorkspace:
{
Description: Azure Monitor Workspace Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureMonitorWorkspaceResourceId:
{
Description: Azure Monitor workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
dependencies:
{
Description: Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. ,
Required: False ,
}
{
aggregationType:
{
Description: Aggregation type for child dependencies. ,
Enum:
{
WorstOf: Default behavior: Worst child health state is propagated. ,
Thresholds: Based on configurable thresholds. ,
}
,
Required: True ,
}
enum ,
degradedThreshold:
{
Description: Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
unhealthyThreshold:
{
Description: Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
}
,
}
,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the entity cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the entity was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of this entity ,
Enum:
{
Healthy: Healthy status ,
Degraded: Degraded status ,
Error: Error status (Unhealthy) ,
Unknown: Unknown status ,
Deleted: Deleted status ,
}
,
Required: False ,
}
enum ,
alerts:
{
Description: Alert configuration for this entity ,
Required: False ,
}
{
unhealthy:
{
Description: Alert to be triggered on state change to unhealthy ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
degraded:
{
Description: Alert to be triggered on state change to degraded ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
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 ,
}
,
]
,
}
,
}
Entities_CreateOrUpdate (new)
Description :  Create a Entity
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/entities/{entityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the entity. Must be unique within a health model. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
kind:
{
Description: Entity kind ,
Required: False ,
}
string ,
canvasPosition:
{
Description: Positioning of the entity on the model canvas ,
Required: False ,
}
{
x:
{
Description: X Coordinate ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Y Coordinate ,
Format: float ,
Required: True ,
}
number ,
}
,
icon:
{
Description: Visual icon definition. If not set, a default icon is used. ,
Required: False ,
}
{
iconName:
{
Description: Name of the built-in icon, or 'Custom' to use customData ,
Required: True ,
}
string ,
customData:
{
Description: Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. ,
Required: False ,
}
string ,
}
,
healthObjective:
{
Description: Health objective as a percentage of time the entity should be healthy. ,
Format: float ,
Required: False ,
}
number ,
impact:
{
Description: Impact of the entity in health state propagation ,
Enum:
{
Standard: Standard impact ,
Limited: Limited impact ,
Suppressed: Suppressed impact ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
signals:
{
Description: Signal groups which are assigned to this entity ,
Required: False ,
}
{
azureResource:
{
Description: Azure Resource Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureResourceId:
{
Description: Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureLogAnalytics:
{
Description: Log Analytics Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
logAnalyticsWorkspaceResourceId:
{
Description: Log Analytics Workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureMonitorWorkspace:
{
Description: Azure Monitor Workspace Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureMonitorWorkspaceResourceId:
{
Description: Azure Monitor workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
dependencies:
{
Description: Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. ,
Required: False ,
}
{
aggregationType:
{
Description: Aggregation type for child dependencies. ,
Enum:
{
WorstOf: Default behavior: Worst child health state is propagated. ,
Thresholds: Based on configurable thresholds. ,
}
,
Required: True ,
}
enum ,
degradedThreshold:
{
Description: Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
unhealthyThreshold:
{
Description: Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
}
,
}
,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the entity cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the entity was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of this entity ,
Enum:
{
Healthy: Healthy status ,
Degraded: Degraded status ,
Error: Error status (Unhealthy) ,
Unknown: Unknown status ,
Deleted: Deleted status ,
}
,
Required: False ,
}
enum ,
alerts:
{
Description: Alert configuration for this entity ,
Required: False ,
}
{
unhealthy:
{
Description: Alert to be triggered on state change to unhealthy ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
degraded:
{
Description: Alert to be triggered on state change to degraded ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
kind:
{
Description: Entity kind ,
Required: False ,
}
string ,
canvasPosition:
{
Description: Positioning of the entity on the model canvas ,
Required: False ,
}
{
x:
{
Description: X Coordinate ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Y Coordinate ,
Format: float ,
Required: True ,
}
number ,
}
,
icon:
{
Description: Visual icon definition. If not set, a default icon is used. ,
Required: False ,
}
{
iconName:
{
Description: Name of the built-in icon, or 'Custom' to use customData ,
Required: True ,
}
string ,
customData:
{
Description: Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. ,
Required: False ,
}
string ,
}
,
healthObjective:
{
Description: Health objective as a percentage of time the entity should be healthy. ,
Format: float ,
Required: False ,
}
number ,
impact:
{
Description: Impact of the entity in health state propagation ,
Enum:
{
Standard: Standard impact ,
Limited: Limited impact ,
Suppressed: Suppressed impact ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
signals:
{
Description: Signal groups which are assigned to this entity ,
Required: False ,
}
{
azureResource:
{
Description: Azure Resource Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureResourceId:
{
Description: Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureLogAnalytics:
{
Description: Log Analytics Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
logAnalyticsWorkspaceResourceId:
{
Description: Log Analytics Workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureMonitorWorkspace:
{
Description: Azure Monitor Workspace Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureMonitorWorkspaceResourceId:
{
Description: Azure Monitor workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
dependencies:
{
Description: Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. ,
Required: False ,
}
{
aggregationType:
{
Description: Aggregation type for child dependencies. ,
Enum:
{
WorstOf: Default behavior: Worst child health state is propagated. ,
Thresholds: Based on configurable thresholds. ,
}
,
Required: True ,
}
enum ,
degradedThreshold:
{
Description: Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
unhealthyThreshold:
{
Description: Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
}
,
}
,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the entity cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the entity was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of this entity ,
Enum:
{
Healthy: Healthy status ,
Degraded: Degraded status ,
Error: Error status (Unhealthy) ,
Unknown: Unknown status ,
Deleted: Deleted status ,
}
,
Required: False ,
}
enum ,
alerts:
{
Description: Alert configuration for this entity ,
Required: False ,
}
{
unhealthy:
{
Description: Alert to be triggered on state change to unhealthy ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
degraded:
{
Description: Alert to be triggered on state change to degraded ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
kind:
{
Description: Entity kind ,
Required: False ,
}
string ,
canvasPosition:
{
Description: Positioning of the entity on the model canvas ,
Required: False ,
}
{
x:
{
Description: X Coordinate ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Y Coordinate ,
Format: float ,
Required: True ,
}
number ,
}
,
icon:
{
Description: Visual icon definition. If not set, a default icon is used. ,
Required: False ,
}
{
iconName:
{
Description: Name of the built-in icon, or 'Custom' to use customData ,
Required: True ,
}
string ,
customData:
{
Description: Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. ,
Required: False ,
}
string ,
}
,
healthObjective:
{
Description: Health objective as a percentage of time the entity should be healthy. ,
Format: float ,
Required: False ,
}
number ,
impact:
{
Description: Impact of the entity in health state propagation ,
Enum:
{
Standard: Standard impact ,
Limited: Limited impact ,
Suppressed: Suppressed impact ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
signals:
{
Description: Signal groups which are assigned to this entity ,
Required: False ,
}
{
azureResource:
{
Description: Azure Resource Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureResourceId:
{
Description: Azure resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureLogAnalytics:
{
Description: Log Analytics Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
logAnalyticsWorkspaceResourceId:
{
Description: Log Analytics Workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
azureMonitorWorkspace:
{
Description: Azure Monitor Workspace Signal Group ,
Required: False ,
}
{
signalAssignments:
{
Description: Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. ,
Required: False ,
}
[
{
signalDefinitions:
{
Description: Signal definitions referenced by their names. All definitions are combined with an AND operator. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
authenticationSetting:
{
Description: Reference to the name of the authentication setting which is used for querying the data source ,
Required: True ,
}
string ,
azureMonitorWorkspaceResourceId:
{
Description: Azure Monitor workspace resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
dependencies:
{
Description: Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. ,
Required: False ,
}
{
aggregationType:
{
Description: Aggregation type for child dependencies. ,
Enum:
{
WorstOf: Default behavior: Worst child health state is propagated. ,
Thresholds: Based on configurable thresholds. ,
}
,
Required: True ,
}
enum ,
degradedThreshold:
{
Description: Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
unhealthyThreshold:
{
Description: Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. ,
Required: False ,
}
string ,
}
,
}
,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the entity cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the entity was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of this entity ,
Enum:
{
Healthy: Healthy status ,
Degraded: Degraded status ,
Error: Error status (Unhealthy) ,
Unknown: Unknown status ,
Deleted: Deleted status ,
}
,
Required: False ,
}
enum ,
alerts:
{
Description: Alert configuration for this entity ,
Required: False ,
}
{
unhealthy:
{
Description: Alert to be triggered on state change to unhealthy ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
Required: False ,
}
[
string ,
]
,
}
,
degraded:
{
Description: Alert to be triggered on state change to degraded ,
Required: False ,
}
{
severity:
{
Description: The severity of triggered alert. ,
Enum:
{
Sev0: Critical ,
Sev1: Error ,
Sev2: Warning ,
Sev3: Informational ,
Sev4: Verbose ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: Optional list of action group resource IDs to be notified when the alert is triggered. ,
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 ,
}
,
]
,
}
,
}
Entities_Delete (new)
Description :  Delete a Entity
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/entities/{entityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the entity. Must be unique within a health model. ,
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 ,
}
,
]
,
}
,
}
Relationships_ListByHealthModel (new)
Description :  List Relationship resources by HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
timestamp:
{
Description: Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used. ,
Format: date-time ,
Required: False ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Relationship items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
parentEntityName:
{
Description: Resource name of the parent entity ,
Required: True ,
}
string ,
childEntityName:
{
Description: Resource name of the child entity ,
Required: True ,
}
string ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the relationship cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the relationship was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Relationships_Get (new)
Description :  Get a Relationship
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/relationships/{relationshipName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
relationshipName:
{
Description: Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
parentEntityName:
{
Description: Resource name of the parent entity ,
Required: True ,
}
string ,
childEntityName:
{
Description: Resource name of the child entity ,
Required: True ,
}
string ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the relationship cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the relationship was (soft-)deleted ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
Relationships_CreateOrUpdate (new)
Description :  Create a Relationship
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/relationships/{relationshipName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
relationshipName:
{
Description: Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
parentEntityName:
{
Description: Resource name of the parent entity ,
Required: True ,
}
string ,
childEntityName:
{
Description: Resource name of the child entity ,
Required: True ,
}
string ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the relationship cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the relationship was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
parentEntityName:
{
Description: Resource name of the parent entity ,
Required: True ,
}
string ,
childEntityName:
{
Description: Resource name of the child entity ,
Required: True ,
}
string ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the relationship cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the relationship was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
parentEntityName:
{
Description: Resource name of the parent entity ,
Required: True ,
}
string ,
childEntityName:
{
Description: Resource name of the child entity ,
Required: True ,
}
string ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
discoveredBy:
{
Description: Discovered by which discovery rule. If set, the relationship cannot be deleted manually. ,
Required: False ,
}
string ,
deletionDate:
{
Description: Date when the relationship was (soft-)deleted ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
Relationships_Delete (new)
Description :  Delete a Relationship
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/relationships/{relationshipName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
relationshipName:
{
Description: Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name. ,
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 ,
}
,
]
,
}
,
}
SignalDefinitions_ListByHealthModel (new)
Description :  List SignalDefinition resources by HealthModel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/signaldefinitions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
timestamp:
{
Description: Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used. ,
Format: date-time ,
Required: False ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SignalDefinition items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
signalKind:
{
Description: Kind of the signal definition ,
Enum:
{
AzureResourceMetric: No description available. ,
LogAnalyticsQuery: No description available. ,
PrometheusMetricsQuery: No description available. ,
}
,
Required: True ,
}
enum ,
refreshInterval:
{
Description: Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). ,
Enum:
{
PT1M: One Minute ,
PT5M: Five Minutes ,
PT10M: Ten Minutes ,
PT30M: Thirty Minutes ,
PT1H: One Hour ,
PT2H: Two Hours ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
dataUnit:
{
Description: Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) ,
Required: False ,
}
string ,
evaluationRules:
{
Description: Evaluation rules for the signal definition ,
Required: True ,
}
{
dynamicDetectionRule:
{
Description: Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. ,
Required: False ,
}
{
dynamicThresholdModel:
{
Description: ML model to use for dynamic thresholds ,
Enum:
{
AnomalyDetection: Anomaly detection model ,
}
,
Required: True ,
}
enum ,
modelSensitivity:
{
Description: ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 ,
Format: float ,
Required: True ,
}
number ,
dynamicThresholdDirection:
{
Description: Threshold direction ,
Enum:
{
LowerThan: Lower than ,
GreaterThan: Greater than ,
GreaterOrLowerThan: Greater or Lower Than ,
}
,
Required: True ,
}
enum ,
trainingStartTime:
{
Description: Start time of the training in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
degradedRule:
{
Description: Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
unhealthyRule:
{
Description: Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
}
,
deletionDate:
{
Description: Date when the signal definition was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
SignalDefinitions_Get (new)
Description :  Get a SignalDefinition
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/signaldefinitions/{signalDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
signalDefinitionName:
{
Description: Name of the signal definition. Must be unique within a health model. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
signalKind:
{
Description: Kind of the signal definition ,
Enum:
{
AzureResourceMetric: No description available. ,
LogAnalyticsQuery: No description available. ,
PrometheusMetricsQuery: No description available. ,
}
,
Required: True ,
}
enum ,
refreshInterval:
{
Description: Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). ,
Enum:
{
PT1M: One Minute ,
PT5M: Five Minutes ,
PT10M: Ten Minutes ,
PT30M: Thirty Minutes ,
PT1H: One Hour ,
PT2H: Two Hours ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
dataUnit:
{
Description: Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) ,
Required: False ,
}
string ,
evaluationRules:
{
Description: Evaluation rules for the signal definition ,
Required: True ,
}
{
dynamicDetectionRule:
{
Description: Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. ,
Required: False ,
}
{
dynamicThresholdModel:
{
Description: ML model to use for dynamic thresholds ,
Enum:
{
AnomalyDetection: Anomaly detection model ,
}
,
Required: True ,
}
enum ,
modelSensitivity:
{
Description: ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 ,
Format: float ,
Required: True ,
}
number ,
dynamicThresholdDirection:
{
Description: Threshold direction ,
Enum:
{
LowerThan: Lower than ,
GreaterThan: Greater than ,
GreaterOrLowerThan: Greater or Lower Than ,
}
,
Required: True ,
}
enum ,
trainingStartTime:
{
Description: Start time of the training in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
degradedRule:
{
Description: Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
unhealthyRule:
{
Description: Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
}
,
deletionDate:
{
Description: Date when the signal definition was (soft-)deleted ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
SignalDefinitions_CreateOrUpdate (new)
Description :  Create a SignalDefinition
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/signaldefinitions/{signalDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
signalDefinitionName:
{
Description: Name of the signal definition. Must be unique within a health model. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
signalKind:
{
Description: Kind of the signal definition ,
Enum:
{
AzureResourceMetric: No description available. ,
LogAnalyticsQuery: No description available. ,
PrometheusMetricsQuery: No description available. ,
}
,
Required: True ,
}
enum ,
refreshInterval:
{
Description: Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). ,
Enum:
{
PT1M: One Minute ,
PT5M: Five Minutes ,
PT10M: Ten Minutes ,
PT30M: Thirty Minutes ,
PT1H: One Hour ,
PT2H: Two Hours ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
dataUnit:
{
Description: Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) ,
Required: False ,
}
string ,
evaluationRules:
{
Description: Evaluation rules for the signal definition ,
Required: True ,
}
{
dynamicDetectionRule:
{
Description: Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. ,
Required: False ,
}
{
dynamicThresholdModel:
{
Description: ML model to use for dynamic thresholds ,
Enum:
{
AnomalyDetection: Anomaly detection model ,
}
,
Required: True ,
}
enum ,
modelSensitivity:
{
Description: ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 ,
Format: float ,
Required: True ,
}
number ,
dynamicThresholdDirection:
{
Description: Threshold direction ,
Enum:
{
LowerThan: Lower than ,
GreaterThan: Greater than ,
GreaterOrLowerThan: Greater or Lower Than ,
}
,
Required: True ,
}
enum ,
trainingStartTime:
{
Description: Start time of the training in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
degradedRule:
{
Description: Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
unhealthyRule:
{
Description: Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
}
,
deletionDate:
{
Description: Date when the signal definition was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
signalKind:
{
Description: Kind of the signal definition ,
Enum:
{
AzureResourceMetric: No description available. ,
LogAnalyticsQuery: No description available. ,
PrometheusMetricsQuery: No description available. ,
}
,
Required: True ,
}
enum ,
refreshInterval:
{
Description: Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). ,
Enum:
{
PT1M: One Minute ,
PT5M: Five Minutes ,
PT10M: Ten Minutes ,
PT30M: Thirty Minutes ,
PT1H: One Hour ,
PT2H: Two Hours ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
dataUnit:
{
Description: Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) ,
Required: False ,
}
string ,
evaluationRules:
{
Description: Evaluation rules for the signal definition ,
Required: True ,
}
{
dynamicDetectionRule:
{
Description: Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. ,
Required: False ,
}
{
dynamicThresholdModel:
{
Description: ML model to use for dynamic thresholds ,
Enum:
{
AnomalyDetection: Anomaly detection model ,
}
,
Required: True ,
}
enum ,
modelSensitivity:
{
Description: ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 ,
Format: float ,
Required: True ,
}
number ,
dynamicThresholdDirection:
{
Description: Threshold direction ,
Enum:
{
LowerThan: Lower than ,
GreaterThan: Greater than ,
GreaterOrLowerThan: Greater or Lower Than ,
}
,
Required: True ,
}
enum ,
trainingStartTime:
{
Description: Start time of the training in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
degradedRule:
{
Description: Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
unhealthyRule:
{
Description: Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
}
,
deletionDate:
{
Description: Date when the signal definition was (soft-)deleted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
signalKind:
{
Description: Kind of the signal definition ,
Enum:
{
AzureResourceMetric: No description available. ,
LogAnalyticsQuery: No description available. ,
PrometheusMetricsQuery: No description available. ,
}
,
Required: True ,
}
enum ,
refreshInterval:
{
Description: Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). ,
Enum:
{
PT1M: One Minute ,
PT5M: Five Minutes ,
PT10M: Ten Minutes ,
PT30M: Thirty Minutes ,
PT1H: One Hour ,
PT2H: Two Hours ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Optional set of labels (key-value pairs) ,
Required: False ,
}
object ,
dataUnit:
{
Description: Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) ,
Required: False ,
}
string ,
evaluationRules:
{
Description: Evaluation rules for the signal definition ,
Required: True ,
}
{
dynamicDetectionRule:
{
Description: Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. ,
Required: False ,
}
{
dynamicThresholdModel:
{
Description: ML model to use for dynamic thresholds ,
Enum:
{
AnomalyDetection: Anomaly detection model ,
}
,
Required: True ,
}
enum ,
modelSensitivity:
{
Description: ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 ,
Format: float ,
Required: True ,
}
number ,
dynamicThresholdDirection:
{
Description: Threshold direction ,
Enum:
{
LowerThan: Lower than ,
GreaterThan: Greater than ,
GreaterOrLowerThan: Greater or Lower Than ,
}
,
Required: True ,
}
enum ,
trainingStartTime:
{
Description: Start time of the training in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
degradedRule:
{
Description: Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
unhealthyRule:
{
Description: Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. ,
Required: False ,
}
{
operator:
{
Description: Operator how to compare the signal value with the threshold ,
Enum:
{
LessThan: Less than ,
LessThanOrEqual: Less than or equal to ,
GreaterThan: Greater than ,
GreaterThanOrEqual: Greater than or equal to ,
Equal: Equal to ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold value ,
Required: True ,
}
string ,
}
,
}
,
deletionDate:
{
Description: Date when the signal definition was (soft-)deleted ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
SignalDefinitions_Delete (new)
Description :  Delete a SignalDefinition
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/healthmodels/{healthModelName}/signaldefinitions/{signalDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
healthModelName:
{
Description: Name of health model resource ,
Required: True ,
}
string ,
signalDefinitionName:
{
Description: Name of the signal definition. Must be unique within a health model. ,
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_List (new)
Description :  List all issues under the parent
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
related:
{
Description: Related resource or alert that is to be added to the issue (default: empty - the issue will be created without any related resources or alerts) ,
Required: False ,
}
string ,
startInvestigation:
{
Description: Whether to automatically start an investigation once the issue is created (default: false) ,
Required: False ,
}
boolean ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/addOrUpdateAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 user ID/app ID, 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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/addOrUpdateResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 user ID/app ID, 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 user ID/app ID, 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 result
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/fetchInvestigationResult
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 ,
origin:
{
Description: The origin of the investigation ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 ,
}
,
]
,
}
,
result:
{
Description: The result of this investigation ,
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_ListAlerts (new)
Description :  List all alerts in the issue - this method uses pagination to return all alerts
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/listAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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'". Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/listResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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'". Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/startInvestigation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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. Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 ,
}
,
]
,
}
,
}
MetricsContainers_ListByAzureMonitorWorkspace (updated)
Description :  Lists metrics containers for a monitoring account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricsContainers_ListByAzureMonitorWorkspace",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a MetricsContainerResource list operation.",
        "old": "The response of a MacMetricsContainerResource list operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The MetricsContainerResource items on this page",
            "old": "The MacMetricsContainerResource items on this page"
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "limits",
                  "Description": {
                    "new": "Metrics limits.",
                    "old": "Geneva Metrics limits."
                  }
                }
              ]
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/metricsContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MetricsContainerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the metrics container. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
limits:
{
Description: Metrics limits. ,
Required: False ,
}
{
maxActiveTimeSeries:
{
Description: Maximum number of active time series allowed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
maxEventsPerMinute:
{
Description: Maximum rate (events per minute) that can be processed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
MetricsContainers_Get (updated)
Description :  Gets metrics container settings for a monitoring account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricsContainers_Get",
  "$parameters": [
    {
      "#name": "metricsContainerName",
      "Description": {
        "new": "The name of the MetricsContainer",
        "old": "The name of the MacMetricsContainer"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "limits",
            "Description": {
              "new": "Metrics limits.",
              "old": "Geneva Metrics limits."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/metricsContainers/{metricsContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
metricsContainerName:
{
Description: The name of the MetricsContainer ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the metrics container. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
limits:
{
Description: Metrics limits. ,
Required: False ,
}
{
maxActiveTimeSeries:
{
Description: Maximum number of active time series allowed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
maxEventsPerMinute:
{
Description: Maximum rate (events per minute) that can be processed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
MetricsContainers_CreateOrUpdate (updated)
Description :  Creates or updates metrics container settings for a monitoring account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricsContainers_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "metricsContainerName",
      "Description": {
        "new": "The name of the MetricsContainer",
        "old": "The name of the MacMetricsContainer"
      }
    },
    {
      "resource": {
        "$properties": {
          "properties": [
            {
              "#name": "limits",
              "Description": {
                "new": "Metrics limits.",
                "old": "Geneva Metrics limits."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "limits",
            "Description": {
              "new": "Metrics limits.",
              "old": "Geneva Metrics limits."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "limits",
            "Description": {
              "new": "Metrics limits.",
              "old": "Geneva Metrics limits."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/metricsContainers/{metricsContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the Azure Monitor Workspace. The name is case insensitive ,
Required: True ,
}
string ,
metricsContainerName:
{
Description: The name of the MetricsContainer ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the metrics container. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
limits:
{
Description: Metrics limits. ,
Required: False ,
}
{
maxActiveTimeSeries:
{
Description: Maximum number of active time series allowed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
maxEventsPerMinute:
{
Description: Maximum rate (events per minute) that can be processed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the metrics container. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
limits:
{
Description: Metrics limits. ,
Required: False ,
}
{
maxActiveTimeSeries:
{
Description: Maximum number of active time series allowed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
maxEventsPerMinute:
{
Description: Maximum rate (events per minute) that can be processed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the metrics container. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
limits:
{
Description: Metrics limits. ,
Required: False ,
}
{
maxActiveTimeSeries:
{
Description: Maximum number of active time series allowed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
maxEventsPerMinute:
{
Description: Maximum rate (events per minute) that can be processed on the metrics containers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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_List (removed)
Description :  List all issues under the parent
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Get issue properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Create a new issue or updates an existing one
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
Required: True ,
}
string ,
issueName:
{
Description: The name of the IssueResource ,
Required: True ,
}
string ,
related:
{
Description: Related resource or alert that is to be added to the issue (default: empty - the issue will be created without any related resources or alerts) ,
Required: False ,
}
string ,
startInvestigation:
{
Description: Whether to automatically start an investigation once the issue is created (default: false) ,
Required: False ,
}
boolean ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Update an issue
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Delete an issue
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 (removed)
Description :  Add or update alerts in the issue
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/addOrUpdateAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Add or update resources in the issue
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/addOrUpdateResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 user ID/app ID, 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 user ID/app ID, 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 (removed)
Description :  Fetch investigation result
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/fetchInvestigationResult
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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 ,
origin:
{
Description: The origin of the investigation ,
Required: True ,
}
{
addedBy:
{
Description: The ID of the origin - for example, in case of 'Manual', the user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 ,
}
,
]
,
}
,
result:
{
Description: The result of this investigation ,
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_ListAlerts (removed)
Description :  List all alerts in the issue - this method uses pagination to return all alerts
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/listAlerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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'". Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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 (removed)
Description :  List all resources in the issue - this method uses pagination to return all resources
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/listResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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'". Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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 (removed)
Description :  Start a new investigation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/startInvestigation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureMonitorWorkspaceName:
{
Description: The name of the AzureMonitorWorkspaceResource ,
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. Note: this property is currently a placeholder and is not in use. ,
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 user ID/app ID, 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: False ,
}
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 user ID/app ID, 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 user ID/app ID, 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 ,
}
,
]
,
}
,
}