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.workloads.getAlert

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 getAlert

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 getAlert(args: GetAlertArgs, opts?: InvokeOptions): Promise<GetAlertResult>
function getAlertOutput(args: GetAlertOutputArgs, opts?: InvokeOptions): Output<GetAlertResult>

def get_alert(alert_name: Optional[str] = None,
              monitor_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAlertResult
def get_alert_output(alert_name: Optional[pulumi.Input[str]] = None,
              monitor_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAlertResult]

func LookupAlert(ctx *Context, args *LookupAlertArgs, opts ...InvokeOption) (*LookupAlertResult, error)
func LookupAlertOutput(ctx *Context, args *LookupAlertOutputArgs, opts ...InvokeOption) LookupAlertResultOutput

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

public static class GetAlert 
{
    public static Task<GetAlertResult> InvokeAsync(GetAlertArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertResult> Invoke(GetAlertInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlertResult> getAlert(GetAlertArgs args, InvokeOptions options)
public static Output<GetAlertResult> getAlert(GetAlertArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:workloads:getAlert
  arguments:
    # arguments dictionary

The following arguments are supported:

AlertName string: Name of the SAP monitor alert resource.
MonitorName string: Name of the SAP monitor resource.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

AlertName string: Name of the SAP monitor alert resource.
MonitorName string: Name of the SAP monitor resource.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

alertName String: Name of the SAP monitor alert resource.
monitorName String: Name of the SAP monitor resource.
resourceGroupName String: The name of the resource group. The name is case insensitive.

alertName string: Name of the SAP monitor alert resource.
monitorName string: Name of the SAP monitor resource.
resourceGroupName string: The name of the resource group. The name is case insensitive.

alert_name str: Name of the SAP monitor alert resource.
monitor_name str: Name of the SAP monitor resource.
resource_group_name str: The name of the resource group. The name is case insensitive.

alertName String: Name of the SAP monitor alert resource.
monitorName String: Name of the SAP monitor resource.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getAlert Result

The following output properties are available:

AlertRuleResourceId string: ID of the alert rule resource created.
Errors Pulumi.AzureNative.Workloads.Outputs.ErrorDetailResponse: Defines the alert instance errors.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string: The name of the resource
ProvisioningState string: State of provisioning of the alert instance
SystemData Pulumi.AzureNative.Workloads.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"
AlertRuleProperties Pulumi.AzureNative.Workloads.Outputs.AlertRulePropertiesResponse: Describes the properties of an alert.
ProviderNames List<string>: Name of provider instances associated with the alert.
ProviderType string: The provider type for alert. For example, the value can be SapHana.
TemplateName string: Name of the alert template from which it was created.

AlertRuleResourceId string: ID of the alert rule resource created.
Errors ErrorDetailResponse: Defines the alert instance errors.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string: The name of the resource
ProvisioningState string: State of provisioning of the alert instance
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"
AlertRuleProperties AlertRulePropertiesResponse: Describes the properties of an alert.
ProviderNames []string: Name of provider instances associated with the alert.
ProviderType string: The provider type for alert. For example, the value can be SapHana.
TemplateName string: Name of the alert template from which it was created.

alertRuleResourceId String: ID of the alert rule resource created.
errors ErrorDetailResponse: Defines the alert instance errors.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String: The name of the resource
provisioningState String: State of provisioning of the alert instance
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"
alertRuleProperties AlertRulePropertiesResponse: Describes the properties of an alert.
providerNames List<String>: Name of provider instances associated with the alert.
providerType String: The provider type for alert. For example, the value can be SapHana.
templateName String: Name of the alert template from which it was created.

alertRuleResourceId string: ID of the alert rule resource created.
errors ErrorDetailResponse: Defines the alert instance errors.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string: The name of the resource
provisioningState string: State of provisioning of the alert instance
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"
alertRuleProperties AlertRulePropertiesResponse: Describes the properties of an alert.
providerNames string[]: Name of provider instances associated with the alert.
providerType string: The provider type for alert. For example, the value can be SapHana.
templateName string: Name of the alert template from which it was created.

alert_rule_resource_id str: ID of the alert rule resource created.
errors ErrorDetailResponse: Defines the alert instance errors.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str: The name of the resource
provisioning_state str: State of provisioning of the alert instance
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"
alert_rule_properties AlertRulePropertiesResponse: Describes the properties of an alert.
provider_names Sequence[str]: Name of provider instances associated with the alert.
provider_type str: The provider type for alert. For example, the value can be SapHana.
template_name str: Name of the alert template from which it was created.

alertRuleResourceId String: ID of the alert rule resource created.
errors Property Map: Defines the alert instance errors.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String: The name of the resource
provisioningState String: State of provisioning of the alert instance
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"
alertRuleProperties Property Map: Describes the properties of an alert.
providerNames List<String>: Name of provider instances associated with the alert.
providerType String: The provider type for alert. For example, the value can be SapHana.
templateName String: Name of the alert template from which it was created.

Supporting Types

AlertQueryParameterResponse

Name string: The name of the alert query parameter.
Value string: The value of the alert query parameter.

Name string: The name of the alert query parameter.
Value string: The value of the alert query parameter.

name String: The name of the alert query parameter.
value String: The value of the alert query parameter.

name string: The name of the alert query parameter.
value string: The value of the alert query parameter.

name str: The name of the alert query parameter.
value str: The value of the alert query parameter.

name String: The name of the alert query parameter.
value String: The value of the alert query parameter.

AlertRulePropertiesResponse

ActionGroups List<string>: Action Group resource Ids to invoke when the alert fires
AlertQueryParameters List<Pulumi.AzureNative.Workloads.Inputs.AlertQueryParameterResponse>: The alert query parameters.
AutoMitigate string: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
Dimension string: Evaluation of metric on a particular column.
EvaluationFrequency int: How often the scheduled query rule is evaluated.
FailingPeriodsOperator string: The operator for failing periods.
FailingPeriodsToAlert int: The number of failing periods to trigger an alert.
MuteActionsDuration int: Mute actions for the chosen period of time after the alert is fired.
Severity int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
Status string: Indicates whether the alert is in an enabled state.
Threshold int: The threshold of the alert.
ThresholdOperator string: The threshold operator of the alert.
WindowSize int: The period of time on which the Alert query will be executed.

ActionGroups []string: Action Group resource Ids to invoke when the alert fires
AlertQueryParameters []AlertQueryParameterResponse: The alert query parameters.
AutoMitigate string: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
Dimension string: Evaluation of metric on a particular column.
EvaluationFrequency int: How often the scheduled query rule is evaluated.
FailingPeriodsOperator string: The operator for failing periods.
FailingPeriodsToAlert int: The number of failing periods to trigger an alert.
MuteActionsDuration int: Mute actions for the chosen period of time after the alert is fired.
Severity int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
Status string: Indicates whether the alert is in an enabled state.
Threshold int: The threshold of the alert.
ThresholdOperator string: The threshold operator of the alert.
WindowSize int: The period of time on which the Alert query will be executed.

actionGroups List<String>: Action Group resource Ids to invoke when the alert fires
alertQueryParameters List<AlertQueryParameterResponse>: The alert query parameters.
autoMitigate String: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
dimension String: Evaluation of metric on a particular column.
evaluationFrequency Integer: How often the scheduled query rule is evaluated.
failingPeriodsOperator String: The operator for failing periods.
failingPeriodsToAlert Integer: The number of failing periods to trigger an alert.
muteActionsDuration Integer: Mute actions for the chosen period of time after the alert is fired.
severity Integer: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
status String: Indicates whether the alert is in an enabled state.
threshold Integer: The threshold of the alert.
thresholdOperator String: The threshold operator of the alert.
windowSize Integer: The period of time on which the Alert query will be executed.

actionGroups string[]: Action Group resource Ids to invoke when the alert fires
alertQueryParameters AlertQueryParameterResponse[]: The alert query parameters.
autoMitigate string: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
dimension string: Evaluation of metric on a particular column.
evaluationFrequency number: How often the scheduled query rule is evaluated.
failingPeriodsOperator string: The operator for failing periods.
failingPeriodsToAlert number: The number of failing periods to trigger an alert.
muteActionsDuration number: Mute actions for the chosen period of time after the alert is fired.
severity number: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
status string: Indicates whether the alert is in an enabled state.
threshold number: The threshold of the alert.
thresholdOperator string: The threshold operator of the alert.
windowSize number: The period of time on which the Alert query will be executed.

action_groups Sequence[str]: Action Group resource Ids to invoke when the alert fires
alert_query_parameters Sequence[AlertQueryParameterResponse]: The alert query parameters.
auto_mitigate str: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
dimension str: Evaluation of metric on a particular column.
evaluation_frequency int: How often the scheduled query rule is evaluated.
failing_periods_operator str: The operator for failing periods.
failing_periods_to_alert int: The number of failing periods to trigger an alert.
mute_actions_duration int: Mute actions for the chosen period of time after the alert is fired.
severity int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
status str: Indicates whether the alert is in an enabled state.
threshold int: The threshold of the alert.
threshold_operator str: The threshold operator of the alert.
window_size int: The period of time on which the Alert query will be executed.

actionGroups List<String>: Action Group resource Ids to invoke when the alert fires
alertQueryParameters List<Property Map>: The alert query parameters.
autoMitigate String: The value that indicates whether the alert should be automatically resolved or not. The default is Disable.
dimension String: Evaluation of metric on a particular column.
evaluationFrequency Number: How often the scheduled query rule is evaluated.
failingPeriodsOperator String: The operator for failing periods.
failingPeriodsToAlert Number: The number of failing periods to trigger an alert.
muteActionsDuration Number: Mute actions for the chosen period of time after the alert is fired.
severity Number: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest.
status String: Indicates whether the alert is in an enabled state.
threshold Number: The threshold of the alert.
thresholdOperator String: The threshold operator of the alert.
windowSize Number: The period of time on which the Alert query will be executed.

ErrorAdditionalInfoResponse

Info object: The additional info.
Type string: The additional info type.

Info interface{}: The additional info.
Type string: The additional info type.

info Object: The additional info.
type String: The additional info type.

info any: The additional info.
type string: The additional info type.

info Any: The additional info.
type str: The additional info type.

info Any: The additional info.
type String: The additional info type.

ErrorDetailResponse

AdditionalInfo List<Pulumi.AzureNative.Workloads.Inputs.ErrorAdditionalInfoResponse>: The error additional info.
Code string: The error code.
Details List<Pulumi.AzureNative.Workloads.Inputs.ErrorDetailResponse>: The error details.
Message string: The error message.
Target string: The error target.

AdditionalInfo []ErrorAdditionalInfoResponse: The error additional info.
Code string: The error code.
Details []ErrorDetailResponse: The error details.
Message string: The error message.
Target string: The error target.

additionalInfo List<ErrorAdditionalInfoResponse>: The error additional info.
code String: The error code.
details List<ErrorDetailResponse>: The error details.
message String: The error message.
target String: The error target.

additionalInfo ErrorAdditionalInfoResponse[]: The error additional info.
code string: The error code.
details ErrorDetailResponse[]: The error details.
message string: The error message.
target string: The error target.

additional_info Sequence[ErrorAdditionalInfoResponse]: The error additional info.
code str: The error code.
details Sequence[ErrorDetailResponse]: The error details.
message str: The error message.
target str: The error target.

additionalInfo List<Property Map>: The error additional info.
code String: The error code.
details List<Property Map>: The error details.
message String: The error message.
target String: The error target.

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.

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.workloads.getAlert

On this page

On this page

Using getAlert

getAlert Result

Supporting Types

AlertQueryParameterResponse

AlertRulePropertiesResponse

ErrorAdditionalInfoResponse

ErrorDetailResponse

SystemDataResponse

Package Details

On this page

On this page