Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Stream Attached Assets with filters and 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 all = equinix.fabric.getStreamAttachments({
filters: [{
operator: "=",
property: "<filter_property>",
values: ["<list_of_values_to_filter>"],
}],
pagination: {
limit: 100,
offset: 0,
},
sorts: [{
direction: "<DESC|ASC>",
property: "/uuid",
}],
});
import pulumi
import pulumi_equinix as equinix
all = equinix.fabric.get_stream_attachments(filters=[{
"operator": "=",
"property": "<filter_property>",
"values": ["<list_of_values_to_filter>"],
}],
pagination={
"limit": 100,
"offset": 0,
},
sorts=[{
"direction": "<DESC|ASC>",
"property": "/uuid",
}])
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.GetStreamAttachments(ctx, &fabric.GetStreamAttachmentsArgs{
Filters: []fabric.GetStreamAttachmentsFilter{
{
Operator: "=",
Property: "<filter_property>",
Values: []string{
"<list_of_values_to_filter>",
},
},
},
Pagination: fabric.GetStreamAttachmentsPagination{
Limit: 100,
Offset: 0,
},
Sorts: []fabric.GetStreamAttachmentsSort{
{
Direction: "<DESC|ASC>",
Property: "/uuid",
},
},
}, 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 all = Equinix.Fabric.GetStreamAttachments.Invoke(new()
{
Filters = new[]
{
new Equinix.Fabric.Inputs.GetStreamAttachmentsFilterInputArgs
{
Operator = "=",
Property = "<filter_property>",
Values = new[]
{
"<list_of_values_to_filter>",
},
},
},
Pagination = new Equinix.Fabric.Inputs.GetStreamAttachmentsPaginationInputArgs
{
Limit = 100,
Offset = 0,
},
Sorts = new[]
{
new Equinix.Fabric.Inputs.GetStreamAttachmentsSortInputArgs
{
Direction = "<DESC|ASC>",
Property = "/uuid",
},
},
});
});
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.GetStreamAttachmentsArgs;
import com.pulumi.equinix.fabric.inputs.GetStreamAttachmentsPaginationArgs;
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 all = FabricFunctions.getStreamAttachments(GetStreamAttachmentsArgs.builder()
.filters(GetStreamAttachmentsFilterArgs.builder()
.operator("=")
.property("<filter_property>")
.values("<list_of_values_to_filter>")
.build())
.pagination(GetStreamAttachmentsPaginationArgs.builder()
.limit(100)
.offset(0)
.build())
.sorts(GetStreamAttachmentsSortArgs.builder()
.direction("<DESC|ASC>")
.property("/uuid")
.build())
.build());
}
}
variables:
all:
fn::invoke:
function: equinix:fabric:getStreamAttachments
arguments:
filters:
- operator: =
property: <filter_property>
values:
- <list_of_values_to_filter>
pagination:
limit: 100
offset: 0
sorts:
- direction: <DESC|ASC>
property: /uuid
Using getStreamAttachments
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 getStreamAttachments(args: GetStreamAttachmentsArgs, opts?: InvokeOptions): Promise<GetStreamAttachmentsResult>
function getStreamAttachmentsOutput(args: GetStreamAttachmentsOutputArgs, opts?: InvokeOptions): Output<GetStreamAttachmentsResult>def get_stream_attachments(filters: Optional[Sequence[GetStreamAttachmentsFilter]] = None,
pagination: Optional[GetStreamAttachmentsPagination] = None,
sorts: Optional[Sequence[GetStreamAttachmentsSort]] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamAttachmentsResult
def get_stream_attachments_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetStreamAttachmentsFilterArgs]]]] = None,
pagination: Optional[pulumi.Input[GetStreamAttachmentsPaginationArgs]] = None,
sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetStreamAttachmentsSortArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamAttachmentsResult]func GetStreamAttachments(ctx *Context, args *GetStreamAttachmentsArgs, opts ...InvokeOption) (*GetStreamAttachmentsResult, error)
func GetStreamAttachmentsOutput(ctx *Context, args *GetStreamAttachmentsOutputArgs, opts ...InvokeOption) GetStreamAttachmentsResultOutput> Note: This function is named GetStreamAttachments in the Go SDK.
public static class GetStreamAttachments
{
public static Task<GetStreamAttachmentsResult> InvokeAsync(GetStreamAttachmentsArgs args, InvokeOptions? opts = null)
public static Output<GetStreamAttachmentsResult> Invoke(GetStreamAttachmentsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetStreamAttachmentsResult> getStreamAttachments(GetStreamAttachmentsArgs args, InvokeOptions options)
public static Output<GetStreamAttachmentsResult> getStreamAttachments(GetStreamAttachmentsArgs args, InvokeOptions options)
fn::invoke:
function: equinix:fabric/getStreamAttachments:getStreamAttachments
arguments:
# arguments dictionaryThe following arguments are supported:
- Pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- Filters
List<Get
Stream Attachments Filter> - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- Sorts
List<Get
Stream Attachments Sort> - The list of sort criteria for the stream assets search request
- Pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- Filters
[]Get
Stream Attachments Filter - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- Sorts
[]Get
Stream Attachments Sort - The list of sort criteria for the stream assets search request
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- filters
List<Get
Stream Attachments Filter> - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- sorts
List<Get
Stream Attachments Sort> - The list of sort criteria for the stream assets search request
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- filters
Get
Stream Attachments Filter[] - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- sorts
Get
Stream Attachments Sort[] - The list of sort criteria for the stream assets search request
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- filters
Sequence[Get
Stream Attachments Filter] - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- sorts
Sequence[Get
Stream Attachments Sort] - The list of sort criteria for the stream assets search request
- pagination Property Map
- Pagination details for the returned streams list
- filters List<Property Map>
- List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- sorts List<Property Map>
- The list of sort criteria for the stream assets search request
getStreamAttachments Result
The following output properties are available:
- Datas
List<Get
Stream Attachments Data> - Returned list of stream objects
- Filters
List<Get
Stream Attachments Filter> - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- Id string
- The unique identifier of the resource
- Pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- Sorts
List<Get
Stream Attachments Sort> - The list of sort criteria for the stream assets search request
- Datas
[]Get
Stream Attachments Data - Returned list of stream objects
- Filters
[]Get
Stream Attachments Filter - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- Id string
- The unique identifier of the resource
- Pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- Sorts
[]Get
Stream Attachments Sort - The list of sort criteria for the stream assets search request
- datas
List<Get
Stream Attachments Data> - Returned list of stream objects
- filters
List<Get
Stream Attachments Filter> - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- id String
- The unique identifier of the resource
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- sorts
List<Get
Stream Attachments Sort> - The list of sort criteria for the stream assets search request
- datas
Get
Stream Attachments Data[] - Returned list of stream objects
- filters
Get
Stream Attachments Filter[] - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- id string
- The unique identifier of the resource
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- sorts
Get
Stream Attachments Sort[] - The list of sort criteria for the stream assets search request
- datas
Sequence[Get
Stream Attachments Data] - Returned list of stream objects
- filters
Sequence[Get
Stream Attachments Filter] - List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- id str
- The unique identifier of the resource
- pagination
Get
Stream Attachments Pagination - Pagination details for the returned streams list
- sorts
Sequence[Get
Stream Attachments Sort] - The list of sort criteria for the stream assets search request
- datas List<Property Map>
- Returned list of stream objects
- filters List<Property Map>
- List of filters to apply to the stream attachment get request. Maximum of 8. All will be AND'd together with 1 of the 8 being a possible OR group of 3
- id String
- The unique identifier of the resource
- pagination Property Map
- Pagination details for the returned streams list
- sorts List<Property Map>
- The list of sort criteria for the stream assets search request
Supporting Types
GetStreamAttachmentsData
- Attachment
Status string - Value representing status for the stream attachment
- Href string
- Equinix auto generated URI to the stream attachment in Equinix Portal
- Metrics
Enabled bool - Boolean value indicating enablement of metrics for this asset stream attachment
- Type string
- Equinix defined type for the asset stream attachment
- Uuid string
- Equinix-assigned unique id for the stream attachment
- Attachment
Status string - Value representing status for the stream attachment
- Href string
- Equinix auto generated URI to the stream attachment in Equinix Portal
- Metrics
Enabled bool - Boolean value indicating enablement of metrics for this asset stream attachment
- Type string
- Equinix defined type for the asset stream attachment
- Uuid string
- Equinix-assigned unique id for the stream attachment
- attachment
Status String - Value representing status for the stream attachment
- href String
- Equinix auto generated URI to the stream attachment in Equinix Portal
- metrics
Enabled Boolean - Boolean value indicating enablement of metrics for this asset stream attachment
- type String
- Equinix defined type for the asset stream attachment
- uuid String
- Equinix-assigned unique id for the stream attachment
- attachment
Status string - Value representing status for the stream attachment
- href string
- Equinix auto generated URI to the stream attachment in Equinix Portal
- metrics
Enabled boolean - Boolean value indicating enablement of metrics for this asset stream attachment
- type string
- Equinix defined type for the asset stream attachment
- uuid string
- Equinix-assigned unique id for the stream attachment
- attachment_
status str - Value representing status for the stream attachment
- href str
- Equinix auto generated URI to the stream attachment in Equinix Portal
- metrics_
enabled bool - Boolean value indicating enablement of metrics for this asset stream attachment
- type str
- Equinix defined type for the asset stream attachment
- uuid str
- Equinix-assigned unique id for the stream attachment
- attachment
Status String - Value representing status for the stream attachment
- href String
- Equinix auto generated URI to the stream attachment in Equinix Portal
- metrics
Enabled Boolean - Boolean value indicating enablement of metrics for this asset stream attachment
- type String
- Equinix defined type for the asset stream attachment
- uuid String
- Equinix-assigned unique id for the stream attachment
GetStreamAttachmentsFilter
- Operator string
- Operation applied to the values of the filter
- Property string
- Property to apply the filter to
- Values List<string>
- List of values to apply the operation to for the specified property
- Or bool
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
- Operator string
- Operation applied to the values of the filter
- Property string
- Property to apply the filter to
- Values []string
- List of values to apply the operation to for the specified property
- Or bool
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
- operator String
- Operation applied to the values of the filter
- property String
- Property to apply the filter to
- values List<String>
- List of values to apply the operation to for the specified property
- or Boolean
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
- operator string
- Operation applied to the values of the filter
- property string
- Property to apply the filter to
- values string[]
- List of values to apply the operation to for the specified property
- or boolean
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
- operator str
- Operation applied to the values of the filter
- property str
- Property to apply the filter to
- values Sequence[str]
- List of values to apply the operation to for the specified property
- or_ bool
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
- operator String
- Operation applied to the values of the filter
- property String
- Property to apply the filter to
- values List<String>
- List of values to apply the operation to for the specified property
- or Boolean
- Boolean value to specify if this filter is a part of the OR group. Has a maximum of 3 and only counts for 1 of the 8 possible filters
GetStreamAttachmentsPagination
- 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 streams 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 streams 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 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 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 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
GetStreamAttachmentsSort
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinixTerraform Provider.
