This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.impact.getWorkloadImpact
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Get a WorkloadImpact Azure REST API version: 2024-05-01-preview.
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.
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 dictionaryThe following arguments are supported:
- WorkloadImpact stringName 
- workloadImpact resource
- WorkloadImpact stringName 
- workloadImpact resource
- workloadImpact StringName 
- workloadImpact resource
- workloadImpact stringName 
- workloadImpact resource
- workload_impact_ strname 
- workloadImpact resource
- workloadImpact StringName 
- 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.Azure Native. Impact. Outputs. Workload Impact Properties Response 
- The resource-specific properties for this resource.
- SystemData Pulumi.Azure Native. Impact. Outputs. System Data Response 
- 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
WorkloadImpact Properties Response 
- The resource-specific properties for this resource.
- SystemData SystemData Response 
- 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
WorkloadImpact Properties Response 
- The resource-specific properties for this resource.
- systemData SystemData Response 
- 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
WorkloadImpact Properties Response 
- The resource-specific properties for this resource.
- systemData SystemData Response 
- 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
WorkloadImpact Properties Response 
- The resource-specific properties for this resource.
- system_data SystemData Response 
- 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   
- ClientIncident stringId 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- ClientIncident stringSource 
- Client incident source. ex : source system name where the incident is created
- ClientIncident stringId 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- ClientIncident stringSource 
- Client incident source. ex : source system name where the incident is created
- clientIncident StringId 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- clientIncident StringSource 
- Client incident source. ex : source system name where the incident is created
- clientIncident stringId 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- clientIncident stringSource 
- Client incident source. ex : source system name where the incident is created
- client_incident_ strid 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- client_incident_ strsource 
- Client incident source. ex : source system name where the incident is created
- clientIncident StringId 
- Client incident id. ex : id of the incident created to investigate and address the impact if any.
- clientIncident StringSource 
- 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.Azure Native. Impact. Inputs. Source Or Target Response 
- Source from which the connection was attempted
- Target
Pulumi.Azure Native. Impact. Inputs. Source Or Target Response 
- target which connection was attempted
- Port int
- Port number for the connection
- Protocol string
- Protocol used for the connection
- Source
SourceOr Target Response 
- Source from which the connection was attempted
- Target
SourceOr Target Response 
- target which connection was attempted
- port Integer
- Port number for the connection
- protocol String
- Protocol used for the connection
- source
SourceOr Target Response 
- Source from which the connection was attempted
- target
SourceOr Target Response 
- target which connection was attempted
- port number
- Port number for the connection
- protocol string
- Protocol used for the connection
- source
SourceOr Target Response 
- Source from which the connection was attempted
- target
SourceOr Target Response 
- target which connection was attempted
- port int
- Port number for the connection
- protocol str
- Protocol used for the connection
- source
SourceOr Target Response 
- Source from which the connection was attempted
- target
SourceOr Target Response 
- 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   
PerformanceResponse 
- Actual double
- Observed value for the metric
- Expected double
- Threshold value for the metric
- ExpectedValue Pulumi.Range Azure Native. Impact. Inputs. Expected Value Range Response 
- 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
- ExpectedValue ExpectedRange Value Range Response 
- 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
- expectedValue ExpectedRange Value Range Response 
- 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
- expectedValue ExpectedRange Value Range Response 
- 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_ Expectedrange Value Range Response 
- 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
- expectedValue Property MapRange 
- 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   
- AzureResource stringId 
- Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- AzureResource stringId 
- Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azureResource StringId 
- Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azureResource stringId 
- Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azure_resource_ strid 
- Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azureResource StringId 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
WorkloadImpactPropertiesResponse   
- ImpactCategory string
- Category of the impact, details can found from /impactCategories API
- ImpactUnique stringId 
- Unique ID of the impact (UUID)
- ImpactedResource stringId 
- Azure resource id of the impacted resource
- ProvisioningState string
- Resource provisioning state.
- ReportedTime stringUtc 
- Time at which impact is reported
- StartDate stringTime 
- Time at which impact was observed
- AdditionalProperties object
- Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- ArmCorrelation List<string>Ids 
- The ARM correlation ids, this is important field for control plane related impacts
- ClientIncident Pulumi.Details Azure Native. Impact. Inputs. Client Incident Details Response 
- Client incident details ex: incidentId , incident source
- ConfidenceLevel string
- Degree of confidence on the impact being a platform issue
- Connectivity
Pulumi.Azure Native. Impact. Inputs. Connectivity Response 
- 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
- EndDate stringTime 
- Time at which impact has ended
- ErrorDetails Pulumi.Azure Native. Impact. Inputs. Error Detail Properties Response 
- ARM error code and error message associated with the impact
- ImpactDescription string
- A detailed description of the impact
- ImpactGroup stringId 
- Use this field to group impacts
- Performance
List<Pulumi.Azure Native. Impact. Inputs. Performance Response> 
- Details about performance issue. Applicable for performance impacts.
- Workload
Pulumi.Azure Native. Impact. Inputs. Workload Response 
- Information about the impacted workload
- ImpactCategory string
- Category of the impact, details can found from /impactCategories API
- ImpactUnique stringId 
- Unique ID of the impact (UUID)
- ImpactedResource stringId 
- Azure resource id of the impacted resource
- ProvisioningState string
- Resource provisioning state.
- ReportedTime stringUtc 
- Time at which impact is reported
- StartDate stringTime 
- Time at which impact was observed
- AdditionalProperties interface{}
- Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- ArmCorrelation []stringIds 
- The ARM correlation ids, this is important field for control plane related impacts
- ClientIncident ClientDetails Incident Details Response 
- 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
- EndDate stringTime 
- Time at which impact has ended
- ErrorDetails ErrorDetail Properties Response 
- ARM error code and error message associated with the impact
- ImpactDescription string
- A detailed description of the impact
- ImpactGroup stringId 
- 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
- impactUnique StringId 
- Unique ID of the impact (UUID)
- impactedResource StringId 
- Azure resource id of the impacted resource
- provisioningState String
- Resource provisioning state.
- reportedTime StringUtc 
- Time at which impact is reported
- startDate StringTime 
- Time at which impact was observed
- additionalProperties Object
- Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- armCorrelation List<String>Ids 
- The ARM correlation ids, this is important field for control plane related impacts
- clientIncident ClientDetails Incident Details Response 
- 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
- endDate StringTime 
- Time at which impact has ended
- errorDetails ErrorDetail Properties Response 
- ARM error code and error message associated with the impact
- impactDescription String
- A detailed description of the impact
- impactGroup StringId 
- 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
- impactUnique stringId 
- Unique ID of the impact (UUID)
- impactedResource stringId 
- Azure resource id of the impacted resource
- provisioningState string
- Resource provisioning state.
- reportedTime stringUtc 
- Time at which impact is reported
- startDate stringTime 
- Time at which impact was observed
- additionalProperties any
- Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- armCorrelation string[]Ids 
- The ARM correlation ids, this is important field for control plane related impacts
- clientIncident ClientDetails Incident Details Response 
- 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
- endDate stringTime 
- Time at which impact has ended
- errorDetails ErrorDetail Properties Response 
- ARM error code and error message associated with the impact
- impactDescription string
- A detailed description of the impact
- impactGroup stringId 
- 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_ strid 
- Unique ID of the impact (UUID)
- impacted_resource_ strid 
- Azure resource id of the impacted resource
- provisioning_state str
- Resource provisioning state.
- reported_time_ strutc 
- Time at which impact is reported
- start_date_ strtime 
- 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_ Sequence[str]ids 
- The ARM correlation ids, this is important field for control plane related impacts
- client_incident_ Clientdetails Incident Details Response 
- 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_ strtime 
- Time at which impact has ended
- error_details ErrorDetail Properties Response 
- ARM error code and error message associated with the impact
- impact_description str
- A detailed description of the impact
- impact_group_ strid 
- 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
- impactUnique StringId 
- Unique ID of the impact (UUID)
- impactedResource StringId 
- Azure resource id of the impacted resource
- provisioningState String
- Resource provisioning state.
- reportedTime StringUtc 
- Time at which impact is reported
- startDate StringTime 
- Time at which impact was observed
- additionalProperties Any
- Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- armCorrelation List<String>Ids 
- The ARM correlation ids, this is important field for control plane related impacts
- clientIncident Property MapDetails 
- 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
- endDate StringTime 
- 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
- impactGroup StringId 
- 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 
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi