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.73.0 published on Wednesday, Nov 20, 2024 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.73.0 published on Wednesday, Nov 20, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:impact:getWorkloadImpact
arguments:
# arguments dictionary
The following arguments are supported:
- Workload
Impact stringName - workloadImpact resource
- Workload
Impact stringName - workloadImpact resource
- workload
Impact StringName - workloadImpact resource
- workload
Impact stringName - workloadImpact resource
- workload_
impact_ strname - workloadImpact resource
- workload
Impact 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.
- System
Data 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
Workload
Impact Properties Response - The resource-specific properties for this resource.
- System
Data 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
Workload
Impact Properties Response - The resource-specific properties for this resource.
- system
Data 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
Workload
Impact Properties Response - The resource-specific properties for this resource.
- system
Data 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
Workload
Impact 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.
- system
Data 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
- Client
Incident stringId - Client incident id. ex : id of the incident created to investigate and address the impact if any.
- Client
Incident stringSource - Client incident source. ex : source system name where the incident is created
- Client
Incident stringId - Client incident id. ex : id of the incident created to investigate and address the impact if any.
- Client
Incident stringSource - Client incident source. ex : source system name where the incident is created
- client
Incident StringId - Client incident id. ex : id of the incident created to investigate and address the impact if any.
- client
Incident StringSource - Client incident source. ex : source system name where the incident is created
- client
Incident stringId - Client incident id. ex : id of the incident created to investigate and address the impact if any.
- client
Incident 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
- client
Incident StringId - Client incident id. ex : id of the incident created to investigate and address the impact if any.
- client
Incident 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
Source
Or Target Response - Source from which the connection was attempted
- Target
Source
Or Target Response - target which connection was attempted
- port Integer
- Port number for the connection
- protocol String
- Protocol used for the connection
- source
Source
Or Target Response - Source from which the connection was attempted
- target
Source
Or Target Response - target which connection was attempted
- port number
- Port number for the connection
- protocol string
- Protocol used for the connection
- source
Source
Or Target Response - Source from which the connection was attempted
- target
Source
Or Target Response - target which connection was attempted
- port int
- Port number for the connection
- protocol str
- Protocol used for the connection
- source
Source
Or Target Response - Source from which the connection was attempted
- target
Source
Or 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
- Error
Code string - ARM Error code associated with the impact.
- Error
Message string - ARM Error Message associated with the impact
- Error
Code string - ARM Error code associated with the impact.
- Error
Message string - ARM Error Message associated with the impact
- error
Code String - ARM Error code associated with the impact.
- error
Message String - ARM Error Message associated with the impact
- error
Code string - ARM Error code associated with the impact.
- error
Message 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
- error
Code String - ARM Error code associated with the impact.
- error
Message String - ARM Error Message associated with the impact
ExpectedValueRangeResponse
PerformanceResponse
- Actual double
- Observed value for the metric
- Expected double
- Threshold value for the metric
- Expected
Value Pulumi.Range Azure Native. Impact. Inputs. Expected Value Range Response - Max and Min Threshold values for the metric
- Metric
Name 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
- Expected
Value ExpectedRange Value Range Response - Max and Min Threshold values for the metric
- Metric
Name 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
- expected
Value ExpectedRange Value Range Response - Max and Min Threshold values for the metric
- metric
Name 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
- expected
Value ExpectedRange Value Range Response - Max and Min Threshold values for the metric
- metric
Name 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
- expected
Value Property MapRange - Max and Min Threshold values for the metric
- metric
Name 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
- Azure
Resource stringId - Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- Azure
Resource stringId - Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azure
Resource StringId - Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
- azure
Resource 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}
- azure
Resource StringId - Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName}
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified 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.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
WorkloadImpactPropertiesResponse
- Impact
Category string - Category of the impact, details can found from /impactCategories API
- Impact
Unique stringId - Unique ID of the impact (UUID)
- Impacted
Resource stringId - Azure resource id of the impacted resource
- Provisioning
State string - Resource provisioning state.
- Reported
Time stringUtc - Time at which impact is reported
- Start
Date stringTime - Time at which impact was observed
- Additional
Properties object - Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- Arm
Correlation List<string>Ids - The ARM correlation ids, this is important field for control plane related impacts
- Client
Incident Pulumi.Details Azure Native. Impact. Inputs. Client Incident Details Response - Client incident details ex: incidentId , incident source
- Confidence
Level 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
- End
Date stringTime - Time at which impact has ended
- Error
Details Pulumi.Azure Native. Impact. Inputs. Error Detail Properties Response - ARM error code and error message associated with the impact
- Impact
Description string - A detailed description of the impact
- Impact
Group 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
- Impact
Category string - Category of the impact, details can found from /impactCategories API
- Impact
Unique stringId - Unique ID of the impact (UUID)
- Impacted
Resource stringId - Azure resource id of the impacted resource
- Provisioning
State string - Resource provisioning state.
- Reported
Time stringUtc - Time at which impact is reported
- Start
Date stringTime - Time at which impact was observed
- Additional
Properties interface{} - Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- Arm
Correlation []stringIds - 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 string - Degree of confidence on the impact being a platform issue
- Connectivity
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
- End
Date stringTime - Time at which impact has ended
- Error
Details ErrorDetail Properties Response - ARM error code and error message associated with the impact
- Impact
Description string - A detailed description of the impact
- Impact
Group stringId - Use this field to group impacts
- Performance
[]Performance
Response - Details about performance issue. Applicable for performance impacts.
- Workload
Workload
Response - Information about the impacted workload
- impact
Category String - Category of the impact, details can found from /impactCategories API
- impact
Unique StringId - Unique ID of the impact (UUID)
- impacted
Resource StringId - Azure resource id of the impacted resource
- provisioning
State String - Resource provisioning state.
- reported
Time StringUtc - Time at which impact is reported
- start
Date StringTime - Time at which impact was observed
- additional
Properties Object - Additional fields related to impact, applicable fields per resource type are list under /impactCategories API
- arm
Correlation List<String>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 String - Degree of confidence on the impact being a platform issue
- connectivity
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
- end
Date StringTime - Time at which impact has ended
- error
Details ErrorDetail Properties Response - ARM error code and error message associated with the impact
- impact
Description String - A detailed description of the impact
- impact
Group StringId - Use this field to group impacts
- performance
List<Performance
Response> - Details about performance issue. Applicable for performance impacts.
- workload
Workload
Response - Information about the impacted workload
- impact
Category string - Category of the impact, details can found from /impactCategories API
- impact
Unique stringId - Unique ID of the impact (UUID)
- impacted
Resource stringId - Azure resource id of the impacted resource
- provisioning
State string - Resource provisioning state.
- reported
Time stringUtc - Time at which impact is reported
- start
Date stringTime - 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 string[]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 string - Degree of confidence on the impact being a platform issue
- connectivity
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
- end
Date stringTime - Time at which impact has ended
- error
Details ErrorDetail Properties Response - ARM error code and error message associated with the impact
- impact
Description string - A detailed description of the impact
- impact
Group stringId - Use this field to group impacts
- performance
Performance
Response[] - Details about performance issue. Applicable for performance impacts.
- workload
Workload
Response - 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
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
- 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[Performance
Response] - Details about performance issue. Applicable for performance impacts.
- workload
Workload
Response - Information about the impacted workload
- impact
Category String - Category of the impact, details can found from /impactCategories API
- impact
Unique StringId - Unique ID of the impact (UUID)
- impacted
Resource StringId - Azure resource id of the impacted resource
- provisioning
State String - Resource provisioning state.
- reported
Time StringUtc - Time at which impact is reported
- start
Date StringTime - 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 List<String>Ids - The ARM correlation ids, this is important field for control plane related impacts
- client
Incident Property MapDetails - Client incident details ex: incidentId , incident source
- confidence
Level 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
- end
Date StringTime - Time at which impact has ended
- error
Details Property Map - ARM error code and error message associated with the impact
- impact
Description String - A detailed description of the impact
- impact
Group 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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi