Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.impact.getWorkloadImpact

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getWorkloadImpact

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getWorkloadImpact(args: GetWorkloadImpactArgs, opts?: InvokeOptions): Promise<GetWorkloadImpactResult>
function getWorkloadImpactOutput(args: GetWorkloadImpactOutputArgs, opts?: InvokeOptions): Output<GetWorkloadImpactResult>

def get_workload_impact(workload_impact_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWorkloadImpactResult
def get_workload_impact_output(workload_impact_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadImpactResult]

func LookupWorkloadImpact(ctx *Context, args *LookupWorkloadImpactArgs, opts ...InvokeOption) (*LookupWorkloadImpactResult, error)
func LookupWorkloadImpactOutput(ctx *Context, args *LookupWorkloadImpactOutputArgs, opts ...InvokeOption) LookupWorkloadImpactResultOutput

> Note: This function is named LookupWorkloadImpact in the Go SDK.

public static class GetWorkloadImpact 
{
    public static Task<GetWorkloadImpactResult> InvokeAsync(GetWorkloadImpactArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadImpactResult> Invoke(GetWorkloadImpactInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkloadImpactResult> getWorkloadImpact(GetWorkloadImpactArgs args, InvokeOptions options)
public static Output<GetWorkloadImpactResult> getWorkloadImpact(GetWorkloadImpactArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:impact:getWorkloadImpact
  arguments:
    # arguments dictionary

The following arguments are supported:

WorkloadImpactName string: workloadImpact resource

WorkloadImpactName string: workloadImpact resource

workloadImpactName String: workloadImpact resource

workloadImpactName string: workloadImpact resource

workload_impact_name str: workloadImpact resource

workloadImpactName String: workloadImpact resource

getWorkloadImpact Result

The following output properties are available:

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
Properties Pulumi.AzureNative.Impact.Outputs.WorkloadImpactPropertiesResponse: The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.Impact.Outputs.SystemDataResponse: 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"

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
Properties WorkloadImpactPropertiesResponse: The resource-specific properties for this resource.
SystemData SystemDataResponse: 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"

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
properties WorkloadImpactPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: 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"

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
properties WorkloadImpactPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: 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"

id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
properties WorkloadImpactPropertiesResponse: The resource-specific properties for this resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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
properties Property Map: The resource-specific properties for this resource.
systemData Property Map: 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"

Supporting Types

ClientIncidentDetailsResponse

ClientIncidentId string: Client incident id. ex : id of the incident created to investigate and address the impact if any.
ClientIncidentSource string: Client incident source. ex : source system name where the incident is created

ClientIncidentId string: Client incident id. ex : id of the incident created to investigate and address the impact if any.
ClientIncidentSource string: Client incident source. ex : source system name where the incident is created

clientIncidentId String: Client incident id. ex : id of the incident created to investigate and address the impact if any.
clientIncidentSource String: Client incident source. ex : source system name where the incident is created

clientIncidentId string: Client incident id. ex : id of the incident created to investigate and address the impact if any.
clientIncidentSource string: Client incident source. ex : source system name where the incident is created

client_incident_id str: Client incident id. ex : id of the incident created to investigate and address the impact if any.
client_incident_source str: Client incident source. ex : source system name where the incident is created

clientIncidentId String: Client incident id. ex : id of the incident created to investigate and address the impact if any.
clientIncidentSource String: Client incident source. ex : source system name where the incident is created

ConnectivityResponse

Port int: Port number for the connection
Protocol string: Protocol used for the connection
Source Pulumi.AzureNative.Impact.Inputs.SourceOrTargetResponse: Source from which the connection was attempted
Target Pulumi.AzureNative.Impact.Inputs.SourceOrTargetResponse: target which connection was attempted

Port int: Port number for the connection
Protocol string: Protocol used for the connection
Source SourceOrTargetResponse: Source from which the connection was attempted
Target SourceOrTargetResponse: target which connection was attempted

port Integer: Port number for the connection
protocol String: Protocol used for the connection
source SourceOrTargetResponse: Source from which the connection was attempted
target SourceOrTargetResponse: target which connection was attempted

port number: Port number for the connection
protocol string: Protocol used for the connection
source SourceOrTargetResponse: Source from which the connection was attempted
target SourceOrTargetResponse: target which connection was attempted

port int: Port number for the connection
protocol str: Protocol used for the connection
source SourceOrTargetResponse: Source from which the connection was attempted
target SourceOrTargetResponse: target which connection was attempted

port Number: Port number for the connection
protocol String: Protocol used for the connection
source Property Map: Source from which the connection was attempted
target Property Map: target which connection was attempted

ErrorDetailPropertiesResponse

ErrorCode string: ARM Error code associated with the impact.
ErrorMessage string: ARM Error Message associated with the impact

ErrorCode string: ARM Error code associated with the impact.
ErrorMessage string: ARM Error Message associated with the impact

errorCode String: ARM Error code associated with the impact.
errorMessage String: ARM Error Message associated with the impact

errorCode string: ARM Error code associated with the impact.
errorMessage string: ARM Error Message associated with the impact

error_code str: ARM Error code associated with the impact.
error_message str: ARM Error Message associated with the impact

errorCode String: ARM Error code associated with the impact.
errorMessage String: ARM Error Message associated with the impact

ExpectedValueRangeResponse

Max double: Max threshold value for the metric
Min double: Min threshold value for the metric

Max float64: Max threshold value for the metric
Min float64: Min threshold value for the metric

max Double: Max threshold value for the metric
min Double: Min threshold value for the metric

max number: Max threshold value for the metric
min number: Min threshold value for the metric

max float: Max threshold value for the metric
min float: Min threshold value for the metric

max Number: Max threshold value for the metric
min Number: Min threshold value for the metric

PerformanceResponse

Actual double: Observed value for the metric
Expected double: Threshold value for the metric
ExpectedValueRange Pulumi.AzureNative.Impact.Inputs.ExpectedValueRangeResponse: Max and Min Threshold values for the metric
MetricName string: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
Unit string: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

Actual float64: Observed value for the metric
Expected float64: Threshold value for the metric
ExpectedValueRange ExpectedValueRangeResponse: Max and Min Threshold values for the metric
MetricName string: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
Unit string: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

actual Double: Observed value for the metric
expected Double: Threshold value for the metric
expectedValueRange ExpectedValueRangeResponse: Max and Min Threshold values for the metric
metricName String: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
unit String: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

actual number: Observed value for the metric
expected number: Threshold value for the metric
expectedValueRange ExpectedValueRangeResponse: Max and Min Threshold values for the metric
metricName string: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
unit string: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

actual float: Observed value for the metric
expected float: Threshold value for the metric
expected_value_range ExpectedValueRangeResponse: Max and Min Threshold values for the metric
metric_name str: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
unit str: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

actual Number: Observed value for the metric
expected Number: Threshold value for the metric
expectedValueRange Property Map: Max and Min Threshold values for the metric
metricName String: Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API
unit String: Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other

SourceOrTargetResponse

AzureResourceId string: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

AzureResourceId string: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

azureResourceId String: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

azureResourceId string: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

azure_resource_id str: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

azureResourceId String: Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

WorkloadImpactPropertiesResponse

ImpactCategory string: Category of the impact, details can found from /impactCategories API
ImpactUniqueId string: Unique ID of the impact (UUID)
ImpactedResourceId string: Azure resource id of the impacted resource
ProvisioningState string: Resource provisioning state.
ReportedTimeUtc string: Time at which impact is reported
StartDateTime string: Time at which impact was observed
AdditionalProperties object: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
ArmCorrelationIds List<string>: The ARM correlation ids, this is important field for control plane related impacts
ClientIncidentDetails Pulumi.AzureNative.Impact.Inputs.ClientIncidentDetailsResponse: Client incident details ex: incidentId , incident source
ConfidenceLevel string: Degree of confidence on the impact being a platform issue
Connectivity Pulumi.AzureNative.Impact.Inputs.ConnectivityResponse: 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: Time at which impact has ended
ErrorDetails Pulumi.AzureNative.Impact.Inputs.ErrorDetailPropertiesResponse: ARM error code and error message associated with the impact
ImpactDescription string: A detailed description of the impact
ImpactGroupId string: Use this field to group impacts
Performance List<Pulumi.AzureNative.Impact.Inputs.PerformanceResponse>: Details about performance issue. Applicable for performance impacts.
Workload Pulumi.AzureNative.Impact.Inputs.WorkloadResponse: Information about the impacted workload

ImpactCategory string: Category of the impact, details can found from /impactCategories API
ImpactUniqueId string: Unique ID of the impact (UUID)
ImpactedResourceId string: Azure resource id of the impacted resource
ProvisioningState string: Resource provisioning state.
ReportedTimeUtc string: Time at which impact is reported
StartDateTime string: Time at which impact was observed
AdditionalProperties interface{}: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
ArmCorrelationIds []string: The ARM correlation ids, this is important field for control plane related impacts
ClientIncidentDetails ClientIncidentDetailsResponse: Client incident details ex: incidentId , incident source
ConfidenceLevel string: Degree of confidence on the impact being a platform issue
Connectivity ConnectivityResponse: 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: Time at which impact has ended
ErrorDetails ErrorDetailPropertiesResponse: ARM error code and error message associated with the impact
ImpactDescription string: A detailed description of the impact
ImpactGroupId string: Use this field to group impacts
Performance []PerformanceResponse: Details about performance issue. Applicable for performance impacts.
Workload WorkloadResponse: Information about the impacted workload

impactCategory String: Category of the impact, details can found from /impactCategories API
impactUniqueId String: Unique ID of the impact (UUID)
impactedResourceId String: Azure resource id of the impacted resource
provisioningState String: Resource provisioning state.
reportedTimeUtc String: Time at which impact is reported
startDateTime String: Time at which impact was observed
additionalProperties Object: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
armCorrelationIds List<String>: The ARM correlation ids, this is important field for control plane related impacts
clientIncidentDetails ClientIncidentDetailsResponse: Client incident details ex: incidentId , incident source
confidenceLevel String: Degree of confidence on the impact being a platform issue
connectivity ConnectivityResponse: 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: Time at which impact has ended
errorDetails ErrorDetailPropertiesResponse: ARM error code and error message associated with the impact
impactDescription String: A detailed description of the impact
impactGroupId String: Use this field to group impacts
performance List<PerformanceResponse>: Details about performance issue. Applicable for performance impacts.
workload WorkloadResponse: Information about the impacted workload

impactCategory string: Category of the impact, details can found from /impactCategories API
impactUniqueId string: Unique ID of the impact (UUID)
impactedResourceId string: Azure resource id of the impacted resource
provisioningState string: Resource provisioning state.
reportedTimeUtc string: Time at which impact is reported
startDateTime string: Time at which impact was observed
additionalProperties any: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
armCorrelationIds string[]: The ARM correlation ids, this is important field for control plane related impacts
clientIncidentDetails ClientIncidentDetailsResponse: Client incident details ex: incidentId , incident source
confidenceLevel string: Degree of confidence on the impact being a platform issue
connectivity ConnectivityResponse: 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: Time at which impact has ended
errorDetails ErrorDetailPropertiesResponse: ARM error code and error message associated with the impact
impactDescription string: A detailed description of the impact
impactGroupId string: Use this field to group impacts
performance PerformanceResponse[]: Details about performance issue. Applicable for performance impacts.
workload WorkloadResponse: Information about the impacted workload

impact_category str: Category of the impact, details can found from /impactCategories API
impact_unique_id str: Unique ID of the impact (UUID)
impacted_resource_id str: Azure resource id of the impacted resource
provisioning_state str: Resource provisioning state.
reported_time_utc str: Time at which impact is reported
start_date_time str: Time at which impact was observed
additional_properties Any: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
arm_correlation_ids Sequence[str]: The ARM correlation ids, this is important field for control plane related impacts
client_incident_details ClientIncidentDetailsResponse: Client incident details ex: incidentId , incident source
confidence_level str: Degree of confidence on the impact being a platform issue
connectivity ConnectivityResponse: 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
end_date_time str: Time at which impact has ended
error_details ErrorDetailPropertiesResponse: ARM error code and error message associated with the impact
impact_description str: A detailed description of the impact
impact_group_id str: Use this field to group impacts
performance Sequence[PerformanceResponse]: Details about performance issue. Applicable for performance impacts.
workload WorkloadResponse: Information about the impacted workload

impactCategory String: Category of the impact, details can found from /impactCategories API
impactUniqueId String: Unique ID of the impact (UUID)
impactedResourceId String: Azure resource id of the impacted resource
provisioningState String: Resource provisioning state.
reportedTimeUtc String: Time at which impact is reported
startDateTime String: Time at which impact was observed
additionalProperties Any: Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
armCorrelationIds List<String>: The ARM correlation ids, this is important field for control plane related impacts
clientIncidentDetails Property Map: Client incident details ex: incidentId , incident source
confidenceLevel String: Degree of confidence on the impact being a platform issue
connectivity Property Map: 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: Time at which impact has ended
errorDetails Property Map: ARM error code and error message associated with the impact
impactDescription String: A detailed description of the impact
impactGroupId String: Use this field to group impacts
performance List<Property Map>: Details about performance issue. Applicable for performance impacts.
workload Property Map: Information about the impacted workload

WorkloadResponse

Context string: the scenario for the workload
Toolset string: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

Context string: the scenario for the workload
Toolset string: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

context String: the scenario for the workload
toolset String: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

context string: the scenario for the workload
toolset string: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

context str: the scenario for the workload
toolset str: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

context String: the scenario for the workload
toolset String: Tool used to interact with Azure. SDK, AzPortal, etc.., Other

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.impact.getWorkloadImpact

On this page

On this page

Using getWorkloadImpact

getWorkloadImpact Result

Supporting Types

ClientIncidentDetailsResponse

ConnectivityResponse

ErrorDetailPropertiesResponse

ExpectedValueRangeResponse

PerformanceResponse

SourceOrTargetResponse

SystemDataResponse

WorkloadImpactPropertiesResponse

WorkloadResponse

Package Details

On this page

On this page