workload_impacts

Creates, updates, deletes, gets or lists a workload_impacts resource.

Overview

Name	workload_impacts
Type	Resource
Id	azure.impact_reporting.workload_impacts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalProperties	object	Additional fields related to impact, applicable fields per resource type are list under /impactCategories API.
armCorrelationIds	array	The ARM correlation ids, this is important field for control plane related impacts.
clientIncidentDetails	object	Client incident details ex: incidentId , incident source.
confidenceLevel	string	Degree of confidence on the impact being a platform issue. Known values are: "Low", "Medium", and "High". (Low, Medium, High)
connectivity	object	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.
endDateTime	string (date-time)	Time at which impact has ended.
errorDetails	object	ARM error code and error message associated with the impact.
impactCategory	string	Category of the impact, details can found from /impactCategories API. Required.
impactDescription	string	A detailed description of the impact.
impactGroupId	string	Use this field to group impacts.
impactUniqueId	string	Unique ID of the impact (UUID).
impactedResourceId	string	Azure resource id of the impacted resource. Required.
performance	array	Details about performance issue. Applicable for performance impacts.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
reportedTimeUtc	string (date-time)	Time at which impact is reported.
startDateTime	string (date-time)	Time at which impact was observed. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workload	object	Information about the impacted workload.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalProperties	object	Additional fields related to impact, applicable fields per resource type are list under /impactCategories API.
armCorrelationIds	array	The ARM correlation ids, this is important field for control plane related impacts.
clientIncidentDetails	object	Client incident details ex: incidentId , incident source.
confidenceLevel	string	Degree of confidence on the impact being a platform issue. Known values are: "Low", "Medium", and "High". (Low, Medium, High)
connectivity	object	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.
endDateTime	string (date-time)	Time at which impact has ended.
errorDetails	object	ARM error code and error message associated with the impact.
impactCategory	string	Category of the impact, details can found from /impactCategories API. Required.
impactDescription	string	A detailed description of the impact.
impactGroupId	string	Use this field to group impacts.
impactUniqueId	string	Unique ID of the impact (UUID).
impactedResourceId	string	Azure resource id of the impacted resource. Required.
performance	array	Details about performance issue. Applicable for performance impacts.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
reportedTimeUtc	string (date-time)	Time at which impact is reported.
startDateTime	string (date-time)	Time at which impact was observed. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workload	object	Information about the impacted workload.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workload_impact_name, subscription_id		Get a WorkloadImpact.
list_by_subscription	select	subscription_id		List WorkloadImpact resources by subscription ID.
create	insert	workload_impact_name, subscription_id		Create a WorkloadImpact.
delete	delete	workload_impact_name, subscription_id		Delete a WorkloadImpact.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subscription_id	string
workload_impact_name	string	workloadImpact resource. Required.

SELECT examples

get

Get a WorkloadImpact.

SELECT
id,
name,
additionalProperties,
armCorrelationIds,
clientIncidentDetails,
confidenceLevel,
connectivity,
endDateTime,
errorDetails,
impactCategory,
impactDescription,
impactGroupId,
impactUniqueId,
impactedResourceId,
performance,
provisioningState,
reportedTimeUtc,
startDateTime,
systemData,
type,
workload
FROM azure.impact_reporting.workload_impacts
WHERE workload_impact_name = '{{ workload_impact_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List WorkloadImpact resources by subscription ID.

SELECT
id,
name,
additionalProperties,
armCorrelationIds,
clientIncidentDetails,
confidenceLevel,
connectivity,
endDateTime,
errorDetails,
impactCategory,
impactDescription,
impactGroupId,
impactUniqueId,
impactedResourceId,
performance,
provisioningState,
reportedTimeUtc,
startDateTime,
systemData,
type,
workload
FROM azure.impact_reporting.workload_impacts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a WorkloadImpact.

INSERT INTO azure.impact_reporting.workload_impacts (
properties,
workload_impact_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ workload_impact_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workload_impacts
props:
  - name: workload_impact_name
    value: "{{ workload_impact_name }}"
    description: Required parameter for the workload_impacts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workload_impacts resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      startDateTime: "{{ startDateTime }}"
      endDateTime: "{{ endDateTime }}"
      impactedResourceId: "{{ impactedResourceId }}"
      impactUniqueId: "{{ impactUniqueId }}"
      reportedTimeUtc: "{{ reportedTimeUtc }}"
      impactCategory: "{{ impactCategory }}"
      impactDescription: "{{ impactDescription }}"
      armCorrelationIds:
        - "{{ armCorrelationIds }}"
      performance:
        - metricName: "{{ metricName }}"
          expected: {{ expected }}
          actual: {{ actual }}
          expectedValueRange:
            min: {{ min }}
            max: {{ max }}
          unit: "{{ unit }}"
      connectivity:
        protocol: "{{ protocol }}"
        port: {{ port }}
        source:
          azureResourceId: "{{ azureResourceId }}"
        target:
          azureResourceId: "{{ azureResourceId }}"
      additionalProperties: "{{ additionalProperties }}"
      errorDetails:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
      workload:
        context: "{{ context }}"
        toolset: "{{ toolset }}"
      impactGroupId: "{{ impactGroupId }}"
      confidenceLevel: "{{ confidenceLevel }}"
      clientIncidentDetails:
        clientIncidentId: "{{ clientIncidentId }}"
        clientIncidentSource: "{{ clientIncidentSource }}"

DELETE examples

delete

Delete a WorkloadImpact.

DELETE FROM azure.impact_reporting.workload_impacts
WHERE workload_impact_name = '{{ workload_impact_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;