equinix.fabric.getStreamSubscription

Equinix v0.28.0, Dec 23 25

Equinix v0.28.0 published on Tuesday, Dec 23, 2025 by Equinix

Schema (JSON)

equinix/pulumi-equinix

Equinix v0.28.0 published on Tuesday, Dec 23, 2025 by Equinix

Schema (JSON)

equinix/pulumi-equinix

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@pulumi/equinix";

const byIds = equinix.fabric.getStreamSubscription({
    streamId: "<stream_id>",
    subscriptionId: "<subscription_id>",
});

import pulumi
import pulumi_equinix as equinix

by_ids = equinix.fabric.get_stream_subscription(stream_id="<stream_id>",
    subscription_id="<subscription_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.LookupStreamSubscription(ctx, &fabric.LookupStreamSubscriptionArgs{
			StreamId:       "<stream_id>",
			SubscriptionId: "<subscription_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var byIds = Equinix.Fabric.GetStreamSubscription.Invoke(new()
    {
        StreamId = "<stream_id>",
        SubscriptionId = "<subscription_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.GetStreamSubscriptionArgs;
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 byIds = FabricFunctions.getStreamSubscription(GetStreamSubscriptionArgs.builder()
            .streamId("<stream_id>")
            .subscriptionId("<subscription_id>")
            .build());

    }
}

variables:
  byIds:
    fn::invoke:
      function: equinix:fabric:getStreamSubscription
      arguments:
        streamId: <stream_id>
        subscriptionId: <subscription_id>

