1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getStream
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

equinix.fabric.getStream

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Stream by UUID

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/Streams

Example Usage

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

const dataStream = equinix.fabric.getStream({
    streamId: "<uuid_of_stream>",
});
export const streamState = dataStream.then(dataStream => dataStream.state);
Copy
import pulumi
import pulumi_equinix as equinix

data_stream = equinix.fabric.get_stream(stream_id="<uuid_of_stream>")
pulumi.export("streamState", data_stream.state)
Copy
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 {
		dataStream, err := fabric.LookupStream(ctx, &fabric.LookupStreamArgs{
			StreamId: "<uuid_of_stream>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("streamState", dataStream.State)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var dataStream = Equinix.Fabric.GetStream.Invoke(new()
    {
        StreamId = "<uuid_of_stream>",
    });

    return new Dictionary<string, object?>
    {
        ["streamState"] = dataStream.Apply(getStreamResult => getStreamResult.State),
    };
});
Copy
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.GetStreamArgs;
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 dataStream = FabricFunctions.getStream(GetStreamArgs.builder()
            .streamId("<uuid_of_stream>")
            .build());

        ctx.export("streamState", dataStream.applyValue(getStreamResult -> getStreamResult.state()));
    }
}
Copy
variables:
  dataStream:
    fn::invoke:
      Function: equinix:fabric:getStream
      Arguments:
        streamId: <uuid_of_stream>
outputs:
  streamState: ${dataStream.state}
Copy

