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

equinix.fabric.getStreamAlertRules

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 Rules with pagination

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as equinix from "@pulumi/equinix";
    
    const dataStreamAlertRules = equinix.fabric.getStreamAlertRules({
        streamId: "<uuid_of_stream>",
        pagination: {
            limit: 5,
            offset: 1,
        },
    });
    export const streamAlertRulesType = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].type;
    export const streamAlertRulesId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].uuid;
    export const streamAlertRulesState = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].state;
    export const streamAlertRulesStreamId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].stream_id;
    
    import pulumi
    import pulumi_equinix as equinix
    
    data_stream_alert_rules = equinix.fabric.get_stream_alert_rules(stream_id="<uuid_of_stream>",
        pagination={
            "limit": 5,
            "offset": 1,
        })
    pulumi.export("streamAlertRulesType", data["equinix_fabric_stream_alert_rules"]["alert_rules"]["data"][0]["type"])
    pulumi.export("streamAlertRulesId", data["equinix_fabric_stream_alert_rules"]["alert_rules"]["data"][0]["uuid"])
    pulumi.export("streamAlertRulesState", data["equinix_fabric_stream_alert_rules"]["alert_rules"]["data"][0]["state"])
    pulumi.export("streamAlertRulesStreamId", data["equinix_fabric_stream_alert_rules"]["alert_rules"]["data"][0]["stream_id"])
    
    package main
    
    import (
    	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fabric.GetStreamAlertRules(ctx, &fabric.GetStreamAlertRulesArgs{
    			StreamId: "<uuid_of_stream>",
    			Pagination: fabric.GetStreamAlertRulesPagination{
    				Limit:  5,
    				Offset: 1,
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("streamAlertRulesType", data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Type)
    		ctx.Export("streamAlertRulesId", data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Uuid)
    		ctx.Export("streamAlertRulesState", data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].State)
    		ctx.Export("streamAlertRulesStreamId", data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Stream_id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Equinix = Pulumi.Equinix;
    
    return await Deployment.RunAsync(() => 
    {
        var dataStreamAlertRules = Equinix.Fabric.GetStreamAlertRules.Invoke(new()
        {
            StreamId = "<uuid_of_stream>",
            Pagination = new Equinix.Fabric.Inputs.GetStreamAlertRulesPaginationInputArgs
            {
                Limit = 5,
                Offset = 1,
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["streamAlertRulesType"] = data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Type,
            ["streamAlertRulesId"] = data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Uuid,
            ["streamAlertRulesState"] = data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].State,
            ["streamAlertRulesStreamId"] = data.Equinix_fabric_stream_alert_rules.Alert_rules.Data[0].Stream_id,
        };
    });
    
    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.GetStreamAlertRulesArgs;
    import com.pulumi.equinix.fabric.inputs.GetStreamAlertRulesPaginationArgs;
    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 dataStreamAlertRules = FabricFunctions.getStreamAlertRules(GetStreamAlertRulesArgs.builder()
                .streamId("<uuid_of_stream>")
                .pagination(GetStreamAlertRulesPaginationArgs.builder()
                    .limit(5)
                    .offset(1)
                    .build())
                .build());
    
            ctx.export("streamAlertRulesType", data.equinix_fabric_stream_alert_rules().alert_rules().data()[0].type());
            ctx.export("streamAlertRulesId", data.equinix_fabric_stream_alert_rules().alert_rules().data()[0].uuid());
            ctx.export("streamAlertRulesState", data.equinix_fabric_stream_alert_rules().alert_rules().data()[0].state());
            ctx.export("streamAlertRulesStreamId", data.equinix_fabric_stream_alert_rules().alert_rules().data()[0].stream_id());
        }
    }
    
    variables:
      dataStreamAlertRules:
        fn::invoke:
          function: equinix:fabric:getStreamAlertRules
          arguments:
            streamId: <uuid_of_stream>
            pagination:
              limit: 5
              offset: 1
    outputs:
      streamAlertRulesType: ${data.equinix_fabric_stream_alert_rules.alert_rules.data[0].type}
      streamAlertRulesId: ${data.equinix_fabric_stream_alert_rules.alert_rules.data[0].uuid}
      streamAlertRulesState: ${data.equinix_fabric_stream_alert_rules.alert_rules.data[0].state}
      streamAlertRulesStreamId: ${data.equinix_fabric_stream_alert_rules.alert_rules.data[0].stream_id}
    

    Using getStreamAlertRules

    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 getStreamAlertRules(args: GetStreamAlertRulesArgs, opts?: InvokeOptions): Promise<GetStreamAlertRulesResult>
    function getStreamAlertRulesOutput(args: GetStreamAlertRulesOutputArgs, opts?: InvokeOptions): Output<GetStreamAlertRulesResult>
    def get_stream_alert_rules(pagination: Optional[GetStreamAlertRulesPagination] = None,
                               stream_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetStreamAlertRulesResult
    def get_stream_alert_rules_output(pagination: Optional[pulumi.Input[GetStreamAlertRulesPaginationArgs]] = None,
                               stream_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetStreamAlertRulesResult]
    func GetStreamAlertRules(ctx *Context, args *GetStreamAlertRulesArgs, opts ...InvokeOption) (*GetStreamAlertRulesResult, error)
    func GetStreamAlertRulesOutput(ctx *Context, args *GetStreamAlertRulesOutputArgs, opts ...InvokeOption) GetStreamAlertRulesResultOutput

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

    public static class GetStreamAlertRules 
    {
        public static Task<GetStreamAlertRulesResult> InvokeAsync(GetStreamAlertRulesArgs args, InvokeOptions? opts = null)
        public static Output<GetStreamAlertRulesResult> Invoke(GetStreamAlertRulesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStreamAlertRulesResult> getStreamAlertRules(GetStreamAlertRulesArgs args, InvokeOptions options)
    public static Output<GetStreamAlertRulesResult> getStreamAlertRules(GetStreamAlertRulesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: equinix:fabric/getStreamAlertRules:getStreamAlertRules
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    Pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    streamId String
    The uuid of the stream that is the target of the stream alert rule
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    streamId string
    The uuid of the stream that is the target of the stream alert rule
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    stream_id str
    The uuid of the stream that is the target of the stream alert rule
    pagination Property Map
    Pagination details for the returned stream alert rules list
    streamId String
    The uuid of the stream that is the target of the stream alert rule

    getStreamAlertRules Result

    The following output properties are available:

    Datas List<GetStreamAlertRulesData>
    Returned list of stream objects
    Id string
    The unique identifier of the resource
    Pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    Datas []GetStreamAlertRulesData
    Returned list of stream objects
    Id string
    The unique identifier of the resource
    Pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    StreamId string
    The uuid of the stream that is the target of the stream alert rule
    datas List<GetStreamAlertRulesData>
    Returned list of stream objects
    id String
    The unique identifier of the resource
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    streamId String
    The uuid of the stream that is the target of the stream alert rule
    datas GetStreamAlertRulesData[]
    Returned list of stream objects
    id string
    The unique identifier of the resource
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    streamId string
    The uuid of the stream that is the target of the stream alert rule
    datas Sequence[GetStreamAlertRulesData]
    Returned list of stream objects
    id str
    The unique identifier of the resource
    pagination GetStreamAlertRulesPagination
    Pagination details for the returned stream alert rules list
    stream_id str
    The uuid of the stream that is the target of the stream alert rule
    datas List<Property Map>
    Returned list of stream objects
    id String
    The unique identifier of the resource
    pagination Property Map
    Pagination details for the returned stream alert rules list
    streamId String
    The uuid of the stream that is the target of the stream alert rule

    Supporting Types

    GetStreamAlertRulesData

    ChangeLog GetStreamAlertRulesDataChangeLog
    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
    MetricName string
    Stream alert rule metric name
    Name string
    Customer-provided stream alert rule name
    Operand string
    Stream alert rule metric operand
    ResourceSelector GetStreamAlertRulesDataResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    State string
    Value representing provisioning status for the stream resource
    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
    ChangeLog GetStreamAlertRulesDataChangeLog
    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
    MetricName string
    Stream alert rule metric name
    Name string
    Customer-provided stream alert rule name
    Operand string
    Stream alert rule metric operand
    ResourceSelector GetStreamAlertRulesDataResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    State string
    Value representing provisioning status for the stream resource
    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
    changeLog GetStreamAlertRulesDataChangeLog
    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
    metricName String
    Stream alert rule metric name
    name String
    Customer-provided stream alert rule name
    operand String
    Stream alert rule metric operand
    resourceSelector GetStreamAlertRulesDataResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    state String
    Value representing provisioning status for the stream resource
    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
    changeLog GetStreamAlertRulesDataChangeLog
    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
    metricName string
    Stream alert rule metric name
    name string
    Customer-provided stream alert rule name
    operand string
    Stream alert rule metric operand
    resourceSelector GetStreamAlertRulesDataResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    state string
    Value representing provisioning status for the stream resource
    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
    change_log GetStreamAlertRulesDataChangeLog
    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
    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 GetStreamAlertRulesDataResourceSelector
    Lists of metrics to be included/excluded on the stream alert rule
    state str
    Value representing provisioning status for the stream resource
    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
    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
    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
    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

    GetStreamAlertRulesDataChangeLog

    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

    GetStreamAlertRulesDataResourceSelector

    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

    GetStreamAlertRulesPagination

    Limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    Next string
    The URL relative to the next item in the response
    Offset int
    Index of the first item returned in the response. The default is 0
    Previous string
    The URL relative to the previous item in the response
    Total int
    The total number of alert rules available to the user making the request
    Limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    Next string
    The URL relative to the next item in the response
    Offset int
    Index of the first item returned in the response. The default is 0
    Previous string
    The URL relative to the previous item in the response
    Total int
    The total number of alert rules available to the user making the request
    limit Integer
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next String
    The URL relative to the next item in the response
    offset Integer
    Index of the first item returned in the response. The default is 0
    previous String
    The URL relative to the previous item in the response
    total Integer
    The total number of alert rules available to the user making the request
    limit number
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next string
    The URL relative to the next item in the response
    offset number
    Index of the first item returned in the response. The default is 0
    previous string
    The URL relative to the previous item in the response
    total number
    The total number of alert rules available to the user making the request
    limit int
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next str
    The URL relative to the next item in the response
    offset int
    Index of the first item returned in the response. The default is 0
    previous str
    The URL relative to the previous item in the response
    total int
    The total number of alert rules available to the user making the request
    limit Number
    Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
    next String
    The URL relative to the next item in the response
    offset Number
    Index of the first item returned in the response. The default is 0
    previous String
    The URL relative to the previous item in the response
    total Number
    The total number of alert rules available to the user making the request

    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