Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workloadImpacts/insights resource type can be deployed with operations that target:
- Subscription - See subscription deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Impact/workloadImpacts/insights resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Impact/workloadImpacts/insights@2026-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
additionalDetails: any(...)
category: 'string'
content: {
description: 'string'
title: 'string'
}
eventId: 'string'
eventTime: 'string'
groupId: 'string'
impact: {
endTime: 'string'
impactedResourceId: 'string'
impactId: 'string'
startTime: 'string'
}
insightUniqueId: 'string'
status: 'string'
}
}
Property Values
Microsoft.Impact/workloadImpacts/insights
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]{3,180}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workloadImpacts |
| properties | The resource-specific properties for this resource. | InsightProperties |
Content
| Name | Description | Value |
|---|---|---|
| description | Description of the insight | string (required) |
| title | Title of the insight | string (required) |
ImpactDetails
| Name | Description | Value |
|---|---|---|
| endTime | Time at which impact was ended according to reported impact. | string |
| impactedResourceId | List of impacted Azure resources. | string (required) |
| impactId | Azure Id of the impact. | string (required) |
| startTime | Time at which impact was started according to reported impact. | string (required) |
InsightProperties
| Name | Description | Value |
|---|---|---|
| additionalDetails | additional details of the insight. | any |
| category | category of the insight. | string (required) |
| content | Contains title & description for the insight | Content (required) |
| eventId | Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event. | string |
| eventTime | Time of the event, which has been correlated the impact. | string |
| groupId | Identifier that can be used to group similar insights. | string |
| impact | details of of the impact for which insight has been generated. | ImpactDetails (required) |
| insightUniqueId | unique id of the insight. | string (required) |
| status | status of the insight. example resolved, repaired, other. | string |
ARM template resource definition
The workloadImpacts/insights resource type can be deployed with operations that target:
- Subscription - See subscription deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Impact/workloadImpacts/insights resource, add the following JSON to your template.
{
"type": "Microsoft.Impact/workloadImpacts/insights",
"apiVersion": "2026-01-01-preview",
"name": "string",
"properties": {
"additionalDetails": {},
"category": "string",
"content": {
"description": "string",
"title": "string"
},
"eventId": "string",
"eventTime": "string",
"groupId": "string",
"impact": {
"endTime": "string",
"impactedResourceId": "string",
"impactId": "string",
"startTime": "string"
},
"insightUniqueId": "string",
"status": "string"
}
}
Property Values
Microsoft.Impact/workloadImpacts/insights
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-01-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]{3,180}$ (required) |
| properties | The resource-specific properties for this resource. | InsightProperties |
| type | The resource type | 'Microsoft.Impact/workloadImpacts/insights' |
Content
| Name | Description | Value |
|---|---|---|
| description | Description of the insight | string (required) |
| title | Title of the insight | string (required) |
ImpactDetails
| Name | Description | Value |
|---|---|---|
| endTime | Time at which impact was ended according to reported impact. | string |
| impactedResourceId | List of impacted Azure resources. | string (required) |
| impactId | Azure Id of the impact. | string (required) |
| startTime | Time at which impact was started according to reported impact. | string (required) |
InsightProperties
| Name | Description | Value |
|---|---|---|
| additionalDetails | additional details of the insight. | any |
| category | category of the insight. | string (required) |
| content | Contains title & description for the insight | Content (required) |
| eventId | Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event. | string |
| eventTime | Time of the event, which has been correlated the impact. | string |
| groupId | Identifier that can be used to group similar insights. | string |
| impact | details of of the impact for which insight has been generated. | ImpactDetails (required) |
| insightUniqueId | unique id of the insight. | string (required) |
| status | status of the insight. example resolved, repaired, other. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The workloadImpacts/insights resource type can be deployed with operations that target:
- Subscription
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Impact/workloadImpacts/insights resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Impact/workloadImpacts/insights@2026-01-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
additionalDetails = ?
category = "string"
content = {
description = "string"
title = "string"
}
eventId = "string"
eventTime = "string"
groupId = "string"
impact = {
endTime = "string"
impactedResourceId = "string"
impactId = "string"
startTime = "string"
}
insightUniqueId = "string"
status = "string"
}
}
}
Property Values
Microsoft.Impact/workloadImpacts/insights
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]{3,180}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workloadImpacts |
| properties | The resource-specific properties for this resource. | InsightProperties |
| type | The resource type | "Microsoft.Impact/workloadImpacts/insights@2026-01-01-preview" |
Content
| Name | Description | Value |
|---|---|---|
| description | Description of the insight | string (required) |
| title | Title of the insight | string (required) |
ImpactDetails
| Name | Description | Value |
|---|---|---|
| endTime | Time at which impact was ended according to reported impact. | string |
| impactedResourceId | List of impacted Azure resources. | string (required) |
| impactId | Azure Id of the impact. | string (required) |
| startTime | Time at which impact was started according to reported impact. | string (required) |
InsightProperties
| Name | Description | Value |
|---|---|---|
| additionalDetails | additional details of the insight. | any |
| category | category of the insight. | string (required) |
| content | Contains title & description for the insight | Content (required) |
| eventId | Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event. | string |
| eventTime | Time of the event, which has been correlated the impact. | string |
| groupId | Identifier that can be used to group similar insights. | string |
| impact | details of of the impact for which insight has been generated. | ImpactDetails (required) |
| insightUniqueId | unique id of the insight. | string (required) |
| status | status of the insight. example resolved, repaired, other. | string |