Using getStream

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 getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>
function getStreamOutput(args: GetStreamOutputArgs, opts?: InvokeOptions): Output<GetStreamResult>
Copy
def get_stream(stream_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetStreamResult
def get_stream_output(stream_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetStreamResult]
Copy
func LookupStream(ctx *Context, args *LookupStreamArgs, opts ...InvokeOption) (*LookupStreamResult, error)
func LookupStreamOutput(ctx *Context, args *LookupStreamOutputArgs, opts ...InvokeOption) LookupStreamResultOutput
Copy

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

public static class GetStream 
{
    public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamResult> Invoke(GetStreamInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
public static Output<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: equinix:fabric/getStream:getStream
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

StreamId This property is required. string
The uuid of the stream this data source should retrieve
StreamId This property is required. string
The uuid of the stream this data source should retrieve
streamId This property is required. String
The uuid of the stream this data source should retrieve
streamId This property is required. string
The uuid of the stream this data source should retrieve
stream_id This property is required. str
The uuid of the stream this data source should retrieve
streamId This property is required. String
The uuid of the stream this data source should retrieve

getStream Result

The following output properties are available:

AssetsCount double
Count of the streaming assets attached to the stream resource
ChangeLog GetStreamChangeLog
Details of the last change on the stream resource
Description string
Customer-provided description of the stream resource
Href string
Equinix auto generated URI to the stream resource in Equinix Portal
Id string
The unique identifier of the resource
Name string
Customer-provided name of the stream resource
Project GetStreamProject
Equinix Project attribute object
State string
Value representing provisioning status for the stream resource
StreamId string
The uuid of the stream this data source should retrieve
StreamSubscriptionsCount double
Count of the client subscriptions on the stream resource
Type string
Equinix defined Streaming Type
Uuid string
Equinix-assigned unique id for the stream resource
AssetsCount float64
Count of the streaming assets attached to the stream resource
ChangeLog GetStreamChangeLog
Details of the last change on the stream resource
Description string
Customer-provided description of the stream resource
Href string
Equinix auto generated URI to the stream resource in Equinix Portal
Id string
The unique identifier of the resource
Name string
Customer-provided name of the stream resource
Project GetStreamProject
Equinix Project attribute object
State string
Value representing provisioning status for the stream resource
StreamId string
The uuid of the stream this data source should retrieve
StreamSubscriptionsCount float64
Count of the client subscriptions on the stream resource
Type string
Equinix defined Streaming Type
Uuid string
Equinix-assigned unique id for the stream resource
assetsCount Double
Count of the streaming assets attached to the stream resource
changeLog GetStreamChangeLog
Details of the last change on the stream resource
description String
Customer-provided description of the stream resource
href String
Equinix auto generated URI to the stream resource in Equinix Portal
id String
The unique identifier of the resource
name String
Customer-provided name of the stream resource
project GetStreamProject
Equinix Project attribute object
state String
Value representing provisioning status for the stream resource
streamId String
The uuid of the stream this data source should retrieve
streamSubscriptionsCount Double
Count of the client subscriptions on the stream resource
type String
Equinix defined Streaming Type
uuid String
Equinix-assigned unique id for the stream resource
assetsCount number
Count of the streaming assets attached to the stream resource
changeLog GetStreamChangeLog
Details of the last change on the stream resource
description string
Customer-provided description of the stream resource
href string
Equinix auto generated URI to the stream resource in Equinix Portal
id string
The unique identifier of the resource
name string
Customer-provided name of the stream resource
project GetStreamProject
Equinix Project attribute object
state string
Value representing provisioning status for the stream resource
streamId string
The uuid of the stream this data source should retrieve
streamSubscriptionsCount number
Count of the client subscriptions on the stream resource
type string
Equinix defined Streaming Type
uuid string
Equinix-assigned unique id for the stream resource
assets_count float
Count of the streaming assets attached to the stream resource
change_log GetStreamChangeLog
Details of the last change on the stream resource
description str
Customer-provided description of the stream resource
href str
Equinix auto generated URI to the stream resource in Equinix Portal
id str
The unique identifier of the resource
name str
Customer-provided name of the stream resource
project GetStreamProject
Equinix Project attribute object
state str
Value representing provisioning status for the stream resource
stream_id str
The uuid of the stream this data source should retrieve
stream_subscriptions_count float
Count of the client subscriptions on the stream resource
type str
Equinix defined Streaming Type
uuid str
Equinix-assigned unique id for the stream resource
assetsCount Number
Count of the streaming assets attached to the stream resource
changeLog Property Map
Details of the last change on the stream resource
description String
Customer-provided description of the stream resource
href String
Equinix auto generated URI to the stream resource in Equinix Portal
id String
The unique identifier of the resource
name String
Customer-provided name of the stream resource
project Property Map
Equinix Project attribute object
state String
Value representing provisioning status for the stream resource
streamId String
The uuid of the stream this data source should retrieve
streamSubscriptionsCount Number
Count of the client subscriptions on the stream resource
type String
Equinix defined Streaming Type
uuid String
Equinix-assigned unique id for the stream resource

Supporting Types

GetStreamChangeLog

CreatedBy This property is required. string
User name of creator of the stream resource
CreatedByEmail This property is required. string
Email of creator of the stream resource
CreatedByFullName This property is required. string
Legal name of creator of the stream resource
CreatedDateTime This property is required. string
Creation time of the stream resource
DeletedBy This property is required. string
User name of deleter of the stream resource
DeletedByEmail This property is required. string
Email of deleter of the stream resource
DeletedByFullName This property is required. string
Legal name of deleter of the stream resource
DeletedDateTime This property is required. string
Deletion time of the stream resource
UpdatedBy This property is required. string
User name of last updater of the stream resource
UpdatedByEmail This property is required. string
Email of last updater of the stream resource
UpdatedByFullName This property is required. string
Legal name of last updater of the stream resource
UpdatedDateTime This property is required. string
Last update time of the stream resource
CreatedBy This property is required. string
User name of creator of the stream resource
CreatedByEmail This property is required. string
Email of creator of the stream resource
CreatedByFullName This property is required. string
Legal name of creator of the stream resource
CreatedDateTime This property is required. string
Creation time of the stream resource
DeletedBy This property is required. string
User name of deleter of the stream resource
DeletedByEmail This property is required. string
Email of deleter of the stream resource
DeletedByFullName This property is required. string
Legal name of deleter of the stream resource
DeletedDateTime This property is required. string
Deletion time of the stream resource
UpdatedBy This property is required. string
User name of last updater of the stream resource
UpdatedByEmail This property is required. string
Email of last updater of the stream resource
UpdatedByFullName This property is required. string
Legal name of last updater of the stream resource
UpdatedDateTime This property is required. string
Last update time of the stream resource
createdBy This property is required. String
User name of creator of the stream resource
createdByEmail This property is required. String
Email of creator of the stream resource
createdByFullName This property is required. String
Legal name of creator of the stream resource
createdDateTime This property is required. String
Creation time of the stream resource
deletedBy This property is required. String
User name of deleter of the stream resource
deletedByEmail This property is required. String
Email of deleter of the stream resource
deletedByFullName This property is required. String
Legal name of deleter of the stream resource
deletedDateTime This property is required. String
Deletion time of the stream resource
updatedBy This property is required. String
User name of last updater of the stream resource
updatedByEmail This property is required. String
Email of last updater of the stream resource
updatedByFullName This property is required. String
Legal name of last updater of the stream resource
updatedDateTime This property is required. String
Last update time of the stream resource
createdBy This property is required. string
User name of creator of the stream resource
createdByEmail This property is required. string
Email of creator of the stream resource
createdByFullName This property is required. string
Legal name of creator of the stream resource
createdDateTime This property is required. string
Creation time of the stream resource
deletedBy This property is required. string
User name of deleter of the stream resource
deletedByEmail This property is required. string
Email of deleter of the stream resource
deletedByFullName This property is required. string
Legal name of deleter of the stream resource
deletedDateTime This property is required. string
Deletion time of the stream resource
updatedBy This property is required. string
User name of last updater of the stream resource
updatedByEmail This property is required. string
Email of last updater of the stream resource
updatedByFullName This property is required. string
Legal name of last updater of the stream resource
updatedDateTime This property is required. string
Last update time of the stream resource
created_by This property is required. str
User name of creator of the stream resource
created_by_email This property is required. str
Email of creator of the stream resource
created_by_full_name This property is required. str
Legal name of creator of the stream resource
created_date_time This property is required. str
Creation time of the stream resource
deleted_by This property is required. str
User name of deleter of the stream resource
deleted_by_email This property is required. str
Email of deleter of the stream resource
deleted_by_full_name This property is required. str
Legal name of deleter of the stream resource
deleted_date_time This property is required. str
Deletion time of the stream resource
updated_by This property is required. str
User name of last updater of the stream resource
updated_by_email This property is required. str
Email of last updater of the stream resource
updated_by_full_name This property is required. str
Legal name of last updater of the stream resource
updated_date_time This property is required. str
Last update time of the stream resource
createdBy This property is required. String
User name of creator of the stream resource
createdByEmail This property is required. String
Email of creator of the stream resource
createdByFullName This property is required. String
Legal name of creator of the stream resource
createdDateTime This property is required. String
Creation time of the stream resource
deletedBy This property is required. String
User name of deleter of the stream resource
deletedByEmail This property is required. String
Email of deleter of the stream resource
deletedByFullName This property is required. String
Legal name of deleter of the stream resource
deletedDateTime This property is required. String
Deletion time of the stream resource
updatedBy This property is required. String
User name of last updater of the stream resource
updatedByEmail This property is required. String
Email of last updater of the stream resource
updatedByFullName This property is required. String
Legal name of last updater of the stream resource
updatedDateTime This property is required. String
Last update time of the stream resource

GetStreamProject

ProjectId This property is required. string
Equinix Subscriber-assigned project ID
ProjectId This property is required. string
Equinix Subscriber-assigned project ID
projectId This property is required. String
Equinix Subscriber-assigned project ID
projectId This property is required. string
Equinix Subscriber-assigned project ID
project_id This property is required. str
Equinix Subscriber-assigned project ID
projectId This property is required. String
Equinix Subscriber-assigned project ID

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix