Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Bicep resource definition
The workloadImpacts 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Impact/workloadImpacts@2024-05-01-preview' = {
name: 'string'
properties: {
additionalProperties: {
{customized property}: any(...)
}
armCorrelationIds: [
'string'
]
clientIncidentDetails: {
clientIncidentId: 'string'
clientIncidentSource: 'string'
}
confidenceLevel: 'string'
connectivity: {
port: int
protocol: 'string'
source: {
azureResourceId: 'string'
}
target: {
azureResourceId: 'string'
}
}
endDateTime: 'string'
errorDetails: {
errorCode: 'string'
errorMessage: 'string'
}
impactCategory: 'string'
impactDescription: 'string'
impactedResourceId: 'string'
impactGroupId: 'string'
performance: [
{
actual: int
expected: int
expectedValueRange: {
max: int
min: int
}
metricName: 'string'
unit: 'string'
}
]
startDateTime: 'string'
workload: {
context: 'string'
toolset: 'string'
}
}
}
Property Values
ClientIncidentDetails
| Name | Description | Value |
|---|---|---|
| clientIncidentId | Client incident id. ex : id of the incident created to investigate and address the impact if any. | string |
| clientIncidentSource | Client incident source. ex : source system name where the incident is created | 'AzureDevops' 'ICM' 'Jira' 'Other' 'ServiceNow' |
Connectivity
| Name | Description | Value |
|---|---|---|
| port | Port number for the connection | int |
| protocol | Protocol used for the connection | 'FTP' 'HTTP' 'HTTPS' 'Other' 'RDP' 'SSH' 'TCP' 'UDP' |
| source | Source from which the connection was attempted | SourceOrTarget |
| target | target which connection was attempted | SourceOrTarget |
ErrorDetailProperties
| Name | Description | Value |
|---|---|---|
| errorCode | ARM Error code associated with the impact. | string |
| errorMessage | ARM Error Message associated with the impact | string |
ExpectedValueRange
| Name | Description | Value |
|---|---|---|
| max | Max threshold value for the metric | int (required) |
| min | Min threshold value for the metric | int (required) |
Microsoft.Impact/workloadImpacts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-:]*[a-zA-Z0-9]{3,120}$ (required) |
| properties | The resource-specific properties for this resource. | WorkloadImpactProperties |
Performance
| Name | Description | Value |
|---|---|---|
| actual | Observed value for the metric | int |
| expected | Threshold value for the metric | int |
| expectedValueRange | Max and Min Threshold values for the metric | ExpectedValueRange |
| metricName | Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API | string |
| unit | Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other | 'Bytes' 'ByteSeconds' 'BytesPerSecond' 'Cores' 'Count' 'CountPerSecond' 'MilliCores' 'MilliSeconds' 'NanoCores' 'Other' 'Percent' 'Seconds' |
SourceOrTarget
| Name | Description | Value |
|---|---|---|
| azureResourceId | Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName} | string Constraints: Pattern = (\/[0-9a-zA-Z]+)* |
Workload
| Name | Description | Value |
|---|---|---|
| context | the scenario for the workload | string |
| toolset | Tool used to interact with Azure. SDK, AzPortal, etc.., Other | 'Ansible' 'ARM' 'Chef' 'Other' 'Portal' 'Puppet' 'SDK' 'Shell' 'Terraform' |
WorkloadImpactProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Additional fields related to impact, applicable fields per resource type are list under /impactCategories API | WorkloadImpactPropertiesAdditionalProperties |
| armCorrelationIds | The ARM correlation ids, this is important field for control plane related impacts | string[] |
| clientIncidentDetails | Client incident details ex: incidentId , incident source | ClientIncidentDetails |
| confidenceLevel | Degree of confidence on the impact being a platform issue | 'High' 'Low' 'Medium' |
| connectivity | Details about connectivity issue. Applicable when root resource causing the issue is not identified. For example, when a VM is impacted due to a network issue, the impacted resource is identified as the VM, but the root cause is the network. In such cases, the connectivity field will have the details about the network issue | Connectivity |
| endDateTime | Time at which impact has ended | string |
| errorDetails | ARM error code and error message associated with the impact | ErrorDetailProperties |
| impactCategory | Category of the impact, details can found from /impactCategories API | string (required) |
| impactDescription | A detailed description of the impact | string |
| impactedResourceId | Azure resource id of the impacted resource | string (required) |
| impactGroupId | Use this field to group impacts | string |
| performance | Details about performance issue. Applicable for performance impacts. | Performance[] |
| startDateTime | Time at which impact was observed | string (required) |
| workload | Information about the impacted workload | Workload |
WorkloadImpactPropertiesAdditionalProperties
| Name | Description | Value |
|---|
ARM template resource definition
The workloadImpacts 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Impact/workloadImpacts",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"additionalProperties": {
"{customized property}": {}
},
"armCorrelationIds": [ "string" ],
"clientIncidentDetails": {
"clientIncidentId": "string",
"clientIncidentSource": "string"
},
"confidenceLevel": "string",
"connectivity": {
"port": "int",
"protocol": "string",
"source": {
"azureResourceId": "string"
},
"target": {
"azureResourceId": "string"
}
},
"endDateTime": "string",
"errorDetails": {
"errorCode": "string",
"errorMessage": "string"
},
"impactCategory": "string",
"impactDescription": "string",
"impactedResourceId": "string",
"impactGroupId": "string",
"performance": [
{
"actual": "int",
"expected": "int",
"expectedValueRange": {
"max": "int",
"min": "int"
},
"metricName": "string",
"unit": "string"
}
],
"startDateTime": "string",
"workload": {
"context": "string",
"toolset": "string"
}
}
}
Property Values
ClientIncidentDetails
| Name | Description | Value |
|---|---|---|
| clientIncidentId | Client incident id. ex : id of the incident created to investigate and address the impact if any. | string |
| clientIncidentSource | Client incident source. ex : source system name where the incident is created | 'AzureDevops' 'ICM' 'Jira' 'Other' 'ServiceNow' |
Connectivity
| Name | Description | Value |
|---|---|---|
| port | Port number for the connection | int |
| protocol | Protocol used for the connection | 'FTP' 'HTTP' 'HTTPS' 'Other' 'RDP' 'SSH' 'TCP' 'UDP' |
| source | Source from which the connection was attempted | SourceOrTarget |
| target | target which connection was attempted | SourceOrTarget |
ErrorDetailProperties
| Name | Description | Value |
|---|---|---|
| errorCode | ARM Error code associated with the impact. | string |
| errorMessage | ARM Error Message associated with the impact | string |
ExpectedValueRange
| Name | Description | Value |
|---|---|---|
| max | Max threshold value for the metric | int (required) |
| min | Min threshold value for the metric | int (required) |
Microsoft.Impact/workloadImpacts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-:]*[a-zA-Z0-9]{3,120}$ (required) |
| properties | The resource-specific properties for this resource. | WorkloadImpactProperties |
| type | The resource type | 'Microsoft.Impact/workloadImpacts' |
Performance
| Name | Description | Value |
|---|---|---|
| actual | Observed value for the metric | int |
| expected | Threshold value for the metric | int |
| expectedValueRange | Max and Min Threshold values for the metric | ExpectedValueRange |
| metricName | Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API | string |
| unit | Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other | 'Bytes' 'ByteSeconds' 'BytesPerSecond' 'Cores' 'Count' 'CountPerSecond' 'MilliCores' 'MilliSeconds' 'NanoCores' 'Other' 'Percent' 'Seconds' |
SourceOrTarget
| Name | Description | Value |
|---|---|---|
| azureResourceId | Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName} | string Constraints: Pattern = (\/[0-9a-zA-Z]+)* |
Workload
| Name | Description | Value |
|---|---|---|
| context | the scenario for the workload | string |
| toolset | Tool used to interact with Azure. SDK, AzPortal, etc.., Other | 'Ansible' 'ARM' 'Chef' 'Other' 'Portal' 'Puppet' 'SDK' 'Shell' 'Terraform' |
WorkloadImpactProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Additional fields related to impact, applicable fields per resource type are list under /impactCategories API | WorkloadImpactPropertiesAdditionalProperties |
| armCorrelationIds | The ARM correlation ids, this is important field for control plane related impacts | string[] |
| clientIncidentDetails | Client incident details ex: incidentId , incident source | ClientIncidentDetails |
| confidenceLevel | Degree of confidence on the impact being a platform issue | 'High' 'Low' 'Medium' |
| connectivity | Details about connectivity issue. Applicable when root resource causing the issue is not identified. For example, when a VM is impacted due to a network issue, the impacted resource is identified as the VM, but the root cause is the network. In such cases, the connectivity field will have the details about the network issue | Connectivity |
| endDateTime | Time at which impact has ended | string |
| errorDetails | ARM error code and error message associated with the impact | ErrorDetailProperties |
| impactCategory | Category of the impact, details can found from /impactCategories API | string (required) |
| impactDescription | A detailed description of the impact | string |
| impactedResourceId | Azure resource id of the impacted resource | string (required) |
| impactGroupId | Use this field to group impacts | string |
| performance | Details about performance issue. Applicable for performance impacts. | Performance[] |
| startDateTime | Time at which impact was observed | string (required) |
| workload | Information about the impacted workload | Workload |
WorkloadImpactPropertiesAdditionalProperties
| Name | Description | Value |
|---|
Exemples d’utilisation
Terraform (AzAPI provider) resource definition
The workloadImpacts 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Impact/workloadImpacts@2024-05-01-preview"
name = "string"
body = {
properties = {
additionalProperties = {
{customized property} = ?
}
armCorrelationIds = [
"string"
]
clientIncidentDetails = {
clientIncidentId = "string"
clientIncidentSource = "string"
}
confidenceLevel = "string"
connectivity = {
port = int
protocol = "string"
source = {
azureResourceId = "string"
}
target = {
azureResourceId = "string"
}
}
endDateTime = "string"
errorDetails = {
errorCode = "string"
errorMessage = "string"
}
impactCategory = "string"
impactDescription = "string"
impactedResourceId = "string"
impactGroupId = "string"
performance = [
{
actual = int
expected = int
expectedValueRange = {
max = int
min = int
}
metricName = "string"
unit = "string"
}
]
startDateTime = "string"
workload = {
context = "string"
toolset = "string"
}
}
}
}
Property Values
ClientIncidentDetails
| Name | Description | Value |
|---|---|---|
| clientIncidentId | Client incident id. ex : id of the incident created to investigate and address the impact if any. | string |
| clientIncidentSource | Client incident source. ex : source system name where the incident is created | 'AzureDevops' 'ICM' 'Jira' 'Other' 'ServiceNow' |
Connectivity
| Name | Description | Value |
|---|---|---|
| port | Port number for the connection | int |
| protocol | Protocol used for the connection | 'FTP' 'HTTP' 'HTTPS' 'Other' 'RDP' 'SSH' 'TCP' 'UDP' |
| source | Source from which the connection was attempted | SourceOrTarget |
| target | target which connection was attempted | SourceOrTarget |
ErrorDetailProperties
| Name | Description | Value |
|---|---|---|
| errorCode | ARM Error code associated with the impact. | string |
| errorMessage | ARM Error Message associated with the impact | string |
ExpectedValueRange
| Name | Description | Value |
|---|---|---|
| max | Max threshold value for the metric | int (required) |
| min | Min threshold value for the metric | int (required) |
Microsoft.Impact/workloadImpacts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-:]*[a-zA-Z0-9]{3,120}$ (required) |
| properties | The resource-specific properties for this resource. | WorkloadImpactProperties |
| type | The resource type | "Microsoft.Impact/workloadImpacts@2024-05-01-preview" |
Performance
| Name | Description | Value |
|---|---|---|
| actual | Observed value for the metric | int |
| expected | Threshold value for the metric | int |
| expectedValueRange | Max and Min Threshold values for the metric | ExpectedValueRange |
| metricName | Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API | string |
| unit | Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other | 'Bytes' 'ByteSeconds' 'BytesPerSecond' 'Cores' 'Count' 'CountPerSecond' 'MilliCores' 'MilliSeconds' 'NanoCores' 'Other' 'Percent' 'Seconds' |
SourceOrTarget
| Name | Description | Value |
|---|---|---|
| azureResourceId | Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName} | string Constraints: Pattern = (\/[0-9a-zA-Z]+)* |
Workload
| Name | Description | Value |
|---|---|---|
| context | the scenario for the workload | string |
| toolset | Tool used to interact with Azure. SDK, AzPortal, etc.., Other | 'Ansible' 'ARM' 'Chef' 'Other' 'Portal' 'Puppet' 'SDK' 'Shell' 'Terraform' |
WorkloadImpactProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Additional fields related to impact, applicable fields per resource type are list under /impactCategories API | WorkloadImpactPropertiesAdditionalProperties |
| armCorrelationIds | The ARM correlation ids, this is important field for control plane related impacts | string[] |
| clientIncidentDetails | Client incident details ex: incidentId , incident source | ClientIncidentDetails |
| confidenceLevel | Degree of confidence on the impact being a platform issue | 'High' 'Low' 'Medium' |
| connectivity | Details about connectivity issue. Applicable when root resource causing the issue is not identified. For example, when a VM is impacted due to a network issue, the impacted resource is identified as the VM, but the root cause is the network. In such cases, the connectivity field will have the details about the network issue | Connectivity |
| endDateTime | Time at which impact has ended | string |
| errorDetails | ARM error code and error message associated with the impact | ErrorDetailProperties |
| impactCategory | Category of the impact, details can found from /impactCategories API | string (required) |
| impactDescription | A detailed description of the impact | string |
| impactedResourceId | Azure resource id of the impacted resource | string (required) |
| impactGroupId | Use this field to group impacts | string |
| performance | Details about performance issue. Applicable for performance impacts. | Performance[] |
| startDateTime | Time at which impact was observed | string (required) |
| workload | Information about the impacted workload | Workload |
WorkloadImpactPropertiesAdditionalProperties
| Name | Description | Value |
|---|