Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getStreams
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

equinix.fabric.getStreams

Explore with Pulumi AI

equinix logo
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Streams with pagination details

    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 dataStreams = equinix.fabric.getStreams({
    pagination: {
        limit: 2,
        offset: 1,
    },
});
export const numberOfReturnedStreams = dataStreams.then(dataStreams => dataStreams.datas).length;

    import pulumi
import pulumi_equinix as equinix

data_streams = equinix.fabric.get_streams(pagination={
    "limit": 2,
    "offset": 1,
})
pulumi.export("numberOfReturnedStreams", len(data_streams.datas))

    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 {
		dataStreams, err := fabric.GetStreams(ctx, &fabric.GetStreamsArgs{
			Pagination: fabric.GetStreamsPagination{
				Limit:  2,
				Offset: 1,
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("numberOfReturnedStreams", pulumi.Int(len(dataStreams.Datas)))
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var dataStreams = Equinix.Fabric.GetStreams.Invoke(new()
    {
        Pagination = new Equinix.Fabric.Inputs.GetStreamsPaginationInputArgs
        {
            Limit = 2,
            Offset = 1,
        },
    });

    return new Dictionary<string, object?>
    {
        ["numberOfReturnedStreams"] = dataStreams.Apply(getStreamsResult => getStreamsResult.Datas).Length,
    };
});

    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.GetStreamsArgs;
import com.pulumi.equinix.fabric.inputs.GetStreamsPaginationArgs;
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 dataStreams = FabricFunctions.getStreams(GetStreamsArgs.builder()
            .pagination(GetStreamsPaginationArgs.builder()
                .limit(2)
                .offset(1)
                .build())
            .build());

        ctx.export("numberOfReturnedStreams", dataStreams.applyValue(getStreamsResult -> getStreamsResult.datas()).length());
    }
}

    Coming soon!

    Using getStreams

    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 getStreams(args: GetStreamsArgs, opts?: InvokeOptions): Promise<GetStreamsResult>
function getStreamsOutput(args: GetStreamsOutputArgs, opts?: InvokeOptions): Output<GetStreamsResult>
    def get_streams(pagination: Optional[GetStreamsPagination] = None,
                opts: Optional[InvokeOptions] = None) -> GetStreamsResult
def get_streams_output(pagination: Optional[pulumi.Input[GetStreamsPaginationArgs]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetStreamsResult]
    func GetStreams(ctx *Context, args *GetStreamsArgs, opts ...InvokeOption) (*GetStreamsResult, error)
func GetStreamsOutput(ctx *Context, args *GetStreamsOutputArgs, opts ...InvokeOption) GetStreamsResultOutput

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

    public static class GetStreams 
{
    public static Task<GetStreamsResult> InvokeAsync(GetStreamsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamsResult> Invoke(GetStreamsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)
public static Output<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Pagination GetStreamsPagination
    Pagination details for the returned streams list
    Pagination GetStreamsPagination
    Pagination details for the returned streams list
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    pagination Property Map
    Pagination details for the returned streams list

    getStreams Result

    The following output properties are available:

    Datas List<GetStreamsData>
    Returned list of stream objects
    Id string
    The unique identifier of the resource
    Pagination GetStreamsPagination
    Pagination details for the returned streams list
    Datas []GetStreamsData
    Returned list of stream objects
    Id string
    The unique identifier of the resource
    Pagination GetStreamsPagination
    Pagination details for the returned streams list
    datas List<GetStreamsData>
    Returned list of stream objects
    id String
    The unique identifier of the resource
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    datas GetStreamsData[]
    Returned list of stream objects
    id string
    The unique identifier of the resource
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    datas Sequence[GetStreamsData]
    Returned list of stream objects
    id str
    The unique identifier of the resource
    pagination GetStreamsPagination
    Pagination details for the returned streams list
    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 streams list

    Supporting Types

    GetStreamsData

    AssetsCount double
    Count of the streaming assets attached to the stream resource
    ChangeLog GetStreamsDataChangeLog
    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
    Name string
    Customer-provided name of the stream resource
    Project GetStreamsDataProject
    Equinix Project attribute object
    State string
    Value representing provisioning status for the stream resource
    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 GetStreamsDataChangeLog
    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
    Name string
    Customer-provided name of the stream resource
    Project GetStreamsDataProject
    Equinix Project attribute object
    State string
    Value representing provisioning status for the stream resource
    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 GetStreamsDataChangeLog
    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
    name String
    Customer-provided name of the stream resource
    project GetStreamsDataProject
    Equinix Project attribute object
    state String
    Value representing provisioning status for the stream resource
    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 GetStreamsDataChangeLog
    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
    name string
    Customer-provided name of the stream resource
    project GetStreamsDataProject
    Equinix Project attribute object
    state string
    Value representing provisioning status for the stream resource
    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 GetStreamsDataChangeLog
    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
    name str
    Customer-provided name of the stream resource
    project GetStreamsDataProject
    Equinix Project attribute object
    state str
    Value representing provisioning status for the stream resource
    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
    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
    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

    GetStreamsDataChangeLog

    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

    GetStreamsDataProject

    ProjectId string
    Equinix Subscriber-assigned project ID
    ProjectId string
    Equinix Subscriber-assigned project ID
    projectId String
    Equinix Subscriber-assigned project ID
    projectId string
    Equinix Subscriber-assigned project ID
    project_id str
    Equinix Subscriber-assigned project ID
    projectId String
    Equinix Subscriber-assigned project ID

    GetStreamsPagination

    Limit double
    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 double
    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 double
    The total number of streams available to the user making the request
    Limit float64
    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 float64
    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 float64
    The total number of streams available to the user making the request
    limit Double
    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 Double
    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 Double
    The total number of streams 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 streams available to the user making the request
    limit float
    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 float
    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 float
    The total number of streams 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 streams 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.21.0 published on Friday, Feb 28, 2025 by Equinix
    equinix/pulumi-equinix