1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getStreamAlertRule
Equinix v0.23.1 published on Wednesday, Jul 16, 2025 by Equinix

equinix.fabric.getStreamAlertRule

Explore with Pulumi AI

equinix logo
Equinix v0.23.1 published on Wednesday, Jul 16, 2025 by Equinix

    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:

    AlertRuleId string
    The uuid of the stream alert rule
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    AlertRuleId string
    The uuid of the stream alert rule
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    alertRuleId String
    The uuid of the stream alert rule
    streamId String
    The uuid of the stream that is the target of the stream alert rule
    alertRuleId string
    The uuid of the stream alert rule
    streamId string
    The uuid of the stream that is the target of the stream alert rule
    alert_rule_id str
    The uuid of the stream alert rule
    stream_id str
    The uuid of the stream that is the target of the stream alert rule
    alertRuleId String
    The uuid of the stream alert rule
    streamId String
    The uuid of the stream that is the target of the stream alert rule

    getStreamAlertRule Result

    The following output properties are available:

    AlertRuleId string
    The uuid of the stream alert rule
    ChangeLog GetStreamAlertRuleChangeLog
    Details of the last change on the stream resource
    CriticalThreshold 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
    MetricName string
    Stream alert rule metric name
    Name string
    Customer-provided stream alert rule name
    Operand string
    Stream alert rule metric operand
    ResourceSelector GetStreamAlertRuleResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    State string
    Value representing provisioning status for the stream resource
    StreamId 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
    WarningThreshold string
    Stream alert rule metric warning threshold
    WindowSize string
    Stream alert rule metric window size
    AlertRuleId string
    The uuid of the stream alert rule
    ChangeLog GetStreamAlertRuleChangeLog
    Details of the last change on the stream resource
    CriticalThreshold 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
    MetricName string
    Stream alert rule metric name
    Name string
    Customer-provided stream alert rule name
    Operand string
    Stream alert rule metric operand
    ResourceSelector GetStreamAlertRuleResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    State string
    Value representing provisioning status for the stream resource
    StreamId 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
    WarningThreshold string
    Stream alert rule metric warning threshold
    WindowSize string
    Stream alert rule metric window size
    alertRuleId String
    The uuid of the stream alert rule
    changeLog GetStreamAlertRuleChangeLog
    Details of the last change on the stream resource
    criticalThreshold 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
    metricName String
    Stream alert rule metric name
    name String
    Customer-provided stream alert rule name
    operand String
    Stream alert rule metric operand
    resourceSelector GetStreamAlertRuleResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    state String
    Value representing provisioning status for the stream resource
    streamId 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
    warningThreshold String
    Stream alert rule metric warning threshold
    windowSize String
    Stream alert rule metric window size
    alertRuleId string
    The uuid of the stream alert rule
    changeLog GetStreamAlertRuleChangeLog
    Details of the last change on the stream resource
    criticalThreshold 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
    metricName string
    Stream alert rule metric name
    name string
    Customer-provided stream alert rule name
    operand string
    Stream alert rule metric operand
    resourceSelector GetStreamAlertRuleResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    state string
    Value representing provisioning status for the stream resource
    streamId 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
    warningThreshold string
    Stream alert rule metric warning threshold
    windowSize string
    Stream alert rule metric window size
    alert_rule_id str
    The uuid of the stream alert rule
    change_log GetStreamAlertRuleChangeLog
    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 GetStreamAlertRuleResourceSelector
    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
    alertRuleId String
    The uuid of the stream alert rule
    changeLog Property Map
    Details of the last change on the stream resource
    criticalThreshold 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
    metricName String
    Stream alert rule metric name
    name String
    Customer-provided stream alert rule name
    operand String
    Stream alert rule metric operand
    resourceSelector Property Map
    Lists of metrics to be included/excluded on the stream alert rule
    state String
    Value representing provisioning status for the stream resource
    streamId 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
    warningThreshold String
    Stream alert rule metric warning threshold
    windowSize String
    Stream alert rule metric window size

    Supporting Types

    GetStreamAlertRuleChangeLog

    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    CreatedBy string
    User name of creator of the stream resource
    CreatedByEmail string
    Email of creator of the stream resource
    CreatedByFullName string
    Legal name of creator of the stream resource
    CreatedDateTime string
    Creation time of the stream resource
    DeletedBy string
    User name of deleter of the stream resource
    DeletedByEmail string
    Email of deleter of the stream resource
    DeletedByFullName string
    Legal name of deleter of the stream resource
    DeletedDateTime string
    Deletion time of the stream resource
    UpdatedBy string
    User name of last updater of the stream resource
    UpdatedByEmail string
    Email of last updater of the stream resource
    UpdatedByFullName string
    Legal name of last updater of the stream resource
    UpdatedDateTime string
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    Last update time of the stream resource
    createdBy string
    User name of creator of the stream resource
    createdByEmail string
    Email of creator of the stream resource
    createdByFullName string
    Legal name of creator of the stream resource
    createdDateTime string
    Creation time of the stream resource
    deletedBy string
    User name of deleter of the stream resource
    deletedByEmail string
    Email of deleter of the stream resource
    deletedByFullName string
    Legal name of deleter of the stream resource
    deletedDateTime string
    Deletion time of the stream resource
    updatedBy string
    User name of last updater of the stream resource
    updatedByEmail string
    Email of last updater of the stream resource
    updatedByFullName string
    Legal name of last updater of the stream resource
    updatedDateTime string
    Last update time of the stream resource
    created_by str
    User name of creator of the stream resource
    created_by_email str
    Email of creator of the stream resource
    created_by_full_name str
    Legal name of creator of the stream resource
    created_date_time str
    Creation time of the stream resource
    deleted_by str
    User name of deleter of the stream resource
    deleted_by_email str
    Email of deleter of the stream resource
    deleted_by_full_name str
    Legal name of deleter of the stream resource
    deleted_date_time str
    Deletion time of the stream resource
    updated_by str
    User name of last updater of the stream resource
    updated_by_email str
    Email of last updater of the stream resource
    updated_by_full_name str
    Legal name of last updater of the stream resource
    updated_date_time str
    Last update time of the stream resource
    createdBy String
    User name of creator of the stream resource
    createdByEmail String
    Email of creator of the stream resource
    createdByFullName String
    Legal name of creator of the stream resource
    createdDateTime String
    Creation time of the stream resource
    deletedBy String
    User name of deleter of the stream resource
    deletedByEmail String
    Email of deleter of the stream resource
    deletedByFullName String
    Legal name of deleter of the stream resource
    deletedDateTime String
    Deletion time of the stream resource
    updatedBy String
    User name of last updater of the stream resource
    updatedByEmail String
    Email of last updater of the stream resource
    updatedByFullName String
    Legal name of last updater of the stream resource
    updatedDateTime String
    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.
    equinix logo
    Equinix v0.23.1 published on Wednesday, Jul 16, 2025 by Equinix