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

equinix.fabric.getStreams

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 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;
Copy
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))
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 {
		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
	})
}
Copy
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,
    };
});
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.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());
    }
}
Copy
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>
Copy
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]
Copy
func GetStreams(ctx *Context, args *GetStreamsArgs, opts ...InvokeOption) (*GetStreamsResult, error)
func GetStreamsOutput(ctx *Context, args *GetStreamsOutputArgs, opts ...InvokeOption) GetStreamsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)
public static Output<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: equinix:fabric/getStreams:getStreams
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Pagination This property is required. GetStreamsPagination
Pagination details for the returned streams list
Pagination This property is required. GetStreamsPagination
Pagination details for the returned streams list
pagination This property is required. GetStreamsPagination
Pagination details for the returned streams list
pagination This property is required. GetStreamsPagination
Pagination details for the returned streams list
pagination This property is required. GetStreamsPagination
Pagination details for the returned streams list
pagination This property is required. 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 This property is required. double
Count of the streaming assets attached to the stream resource
ChangeLog This property is required. GetStreamsDataChangeLog
Details of the last change on the stream resource
Description This property is required. string
Customer-provided description of the stream resource
Href This property is required. string
Equinix auto generated URI to the stream resource in Equinix Portal
Name This property is required. string
Customer-provided name of the stream resource
Project This property is required. GetStreamsDataProject
Equinix Project attribute object
State This property is required. string
Value representing provisioning status for the stream resource
StreamSubscriptionsCount This property is required. double
Count of the client subscriptions on the stream resource
Type This property is required. string
Equinix defined Streaming Type
Uuid This property is required. string
Equinix-assigned unique id for the stream resource
AssetsCount This property is required. float64
Count of the streaming assets attached to the stream resource
ChangeLog This property is required. GetStreamsDataChangeLog
Details of the last change on the stream resource
Description This property is required. string
Customer-provided description of the stream resource
Href This property is required. string
Equinix auto generated URI to the stream resource in Equinix Portal
Name This property is required. string
Customer-provided name of the stream resource
Project This property is required. GetStreamsDataProject
Equinix Project attribute object
State This property is required. string
Value representing provisioning status for the stream resource
StreamSubscriptionsCount This property is required. float64
Count of the client subscriptions on the stream resource
Type This property is required. string
Equinix defined Streaming Type
Uuid This property is required. string
Equinix-assigned unique id for the stream resource
assetsCount This property is required. Double
Count of the streaming assets attached to the stream resource
changeLog This property is required. GetStreamsDataChangeLog
Details of the last change on the stream resource
description This property is required. String
Customer-provided description of the stream resource
href This property is required. String
Equinix auto generated URI to the stream resource in Equinix Portal
name This property is required. String
Customer-provided name of the stream resource
project This property is required. GetStreamsDataProject
Equinix Project attribute object
state This property is required. String
Value representing provisioning status for the stream resource
streamSubscriptionsCount This property is required. Double
Count of the client subscriptions on the stream resource
type This property is required. String
Equinix defined Streaming Type
uuid This property is required. String
Equinix-assigned unique id for the stream resource
assetsCount This property is required. number
Count of the streaming assets attached to the stream resource
changeLog This property is required. GetStreamsDataChangeLog
Details of the last change on the stream resource
description This property is required. string
Customer-provided description of the stream resource
href This property is required. string
Equinix auto generated URI to the stream resource in Equinix Portal
name This property is required. string
Customer-provided name of the stream resource
project This property is required. GetStreamsDataProject
Equinix Project attribute object
state This property is required. string
Value representing provisioning status for the stream resource
streamSubscriptionsCount This property is required. number
Count of the client subscriptions on the stream resource
type This property is required. string
Equinix defined Streaming Type
uuid This property is required. string
Equinix-assigned unique id for the stream resource
assets_count This property is required. float
Count of the streaming assets attached to the stream resource
change_log This property is required. GetStreamsDataChangeLog
Details of the last change on the stream resource
description This property is required. str
Customer-provided description of the stream resource
href This property is required. str
Equinix auto generated URI to the stream resource in Equinix Portal
name This property is required. str
Customer-provided name of the stream resource
project This property is required. GetStreamsDataProject
Equinix Project attribute object
state This property is required. str
Value representing provisioning status for the stream resource
stream_subscriptions_count This property is required. float
Count of the client subscriptions on the stream resource
type This property is required. str
Equinix defined Streaming Type
uuid This property is required. str
Equinix-assigned unique id for the stream resource
assetsCount This property is required. Number
Count of the streaming assets attached to the stream resource
changeLog This property is required. Property Map
Details of the last change on the stream resource
description This property is required. String
Customer-provided description of the stream resource
href This property is required. String
Equinix auto generated URI to the stream resource in Equinix Portal
name This property is required. String
Customer-provided name of the stream resource
project This property is required. Property Map
Equinix Project attribute object
state This property is required. String
Value representing provisioning status for the stream resource
streamSubscriptionsCount This property is required. Number
Count of the client subscriptions on the stream resource
type This property is required. String
Equinix defined Streaming Type
uuid This property is required. String
Equinix-assigned unique id for the stream resource

GetStreamsDataChangeLog

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

GetStreamsDataProject

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

GetStreamsPagination

Limit This property is required. double
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
Next This property is required. string
The URL relative to the next item in the response
Offset This property is required. double
Index of the first item returned in the response. The default is 0
Previous This property is required. string
The URL relative to the previous item in the response
Total This property is required. double
The total number of streams available to the user making the request
Limit This property is required. float64
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
Next This property is required. string
The URL relative to the next item in the response
Offset This property is required. float64
Index of the first item returned in the response. The default is 0
Previous This property is required. string
The URL relative to the previous item in the response
Total This property is required. float64
The total number of streams available to the user making the request
limit This property is required. Double
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
next This property is required. String
The URL relative to the next item in the response
offset This property is required. Double
Index of the first item returned in the response. The default is 0
previous This property is required. String
The URL relative to the previous item in the response
total This property is required. Double
The total number of streams available to the user making the request
limit This property is required. number
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
next This property is required. string
The URL relative to the next item in the response
offset This property is required. number
Index of the first item returned in the response. The default is 0
previous This property is required. string
The URL relative to the previous item in the response
total This property is required. number
The total number of streams available to the user making the request
limit This property is required. float
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
next This property is required. str
The URL relative to the next item in the response
offset This property is required. float
Index of the first item returned in the response. The default is 0
previous This property is required. str
The URL relative to the previous item in the response
total This property is required. float
The total number of streams available to the user making the request
limit This property is required. Number
Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20
next This property is required. String
The URL relative to the next item in the response
offset This property is required. Number
Index of the first item returned in the response. The default is 0
previous This property is required. String
The URL relative to the previous item in the response
total This property is required. 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 v0.21.0 published on Friday, Feb 28, 2025 by Equinix