Equinix v0.23.1 published on Wednesday, Jul 16, 2025 by Equinix
equinix.fabric.getStreamAlertRule
Explore with Pulumi AI
Fabric V4 API compatible data source that allows user to fetch Equinix Fabric Stream Alert Rule by Stream Id and Alert Rule Id
Additional Documentation:
- Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
- API: https://developer.equinix.com/catalog/fabricv4#tag/Stream-Alert-Rules
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.FabricFunctions;
import com.pulumi.equinix.fabric.inputs.GetStreamAlertRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var dataStreamAlertRule = FabricFunctions.getStreamAlertRule(GetStreamAlertRuleArgs.builder()
.streamId("<uuid_of_stream>")
.streamAlertRuleId("<uuid_of_stream_alert_rule>")
.build());
ctx.export("streamAlertRuleType", data.equinix_fabric_stream_alert_rule().alert_rule().type());
ctx.export("streamAlertRuleId", data.equinix_fabric_stream_alert_rule().alert_rule().uuid());
ctx.export("streamAlertRuleState", data.equinix_fabric_stream_alert_rule().alert_rule().state());
ctx.export("streamAlertRuleStreamId", data.equinix_fabric_stream_alert_rule().alert_rule().stream_id());
}
}
variables:
dataStreamAlertRule:
fn::invoke:
function: equinix:fabric:getStreamAlertRule
arguments:
streamId: <uuid_of_stream>
streamAlertRuleId: <uuid_of_stream_alert_rule>
outputs:
streamAlertRuleType: ${data.equinix_fabric_stream_alert_rule.alert_rule.type}
streamAlertRuleId: ${data.equinix_fabric_stream_alert_rule.alert_rule.uuid}
streamAlertRuleState: ${data.equinix_fabric_stream_alert_rule.alert_rule.state}
streamAlertRuleStreamId: ${data.equinix_fabric_stream_alert_rule.alert_rule.stream_id}
Using getStreamAlertRule
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 getStreamAlertRule(args: GetStreamAlertRuleArgs, opts?: InvokeOptions): Promise<GetStreamAlertRuleResult>
function getStreamAlertRuleOutput(args: GetStreamAlertRuleOutputArgs, opts?: InvokeOptions): Output<GetStreamAlertRuleResult>
def get_stream_alert_rule(alert_rule_id: Optional[str] = None,
stream_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamAlertRuleResult
def get_stream_alert_rule_output(alert_rule_id: Optional[pulumi.Input[str]] = None,
stream_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamAlertRuleResult]
func LookupStreamAlertRule(ctx *Context, args *LookupStreamAlertRuleArgs, opts ...InvokeOption) (*LookupStreamAlertRuleResult, error)
func LookupStreamAlertRuleOutput(ctx *Context, args *LookupStreamAlertRuleOutputArgs, opts ...InvokeOption) LookupStreamAlertRuleResultOutput
> Note: This function is named LookupStreamAlertRule
in the Go SDK.
public static class GetStreamAlertRule
{
public static Task<GetStreamAlertRuleResult> InvokeAsync(GetStreamAlertRuleArgs args, InvokeOptions? opts = null)
public static Output<GetStreamAlertRuleResult> Invoke(GetStreamAlertRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamAlertRuleResult> getStreamAlertRule(GetStreamAlertRuleArgs args, InvokeOptions options)
public static Output<GetStreamAlertRuleResult> getStreamAlertRule(GetStreamAlertRuleArgs args, InvokeOptions options)
fn::invoke:
function: equinix:fabric/getStreamAlertRule:getStreamAlertRule
arguments:
# arguments dictionary
The following arguments are supported:
- Alert
Rule stringId - The uuid of the stream alert rule
- Stream
Id string - The uuid of the stream that is the target of the stream alert rule
- Alert
Rule stringId - The uuid of the stream alert rule
- Stream
Id string - The uuid of the stream that is the target of the stream alert rule
- alert
Rule StringId - The uuid of the stream alert rule
- stream
Id String - The uuid of the stream that is the target of the stream alert rule
- alert
Rule stringId - The uuid of the stream alert rule
- stream
Id string - The uuid of the stream that is the target of the stream alert rule
- alert_
rule_ strid - The uuid of the stream alert rule
- stream_
id str - The uuid of the stream that is the target of the stream alert rule
- alert
Rule StringId - The uuid of the stream alert rule
- stream
Id String - The uuid of the stream that is the target of the stream alert rule
getStreamAlertRule Result
The following output properties are available:
- Alert
Rule stringId - The uuid of the stream alert rule
- Change
Log GetStream Alert Rule Change Log - Details of the last change on the stream resource
- Critical
Threshold string - Stream alert rule metric critical threshold
- Description string
- Customer-provided stream alert rule description
- Enabled bool
- Stream subscription enabled status
- Href string
- Equinix assigned URI of the stream alert rule resource
- Id string
- The unique identifier of the resource
- Metric
Name string - Stream alert rule metric name
- Name string
- Customer-provided stream alert rule name
- Operand string
- Stream alert rule metric operand
- Resource
Selector GetStream Alert Rule Resource Selector - Lists of metrics to be included/excluded on the stream alert rule
- State string
- Value representing provisioning status for the stream resource
- Stream
Id string - The uuid of the stream that is the target of the stream alert rule
- Type string
- Type of the stream alert rule
- Uuid string
- Equinix assigned unique identifier of the stream subscription resource
- Warning
Threshold string - Stream alert rule metric warning threshold
- Window
Size string - Stream alert rule metric window size
- Alert
Rule stringId - The uuid of the stream alert rule
- Change
Log GetStream Alert Rule Change Log - Details of the last change on the stream resource
- Critical
Threshold string - Stream alert rule metric critical threshold
- Description string
- Customer-provided stream alert rule description
- Enabled bool
- Stream subscription enabled status
- Href string
- Equinix assigned URI of the stream alert rule resource
- Id string
- The unique identifier of the resource
- Metric
Name string - Stream alert rule metric name
- Name string
- Customer-provided stream alert rule name
- Operand string
- Stream alert rule metric operand
- Resource
Selector GetStream Alert Rule Resource Selector - Lists of metrics to be included/excluded on the stream alert rule
- State string
- Value representing provisioning status for the stream resource
- Stream
Id string - The uuid of the stream that is the target of the stream alert rule
- Type string
- Type of the stream alert rule
- Uuid string
- Equinix assigned unique identifier of the stream subscription resource
- Warning
Threshold string - Stream alert rule metric warning threshold
- Window
Size string - Stream alert rule metric window size
- alert
Rule StringId - The uuid of the stream alert rule
- change
Log GetStream Alert Rule Change Log - Details of the last change on the stream resource
- critical
Threshold String - Stream alert rule metric critical threshold
- description String
- Customer-provided stream alert rule description
- enabled Boolean
- Stream subscription enabled status
- href String
- Equinix assigned URI of the stream alert rule resource
- id String
- The unique identifier of the resource
- metric
Name String - Stream alert rule metric name
- name String
- Customer-provided stream alert rule name
- operand String
- Stream alert rule metric operand
- resource
Selector GetStream Alert Rule Resource Selector - Lists of metrics to be included/excluded on the stream alert rule
- state String
- Value representing provisioning status for the stream resource
- stream
Id String - The uuid of the stream that is the target of the stream alert rule
- type String
- Type of the stream alert rule
- uuid String
- Equinix assigned unique identifier of the stream subscription resource
- warning
Threshold String - Stream alert rule metric warning threshold
- window
Size String - Stream alert rule metric window size
- alert
Rule stringId - The uuid of the stream alert rule
- change
Log GetStream Alert Rule Change Log - Details of the last change on the stream resource
- critical
Threshold string - Stream alert rule metric critical threshold
- description string
- Customer-provided stream alert rule description
- enabled boolean
- Stream subscription enabled status
- href string
- Equinix assigned URI of the stream alert rule resource
- id string
- The unique identifier of the resource
- metric
Name string - Stream alert rule metric name
- name string
- Customer-provided stream alert rule name
- operand string
- Stream alert rule metric operand
- resource
Selector GetStream Alert Rule Resource Selector - Lists of metrics to be included/excluded on the stream alert rule
- state string
- Value representing provisioning status for the stream resource
- stream
Id string - The uuid of the stream that is the target of the stream alert rule
- type string
- Type of the stream alert rule
- uuid string
- Equinix assigned unique identifier of the stream subscription resource
- warning
Threshold string - Stream alert rule metric warning threshold
- window
Size string - Stream alert rule metric window size
- alert_
rule_ strid - The uuid of the stream alert rule
- change_
log GetStream Alert Rule Change Log - Details of the last change on the stream resource
- critical_
threshold str - Stream alert rule metric critical threshold
- description str
- Customer-provided stream alert rule description
- enabled bool
- Stream subscription enabled status
- href str
- Equinix assigned URI of the stream alert rule resource
- id str
- The unique identifier of the resource
- metric_
name str - Stream alert rule metric name
- name str
- Customer-provided stream alert rule name
- operand str
- Stream alert rule metric operand
- resource_
selector GetStream Alert Rule Resource Selector - Lists of metrics to be included/excluded on the stream alert rule
- state str
- Value representing provisioning status for the stream resource
- stream_
id str - The uuid of the stream that is the target of the stream alert rule
- type str
- Type of the stream alert rule
- uuid str
- Equinix assigned unique identifier of the stream subscription resource
- warning_
threshold str - Stream alert rule metric warning threshold
- window_
size str - Stream alert rule metric window size
- alert
Rule StringId - The uuid of the stream alert rule
- change
Log Property Map - Details of the last change on the stream resource
- critical
Threshold String - Stream alert rule metric critical threshold
- description String
- Customer-provided stream alert rule description
- enabled Boolean
- Stream subscription enabled status
- href String
- Equinix assigned URI of the stream alert rule resource
- id String
- The unique identifier of the resource
- metric
Name String - Stream alert rule metric name
- name String
- Customer-provided stream alert rule name
- operand String
- Stream alert rule metric operand
- resource
Selector Property Map - Lists of metrics to be included/excluded on the stream alert rule
- state String
- Value representing provisioning status for the stream resource
- stream
Id String - The uuid of the stream that is the target of the stream alert rule
- type String
- Type of the stream alert rule
- uuid String
- Equinix assigned unique identifier of the stream subscription resource
- warning
Threshold String - Stream alert rule metric warning threshold
- window
Size String - Stream alert rule metric window size
Supporting Types
GetStreamAlertRuleChangeLog
- Created
By string - User name of creator of the stream resource
- Created
By stringEmail - Email of creator of the stream resource
- Created
By stringFull Name - Legal name of creator of the stream resource
- Created
Date stringTime - Creation time of the stream resource
- Deleted
By string - User name of deleter of the stream resource
- Deleted
By stringEmail - Email of deleter of the stream resource
- Deleted
By stringFull Name - Legal name of deleter of the stream resource
- Deleted
Date stringTime - Deletion time of the stream resource
- Updated
By string - User name of last updater of the stream resource
- Updated
By stringEmail - Email of last updater of the stream resource
- Updated
By stringFull Name - Legal name of last updater of the stream resource
- Updated
Date stringTime - Last update time of the stream resource
- Created
By string - User name of creator of the stream resource
- Created
By stringEmail - Email of creator of the stream resource
- Created
By stringFull Name - Legal name of creator of the stream resource
- Created
Date stringTime - Creation time of the stream resource
- Deleted
By string - User name of deleter of the stream resource
- Deleted
By stringEmail - Email of deleter of the stream resource
- Deleted
By stringFull Name - Legal name of deleter of the stream resource
- Deleted
Date stringTime - Deletion time of the stream resource
- Updated
By string - User name of last updater of the stream resource
- Updated
By stringEmail - Email of last updater of the stream resource
- Updated
By stringFull Name - Legal name of last updater of the stream resource
- Updated
Date stringTime - Last update time of the stream resource
- created
By String - User name of creator of the stream resource
- created
By StringEmail - Email of creator of the stream resource
- created
By StringFull Name - Legal name of creator of the stream resource
- created
Date StringTime - Creation time of the stream resource
- deleted
By String - User name of deleter of the stream resource
- deleted
By StringEmail - Email of deleter of the stream resource
- deleted
By StringFull Name - Legal name of deleter of the stream resource
- deleted
Date StringTime - Deletion time of the stream resource
- updated
By String - User name of last updater of the stream resource
- updated
By StringEmail - Email of last updater of the stream resource
- updated
By StringFull Name - Legal name of last updater of the stream resource
- updated
Date StringTime - Last update time of the stream resource
- created
By string - User name of creator of the stream resource
- created
By stringEmail - Email of creator of the stream resource
- created
By stringFull Name - Legal name of creator of the stream resource
- created
Date stringTime - Creation time of the stream resource
- deleted
By string - User name of deleter of the stream resource
- deleted
By stringEmail - Email of deleter of the stream resource
- deleted
By stringFull Name - Legal name of deleter of the stream resource
- deleted
Date stringTime - Deletion time of the stream resource
- updated
By string - User name of last updater of the stream resource
- updated
By stringEmail - Email of last updater of the stream resource
- updated
By stringFull Name - Legal name of last updater of the stream resource
- updated
Date stringTime - Last update time of the stream resource
- created_
by str - User name of creator of the stream resource
- created_
by_ stremail - Email of creator of the stream resource
- created_
by_ strfull_ name - Legal name of creator of the stream resource
- created_
date_ strtime - Creation time of the stream resource
- deleted_
by str - User name of deleter of the stream resource
- deleted_
by_ stremail - Email of deleter of the stream resource
- deleted_
by_ strfull_ name - Legal name of deleter of the stream resource
- deleted_
date_ strtime - Deletion time of the stream resource
- updated_
by str - User name of last updater of the stream resource
- updated_
by_ stremail - Email of last updater of the stream resource
- updated_
by_ strfull_ name - Legal name of last updater of the stream resource
- updated_
date_ strtime - Last update time of the stream resource
- created
By String - User name of creator of the stream resource
- created
By StringEmail - Email of creator of the stream resource
- created
By StringFull Name - Legal name of creator of the stream resource
- created
Date StringTime - Creation time of the stream resource
- deleted
By String - User name of deleter of the stream resource
- deleted
By StringEmail - Email of deleter of the stream resource
- deleted
By StringFull Name - Legal name of deleter of the stream resource
- deleted
Date StringTime - Deletion time of the stream resource
- updated
By String - User name of last updater of the stream resource
- updated
By StringEmail - Email of last updater of the stream resource
- updated
By StringFull Name - Legal name of last updater of the stream resource
- updated
Date StringTime - Last update time of the stream resource
GetStreamAlertRuleResourceSelector
- Includes List<string>
- List of metrics to include
- Includes []string
- List of metrics to include
- includes List<String>
- List of metrics to include
- includes string[]
- List of metrics to include
- includes Sequence[str]
- List of metrics to include
- includes List<String>
- List of metrics to include
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.