Using getStreamSubscription

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 getStreamSubscription(args: GetStreamSubscriptionArgs, opts?: InvokeOptions): Promise<GetStreamSubscriptionResult>
function getStreamSubscriptionOutput(args: GetStreamSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetStreamSubscriptionResult>

def get_stream_subscription(stream_id: Optional[str] = None,
                            subscription_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetStreamSubscriptionResult
def get_stream_subscription_output(stream_id: Optional[pulumi.Input[str]] = None,
                            subscription_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetStreamSubscriptionResult]

func LookupStreamSubscription(ctx *Context, args *LookupStreamSubscriptionArgs, opts ...InvokeOption) (*LookupStreamSubscriptionResult, error)
func LookupStreamSubscriptionOutput(ctx *Context, args *LookupStreamSubscriptionOutputArgs, opts ...InvokeOption) LookupStreamSubscriptionResultOutput

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

public static class GetStreamSubscription 
{
    public static Task<GetStreamSubscriptionResult> InvokeAsync(GetStreamSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamSubscriptionResult> Invoke(GetStreamSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamSubscriptionResult> getStreamSubscription(GetStreamSubscriptionArgs args, InvokeOptions options)
public static Output<GetStreamSubscriptionResult> getStreamSubscription(GetStreamSubscriptionArgs args, InvokeOptions options)

fn::invoke:
  function: equinix:fabric/getStreamSubscription:getStreamSubscription
  arguments:
    # arguments dictionary

The following arguments are supported:

StreamId string: The uuid of the stream that is the target of the stream subscription
SubscriptionId string: The uuid of the stream subscription

StreamId string: The uuid of the stream that is the target of the stream subscription
SubscriptionId string: The uuid of the stream subscription

streamId String: The uuid of the stream that is the target of the stream subscription
subscriptionId String: The uuid of the stream subscription

streamId string: The uuid of the stream that is the target of the stream subscription
subscriptionId string: The uuid of the stream subscription

stream_id str: The uuid of the stream that is the target of the stream subscription
subscription_id str: The uuid of the stream subscription

streamId String: The uuid of the stream that is the target of the stream subscription
subscriptionId String: The uuid of the stream subscription

getStreamSubscription Result

The following output properties are available:

ChangeLog GetStreamSubscriptionChangeLog: Details of the last change on the stream resource
Description string: Customer-provided stream subscription description
Enabled bool: Stream subscription enabled status
EventSelector GetStreamSubscriptionEventSelector: Lists of events to be included/excluded on the stream subscription
Href string: Equinix assigned URI of the stream subscription resource
Id string: The unique identifier of the resource
MetricSelector GetStreamSubscriptionMetricSelector: Lists of metrics to be included/excluded on the stream subscription
Name string: Customer-provided stream subscription name
Sink GetStreamSubscriptionSink: The details of the subscriber to the Equinix Stream
State string: Value representing provisioning status for the stream resource
StreamId string: The uuid of the stream that is the target of the stream subscription
SubscriptionId string: The uuid of the stream subscription
Type string: Type of the stream subscription request
Uuid string: Equinix assigned unique identifier of the stream subscription resource

ChangeLog GetStreamSubscriptionChangeLog: Details of the last change on the stream resource
Description string: Customer-provided stream subscription description
Enabled bool: Stream subscription enabled status
EventSelector GetStreamSubscriptionEventSelector: Lists of events to be included/excluded on the stream subscription
Href string: Equinix assigned URI of the stream subscription resource
Id string: The unique identifier of the resource
MetricSelector GetStreamSubscriptionMetricSelector: Lists of metrics to be included/excluded on the stream subscription
Name string: Customer-provided stream subscription name
Sink GetStreamSubscriptionSink: The details of the subscriber to the Equinix Stream
State string: Value representing provisioning status for the stream resource
StreamId string: The uuid of the stream that is the target of the stream subscription
SubscriptionId string: The uuid of the stream subscription
Type string: Type of the stream subscription request
Uuid string: Equinix assigned unique identifier of the stream subscription resource

changeLog GetStreamSubscriptionChangeLog: Details of the last change on the stream resource
description String: Customer-provided stream subscription description
enabled Boolean: Stream subscription enabled status
eventSelector GetStreamSubscriptionEventSelector: Lists of events to be included/excluded on the stream subscription
href String: Equinix assigned URI of the stream subscription resource
id String: The unique identifier of the resource
metricSelector GetStreamSubscriptionMetricSelector: Lists of metrics to be included/excluded on the stream subscription
name String: Customer-provided stream subscription name
sink GetStreamSubscriptionSink: The details of the subscriber to the Equinix Stream
state String: Value representing provisioning status for the stream resource
streamId String: The uuid of the stream that is the target of the stream subscription
subscriptionId String: The uuid of the stream subscription
type String: Type of the stream subscription request
uuid String: Equinix assigned unique identifier of the stream subscription resource

changeLog GetStreamSubscriptionChangeLog: Details of the last change on the stream resource
description string: Customer-provided stream subscription description
enabled boolean: Stream subscription enabled status
eventSelector GetStreamSubscriptionEventSelector: Lists of events to be included/excluded on the stream subscription
href string: Equinix assigned URI of the stream subscription resource
id string: The unique identifier of the resource
metricSelector GetStreamSubscriptionMetricSelector: Lists of metrics to be included/excluded on the stream subscription
name string: Customer-provided stream subscription name
sink GetStreamSubscriptionSink: The details of the subscriber to the Equinix Stream
state string: Value representing provisioning status for the stream resource
streamId string: The uuid of the stream that is the target of the stream subscription
subscriptionId string: The uuid of the stream subscription
type string: Type of the stream subscription request
uuid string: Equinix assigned unique identifier of the stream subscription resource

change_log GetStreamSubscriptionChangeLog: Details of the last change on the stream resource
description str: Customer-provided stream subscription description
enabled bool: Stream subscription enabled status
event_selector GetStreamSubscriptionEventSelector: Lists of events to be included/excluded on the stream subscription
href str: Equinix assigned URI of the stream subscription resource
id str: The unique identifier of the resource
metric_selector GetStreamSubscriptionMetricSelector: Lists of metrics to be included/excluded on the stream subscription
name str: Customer-provided stream subscription name
sink GetStreamSubscriptionSink: The details of the subscriber to the Equinix Stream
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 subscription
subscription_id str: The uuid of the stream subscription
type str: Type of the stream subscription request
uuid str: Equinix assigned unique identifier of the stream subscription resource

changeLog Property Map: Details of the last change on the stream resource
description String: Customer-provided stream subscription description
enabled Boolean: Stream subscription enabled status
eventSelector Property Map: Lists of events to be included/excluded on the stream subscription
href String: Equinix assigned URI of the stream subscription resource
id String: The unique identifier of the resource
metricSelector Property Map: Lists of metrics to be included/excluded on the stream subscription
name String: Customer-provided stream subscription name
sink Property Map: The details of the subscriber to the Equinix Stream
state String: Value representing provisioning status for the stream resource
streamId String: The uuid of the stream that is the target of the stream subscription
subscriptionId String: The uuid of the stream subscription
type String: Type of the stream subscription request
uuid String: Equinix assigned unique identifier of the stream subscription resource

Supporting Types

GetStreamSubscriptionChangeLog

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

GetStreamSubscriptionEventSelector

Excepts List<string>: List of events to exclude
Includes List<string>: List of events to include

Excepts []string: List of events to exclude
Includes []string: List of events to include

excepts List<String>: List of events to exclude
includes List<String>: List of events to include

excepts string[]: List of events to exclude
includes string[]: List of events to include

excepts Sequence[str]: List of events to exclude
includes Sequence[str]: List of events to include

excepts List<String>: List of events to exclude
includes List<String>: List of events to include

GetStreamSubscriptionMetricSelector

Excepts List<string>: List of metrics to exclude
Includes List<string>: List of metrics to include

Excepts []string: List of metrics to exclude
Includes []string: List of metrics to include

excepts List<String>: List of metrics to exclude
includes List<String>: List of metrics to include

excepts string[]: List of metrics to exclude
includes string[]: List of metrics to include

excepts Sequence[str]: List of metrics to exclude
includes Sequence[str]: List of metrics to include

excepts List<String>: List of metrics to exclude
includes List<String>: List of metrics to include

GetStreamSubscriptionSink

BatchEnabled bool: Boolean switch enabling batch delivery of data
BatchSizeMax int: Maximum size of the batch delivery if enabled
BatchWaitTimeMax int: Maximum time to wait for batch delivery if enabled
Credential GetStreamSubscriptionSinkCredential: Access details for the specified sink type
Host string: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
Settings GetStreamSubscriptionSinkSettings: Stream subscription sink settings
Type string: Type of the subscriber
Uri string: Publicly reachable http endpoint destination for data stream

BatchEnabled bool: Boolean switch enabling batch delivery of data
BatchSizeMax int: Maximum size of the batch delivery if enabled
BatchWaitTimeMax int: Maximum time to wait for batch delivery if enabled
Credential GetStreamSubscriptionSinkCredential: Access details for the specified sink type
Host string: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
Settings GetStreamSubscriptionSinkSettings: Stream subscription sink settings
Type string: Type of the subscriber
Uri string: Publicly reachable http endpoint destination for data stream

batchEnabled Boolean: Boolean switch enabling batch delivery of data
batchSizeMax Integer: Maximum size of the batch delivery if enabled
batchWaitTimeMax Integer: Maximum time to wait for batch delivery if enabled
credential GetStreamSubscriptionSinkCredential: Access details for the specified sink type
host String: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
settings GetStreamSubscriptionSinkSettings: Stream subscription sink settings
type String: Type of the subscriber
uri String: Publicly reachable http endpoint destination for data stream

batchEnabled boolean: Boolean switch enabling batch delivery of data
batchSizeMax number: Maximum size of the batch delivery if enabled
batchWaitTimeMax number: Maximum time to wait for batch delivery if enabled
credential GetStreamSubscriptionSinkCredential: Access details for the specified sink type
host string: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
settings GetStreamSubscriptionSinkSettings: Stream subscription sink settings
type string: Type of the subscriber
uri string: Publicly reachable http endpoint destination for data stream

batch_enabled bool: Boolean switch enabling batch delivery of data
batch_size_max int: Maximum size of the batch delivery if enabled
batch_wait_time_max int: Maximum time to wait for batch delivery if enabled
credential GetStreamSubscriptionSinkCredential: Access details for the specified sink type
host str: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
settings GetStreamSubscriptionSinkSettings: Stream subscription sink settings
type str: Type of the subscriber
uri str: Publicly reachable http endpoint destination for data stream

batchEnabled Boolean: Boolean switch enabling batch delivery of data
batchSizeMax Number: Maximum size of the batch delivery if enabled
batchWaitTimeMax Number: Maximum time to wait for batch delivery if enabled
credential Property Map: Access details for the specified sink type
host String: Known hostname of certain data stream subscription products. Not to be confused with a variable URI
settings Property Map: Stream subscription sink settings
type String: Type of the subscriber
uri String: Publicly reachable http endpoint destination for data stream