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.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.workloads.getAlert
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.77.0 published on Thursday, Dec 12, 2024 by Pulumi
Gets properties of an alert for the specified subscription, resource group, SAP monitor name, and resource name. Azure REST API version: 2024-02-01-preview.
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:workloads:getAlert
arguments:
# arguments dictionary
The following arguments are supported:
- Alert
Name string - Name of the SAP monitor alert resource.
- Monitor
Name string - Name of the SAP monitor resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Alert
Name string - Name of the SAP monitor alert resource.
- Monitor
Name string - Name of the SAP monitor resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- alert
Name String - Name of the SAP monitor alert resource.
- monitor
Name String - Name of the SAP monitor resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- alert
Name string - Name of the SAP monitor alert resource.
- monitor
Name string - Name of the SAP monitor resource.
- resource
Group stringName - 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_ strname - The name of the resource group. The name is case insensitive.
- alert
Name String - Name of the SAP monitor alert resource.
- monitor
Name String - Name of the SAP monitor resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getAlert Result
The following output properties are available:
- Alert
Rule stringResource Id - ID of the alert rule resource created.
- Errors
Pulumi.
Azure Native. Workloads. Outputs. Error Detail Response - 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
- Provisioning
State string - State of provisioning of the alert instance
- System
Data Pulumi.Azure Native. Workloads. 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"
- Alert
Rule Pulumi.Properties Azure Native. Workloads. Outputs. Alert Rule Properties Response - Describes the properties of an alert.
- Provider
Names List<string> - Name of provider instances associated with the alert.
- Provider
Type string - The provider type for alert. For example, the value can be SapHana.
- Template
Name string - Name of the alert template from which it was created.
- Alert
Rule stringResource Id - ID of the alert rule resource created.
- Errors
Error
Detail Response - 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
- Provisioning
State string - State of provisioning of the alert instance
- 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"
- Alert
Rule AlertProperties Rule Properties Response - Describes the properties of an alert.
- Provider
Names []string - Name of provider instances associated with the alert.
- Provider
Type string - The provider type for alert. For example, the value can be SapHana.
- Template
Name string - Name of the alert template from which it was created.
- alert
Rule StringResource Id - ID of the alert rule resource created.
- errors
Error
Detail Response - 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
- provisioning
State String - State of provisioning of the alert instance
- 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"
- alert
Rule AlertProperties Rule Properties Response - Describes the properties of an alert.
- provider
Names List<String> - Name of provider instances associated with the alert.
- provider
Type String - The provider type for alert. For example, the value can be SapHana.
- template
Name String - Name of the alert template from which it was created.
- alert
Rule stringResource Id - ID of the alert rule resource created.
- errors
Error
Detail Response - 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
- provisioning
State string - State of provisioning of the alert instance
- 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"
- alert
Rule AlertProperties Rule Properties Response - Describes the properties of an alert.
- provider
Names string[] - Name of provider instances associated with the alert.
- provider
Type string - The provider type for alert. For example, the value can be SapHana.
- template
Name string - Name of the alert template from which it was created.
- alert_
rule_ strresource_ id - ID of the alert rule resource created.
- errors
Error
Detail Response - 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 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"
- alert_
rule_ Alertproperties Rule Properties Response - 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.
- alert
Rule StringResource Id - 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
- provisioning
State String - State of provisioning of the alert instance
- 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"
- alert
Rule Property MapProperties - Describes the properties of an alert.
- provider
Names List<String> - Name of provider instances associated with the alert.
- provider
Type String - The provider type for alert. For example, the value can be SapHana.
- template
Name String - Name of the alert template from which it was created.
Supporting Types
AlertQueryParameterResponse
AlertRulePropertiesResponse
- Action
Groups List<string> - Action Group resource Ids to invoke when the alert fires
- Alert
Query List<Pulumi.Parameters Azure Native. Workloads. Inputs. Alert Query Parameter Response> - The alert query parameters.
- Auto
Mitigate 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.
- Evaluation
Frequency int - How often the scheduled query rule is evaluated.
- Failing
Periods stringOperator - The operator for failing periods.
- Failing
Periods intTo Alert - The number of failing periods to trigger an alert.
- Mute
Actions intDuration - 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.
- Threshold
Operator string - The threshold operator of the alert.
- Window
Size int - The period of time on which the Alert query will be executed.
- Action
Groups []string - Action Group resource Ids to invoke when the alert fires
- Alert
Query []AlertParameters Query Parameter Response - The alert query parameters.
- Auto
Mitigate 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.
- Evaluation
Frequency int - How often the scheduled query rule is evaluated.
- Failing
Periods stringOperator - The operator for failing periods.
- Failing
Periods intTo Alert - The number of failing periods to trigger an alert.
- Mute
Actions intDuration - 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.
- Threshold
Operator string - The threshold operator of the alert.
- Window
Size int - The period of time on which the Alert query will be executed.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires
- alert
Query List<AlertParameters Query Parameter Response> - The alert query parameters.
- auto
Mitigate 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.
- evaluation
Frequency Integer - How often the scheduled query rule is evaluated.
- failing
Periods StringOperator - The operator for failing periods.
- failing
Periods IntegerTo Alert - The number of failing periods to trigger an alert.
- mute
Actions IntegerDuration - 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.
- threshold
Operator String - The threshold operator of the alert.
- window
Size Integer - The period of time on which the Alert query will be executed.
- action
Groups string[] - Action Group resource Ids to invoke when the alert fires
- alert
Query AlertParameters Query Parameter Response[] - The alert query parameters.
- auto
Mitigate 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.
- evaluation
Frequency number - How often the scheduled query rule is evaluated.
- failing
Periods stringOperator - The operator for failing periods.
- failing
Periods numberTo Alert - The number of failing periods to trigger an alert.
- mute
Actions numberDuration - 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.
- threshold
Operator string - The threshold operator of the alert.
- window
Size 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_ Sequence[Alertparameters Query Parameter Response] - 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_ stroperator - The operator for failing periods.
- failing_
periods_ intto_ alert - The number of failing periods to trigger an alert.
- mute_
actions_ intduration - 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.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires
- alert
Query List<Property Map>Parameters - The alert query parameters.
- auto
Mitigate 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.
- evaluation
Frequency Number - How often the scheduled query rule is evaluated.
- failing
Periods StringOperator - The operator for failing periods.
- failing
Periods NumberTo Alert - The number of failing periods to trigger an alert.
- mute
Actions NumberDuration - 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.
- threshold
Operator String - The threshold operator of the alert.
- window
Size Number - The period of time on which the Alert query will be executed.
ErrorAdditionalInfoResponse
ErrorDetailResponse
- Additional
Info List<Pulumi.Azure Native. Workloads. Inputs. Error Additional Info Response> - The error additional info.
- Code string
- The error code.
- Details
List<Pulumi.
Azure Native. Workloads. Inputs. Error Detail Response> - The error details.
- Message string
- The error message.
- Target string
- The error target.
- Additional
Info []ErrorAdditional Info Response - The error additional info.
- Code string
- The error code.
- Details
[]Error
Detail Response - The error details.
- Message string
- The error message.
- Target string
- The error target.
- additional
Info List<ErrorAdditional Info Response> - The error additional info.
- code String
- The error code.
- details
List<Error
Detail Response> - The error details.
- message String
- The error message.
- target String
- The error target.
- additional
Info ErrorAdditional Info Response[] - The error additional info.
- code string
- The error code.
- details
Error
Detail Response[] - The error details.
- message string
- The error message.
- target string
- The error target.
- additional_
info Sequence[ErrorAdditional Info Response] - The error additional info.
- code str
- The error code.
- details
Sequence[Error
Detail Response] - The error details.
- message str
- The error message.
- target str
- The error target.
- additional
Info 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
- 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.
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.77.0 published on Thursday, Dec 12, 2024 by Pulumi