Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppConfigSegments
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getAppConfigSegments

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about an existing IBM Cloud App Configuration segments. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. For more information, about App Configuration segments, see App Configuration concepts.

    Example Usage

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

const appConfigSegments = ibm.getAppConfigSegments({
    expand: "expand",
    guid: "guid",
    include: "include",
    limit: "limit",
    offset: "limit",
    tags: "tags",
});

    import pulumi
import pulumi_ibm as ibm

app_config_segments = ibm.get_app_config_segments(expand="expand",
    guid="guid",
    include="include",
    limit="limit",
    offset="limit",
    tags="tags")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetAppConfigSegments(ctx, &ibm.GetAppConfigSegmentsArgs{
			Expand:  pulumi.BoolRef("expand"),
			Guid:    "guid",
			Include: pulumi.StringRef("include"),
			Limit:   pulumi.Float64Ref("limit"),
			Offset:  pulumi.Float64Ref("limit"),
			Tags:    pulumi.StringRef("tags"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var appConfigSegments = Ibm.GetAppConfigSegments.Invoke(new()
    {
        Expand = "expand",
        Guid = "guid",
        Include = "include",
        Limit = "limit",
        Offset = "limit",
        Tags = "tags",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetAppConfigSegmentsArgs;
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 appConfigSegments = IbmFunctions.getAppConfigSegments(GetAppConfigSegmentsArgs.builder()
            .expand("expand")
            .guid("guid")
            .include("include")
            .limit("limit")
            .offset("limit")
            .tags("tags")
            .build());

    }
}

    variables:
  appConfigSegments:
    fn::invoke:
      function: ibm:getAppConfigSegments
      arguments:
        expand: expand
        guid: guid
        include: include
        limit: limit
        offset: limit
        tags: tags

    Using getAppConfigSegments

    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 getAppConfigSegments(args: GetAppConfigSegmentsArgs, opts?: InvokeOptions): Promise<GetAppConfigSegmentsResult>
function getAppConfigSegmentsOutput(args: GetAppConfigSegmentsOutputArgs, opts?: InvokeOptions): Output<GetAppConfigSegmentsResult>
    def get_app_config_segments(expand: Optional[bool] = None,
                            guid: Optional[str] = None,
                            id: Optional[str] = None,
                            include: Optional[str] = None,
                            limit: Optional[float] = None,
                            offset: Optional[float] = None,
                            sort: Optional[str] = None,
                            tags: Optional[str] = None,
                            total_count: Optional[float] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAppConfigSegmentsResult
def get_app_config_segments_output(expand: Optional[pulumi.Input[bool]] = None,
                            guid: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            include: Optional[pulumi.Input[str]] = None,
                            limit: Optional[pulumi.Input[float]] = None,
                            offset: Optional[pulumi.Input[float]] = None,
                            sort: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[str]] = None,
                            total_count: Optional[pulumi.Input[float]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigSegmentsResult]
    func GetAppConfigSegments(ctx *Context, args *GetAppConfigSegmentsArgs, opts ...InvokeOption) (*GetAppConfigSegmentsResult, error)
func GetAppConfigSegmentsOutput(ctx *Context, args *GetAppConfigSegmentsOutputArgs, opts ...InvokeOption) GetAppConfigSegmentsResultOutput

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

    public static class GetAppConfigSegments 
{
    public static Task<GetAppConfigSegmentsResult> InvokeAsync(GetAppConfigSegmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppConfigSegmentsResult> Invoke(GetAppConfigSegmentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAppConfigSegmentsResult> getAppConfigSegments(GetAppConfigSegmentsArgs args, InvokeOptions options)
public static Output<GetAppConfigSegmentsResult> getAppConfigSegments(GetAppConfigSegmentsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getAppConfigSegments:getAppConfigSegments
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    Expand bool
    If set to true, returns expanded view of the resource details.
    Id string
    Include string
    Segment details to include the associated rules in the response.
    Limit double
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    Offset double
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    Sort string
    Sort the segment details based on the specified attribute.
    Tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    TotalCount double
    (Integer) Total number of records
    Guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    Expand bool
    If set to true, returns expanded view of the resource details.
    Id string
    Include string
    Segment details to include the associated rules in the response.
    Limit float64
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    Offset float64
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    Sort string
    Sort the segment details based on the specified attribute.
    Tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    TotalCount float64
    (Integer) Total number of records
    guid String
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    expand Boolean
    If set to true, returns expanded view of the resource details.
    id String
    include String
    Segment details to include the associated rules in the response.
    limit Double
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    offset Double
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    sort String
    Sort the segment details based on the specified attribute.
    tags String
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    totalCount Double
    (Integer) Total number of records
    guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    expand boolean
    If set to true, returns expanded view of the resource details.
    id string
    include string
    Segment details to include the associated rules in the response.
    limit number
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    offset number
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    sort string
    Sort the segment details based on the specified attribute.
    tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    totalCount number
    (Integer) Total number of records
    guid str
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    expand bool
    If set to true, returns expanded view of the resource details.
    id str
    include str
    Segment details to include the associated rules in the response.
    limit float
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    offset float
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    sort str
    Sort the segment details based on the specified attribute.
    tags str
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    total_count float
    (Integer) Total number of records
    guid String
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    expand Boolean
    If set to true, returns expanded view of the resource details.
    id String
    include String
    Segment details to include the associated rules in the response.
    limit Number
    The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.
    offset Number
    The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.
    sort String
    Sort the segment details based on the specified attribute.
    tags String
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    totalCount Number
    (Integer) Total number of records

    getAppConfigSegments Result

    The following output properties are available:

    Guid string
    Id string
    Segments List<GetAppConfigSegmentsSegment>
    (List) Array of Segments.
    Expand bool
    Include string
    Limit double
    (Integer) Number of records returned
    Offset double
    (Integer) Skipped number of records
    Sort string
    Tags string
    (String) Tags associated with the segments.
    TotalCount double
    (Integer) Total number of records
    Guid string
    Id string
    Segments []GetAppConfigSegmentsSegment
    (List) Array of Segments.
    Expand bool
    Include string
    Limit float64
    (Integer) Number of records returned
    Offset float64
    (Integer) Skipped number of records
    Sort string
    Tags string
    (String) Tags associated with the segments.
    TotalCount float64
    (Integer) Total number of records
    guid String
    id String
    segments List<GetAppConfigSegmentsSegment>
    (List) Array of Segments.
    expand Boolean
    include String
    limit Double
    (Integer) Number of records returned
    offset Double
    (Integer) Skipped number of records
    sort String
    tags String
    (String) Tags associated with the segments.
    totalCount Double
    (Integer) Total number of records
    guid string
    id string
    segments GetAppConfigSegmentsSegment[]
    (List) Array of Segments.
    expand boolean
    include string
    limit number
    (Integer) Number of records returned
    offset number
    (Integer) Skipped number of records
    sort string
    tags string
    (String) Tags associated with the segments.
    totalCount number
    (Integer) Total number of records
    guid str
    id str
    segments Sequence[GetAppConfigSegmentsSegment]
    (List) Array of Segments.
    expand bool
    include str
    limit float
    (Integer) Number of records returned
    offset float
    (Integer) Skipped number of records
    sort str
    tags str
    (String) Tags associated with the segments.
    total_count float
    (Integer) Total number of records
    guid String
    id String
    segments List<Property Map>
    (List) Array of Segments.
    expand Boolean
    include String
    limit Number
    (Integer) Number of records returned
    offset Number
    (Integer) Skipped number of records
    sort String
    tags String
    (String) Tags associated with the segments.
    totalCount Number
    (Integer) Total number of records

    Supporting Types

    GetAppConfigSegmentsSegment

    CreatedTime string
    (String) Creation time of the segment.
    Description string
    (String) Segment description.
    Features List<GetAppConfigSegmentsSegmentFeature>
    (List) List of Features associated with the segment.
    Href string
    (String) The next href URL.
    Name string
    Property name.
    Properties List<GetAppConfigSegmentsSegmentProperty>
    (List) List of properties associated with the segment.
    Rules List<GetAppConfigSegmentsSegmentRule>
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    SegmentId string
    (String) Segment id.
    Tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    UpdatedTime string
    (String) Last modified time of the segment data.
    CreatedTime string
    (String) Creation time of the segment.
    Description string
    (String) Segment description.
    Features []GetAppConfigSegmentsSegmentFeature
    (List) List of Features associated with the segment.
    Href string
    (String) The next href URL.
    Name string
    Property name.
    Properties []GetAppConfigSegmentsSegmentProperty
    (List) List of properties associated with the segment.
    Rules []GetAppConfigSegmentsSegmentRule
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    SegmentId string
    (String) Segment id.
    Tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    UpdatedTime string
    (String) Last modified time of the segment data.
    createdTime String
    (String) Creation time of the segment.
    description String
    (String) Segment description.
    features List<GetAppConfigSegmentsSegmentFeature>
    (List) List of Features associated with the segment.
    href String
    (String) The next href URL.
    name String
    Property name.
    properties List<GetAppConfigSegmentsSegmentProperty>
    (List) List of properties associated with the segment.
    rules List<GetAppConfigSegmentsSegmentRule>
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    segmentId String
    (String) Segment id.
    tags String
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    updatedTime String
    (String) Last modified time of the segment data.
    createdTime string
    (String) Creation time of the segment.
    description string
    (String) Segment description.
    features GetAppConfigSegmentsSegmentFeature[]
    (List) List of Features associated with the segment.
    href string
    (String) The next href URL.
    name string
    Property name.
    properties GetAppConfigSegmentsSegmentProperty[]
    (List) List of properties associated with the segment.
    rules GetAppConfigSegmentsSegmentRule[]
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    segmentId string
    (String) Segment id.
    tags string
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    updatedTime string
    (String) Last modified time of the segment data.
    created_time str
    (String) Creation time of the segment.
    description str
    (String) Segment description.
    features Sequence[GetAppConfigSegmentsSegmentFeature]
    (List) List of Features associated with the segment.
    href str
    (String) The next href URL.
    name str
    Property name.
    properties Sequence[GetAppConfigSegmentsSegmentProperty]
    (List) List of properties associated with the segment.
    rules Sequence[GetAppConfigSegmentsSegmentRule]
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    segment_id str
    (String) Segment id.
    tags str
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    updated_time str
    (String) Last modified time of the segment data.
    createdTime String
    (String) Creation time of the segment.
    description String
    (String) Segment description.
    features List<Property Map>
    (List) List of Features associated with the segment.
    href String
    (String) The next href URL.
    name String
    Property name.
    properties List<Property Map>
    (List) List of properties associated with the segment.
    rules List<Property Map>
    (List) List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines.
    segmentId String
    (String) Segment id.
    tags String
    Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.
    updatedTime String
    (String) Last modified time of the segment data.

    GetAppConfigSegmentsSegmentFeature

    FeatureId string
    Feature id.
    Name string
    Property name.
    FeatureId string
    Feature id.
    Name string
    Property name.
    featureId String
    Feature id.
    name String
    Property name.
    featureId string
    Feature id.
    name string
    Property name.
    feature_id str
    Feature id.
    name str
    Property name.
    featureId String
    Feature id.
    name String
    Property name.

    GetAppConfigSegmentsSegmentProperty

    Name string
    Property name.
    PropertyId string
    Property id.
    Name string
    Property name.
    PropertyId string
    Property id.
    name String
    Property name.
    propertyId String
    Property id.
    name string
    Property name.
    propertyId string
    Property id.
    name str
    Property name.
    property_id str
    Property id.
    name String
    Property name.
    propertyId String
    Property id.

    GetAppConfigSegmentsSegmentRule

    AttributeName string
    (String) Attribute name.
    Operator string
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    Values List<string>
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.
    AttributeName string
    (String) Attribute name.
    Operator string
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    Values []string
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.
    attributeName String
    (String) Attribute name.
    operator String
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    values List<String>
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.
    attributeName string
    (String) Attribute name.
    operator string
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    values string[]
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.
    attribute_name str
    (String) Attribute name.
    operator str
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    values Sequence[str]
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.
    attributeName String
    (String) Attribute name.
    operator String
    (String) Operator to be used for the evaluation if the entity belongs to the segment.
    values List<String>
    (String) List of values. Entities matching any of the given values will be considered to belong to the segment.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm