1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppConfigProperties
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getAppConfigProperties

Explore with Pulumi AI

Retrieve information about an existing IBM Cloud App Configuration properties. 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 properties, see App Configuration concepts.

Example Usage

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

const appConfigProperties = ibm.getAppConfigProperties({
    environmentId: "environment_id",
    guid: "guid",
});
Copy
import pulumi
import pulumi_ibm as ibm

app_config_properties = ibm.get_app_config_properties(environment_id="environment_id",
    guid="guid")
Copy
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.GetAppConfigProperties(ctx, &ibm.GetAppConfigPropertiesArgs{
			EnvironmentId: "environment_id",
			Guid:          "guid",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var appConfigProperties = Ibm.GetAppConfigProperties.Invoke(new()
    {
        EnvironmentId = "environment_id",
        Guid = "guid",
    });

});
Copy
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.GetAppConfigPropertiesArgs;
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 appConfigProperties = IbmFunctions.getAppConfigProperties(GetAppConfigPropertiesArgs.builder()
            .environmentId("environment_id")
            .guid("guid")
            .build());

    }
}
Copy
variables:
  appConfigProperties:
    fn::invoke:
      function: ibm:getAppConfigProperties
      arguments:
        environmentId: environment_id
        guid: guid
Copy

Using getAppConfigProperties

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 getAppConfigProperties(args: GetAppConfigPropertiesArgs, opts?: InvokeOptions): Promise<GetAppConfigPropertiesResult>
function getAppConfigPropertiesOutput(args: GetAppConfigPropertiesOutputArgs, opts?: InvokeOptions): Output<GetAppConfigPropertiesResult>
Copy
def get_app_config_properties(collections: Optional[Sequence[str]] = None,
                              environment_id: Optional[str] = None,
                              expand: Optional[bool] = None,
                              guid: Optional[str] = None,
                              id: Optional[str] = None,
                              includes: Optional[Sequence[str]] = None,
                              limit: Optional[float] = None,
                              offset: Optional[float] = None,
                              segments: Optional[Sequence[str]] = None,
                              sort: Optional[str] = None,
                              tags: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAppConfigPropertiesResult
def get_app_config_properties_output(collections: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              environment_id: Optional[pulumi.Input[str]] = None,
                              expand: Optional[pulumi.Input[bool]] = None,
                              guid: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              includes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              limit: Optional[pulumi.Input[float]] = None,
                              offset: Optional[pulumi.Input[float]] = None,
                              segments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              sort: Optional[pulumi.Input[str]] = None,
                              tags: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigPropertiesResult]
Copy
func GetAppConfigProperties(ctx *Context, args *GetAppConfigPropertiesArgs, opts ...InvokeOption) (*GetAppConfigPropertiesResult, error)
func GetAppConfigPropertiesOutput(ctx *Context, args *GetAppConfigPropertiesOutputArgs, opts ...InvokeOption) GetAppConfigPropertiesResultOutput
Copy

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

public static class GetAppConfigProperties 
{
    public static Task<GetAppConfigPropertiesResult> InvokeAsync(GetAppConfigPropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetAppConfigPropertiesResult> Invoke(GetAppConfigPropertiesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAppConfigPropertiesResult> getAppConfigProperties(GetAppConfigPropertiesArgs args, InvokeOptions options)
public static Output<GetAppConfigPropertiesResult> getAppConfigProperties(GetAppConfigPropertiesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getAppConfigProperties:getAppConfigProperties
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentId This property is required. string
Environment Id.
Guid This property is required. string
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
Collections List<string>
Filter properties by a list of comma separated collections.
Expand bool
If set to true, returns expanded view of the resource details.
Id string
(String) The unique identifier of the PropertiesList.
Includes List<string>
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.
Segments List<string>
Filter properties by a list of comma separated segments.
Sort string
Sort the feature details based on the specified attribute.
Tags string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
EnvironmentId This property is required. string
Environment Id.
Guid This property is required. string
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
Collections []string
Filter properties by a list of comma separated collections.
Expand bool
If set to true, returns expanded view of the resource details.
Id string
(String) The unique identifier of the PropertiesList.
Includes []string
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.
Segments []string
Filter properties by a list of comma separated segments.
Sort string
Sort the feature details based on the specified attribute.
Tags string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
environmentId This property is required. String
Environment Id.
guid This property is required. String
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collections List<String>
Filter properties by a list of comma separated collections.
expand Boolean
If set to true, returns expanded view of the resource details.
id String
(String) The unique identifier of the PropertiesList.
includes List<String>
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.
segments List<String>
Filter properties by a list of comma separated segments.
sort String
Sort the feature details based on the specified attribute.
tags String
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
environmentId This property is required. string
Environment Id.
guid This property is required. string
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collections string[]
Filter properties by a list of comma separated collections.
expand boolean
If set to true, returns expanded view of the resource details.
id string
(String) The unique identifier of the PropertiesList.
includes string[]
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.
segments string[]
Filter properties by a list of comma separated segments.
sort string
Sort the feature details based on the specified attribute.
tags string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
environment_id This property is required. str
Environment Id.
guid This property is required. str
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collections Sequence[str]
Filter properties by a list of comma separated collections.
expand bool
If set to true, returns expanded view of the resource details.
id str
(String) The unique identifier of the PropertiesList.
includes Sequence[str]
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.
segments Sequence[str]
Filter properties by a list of comma separated segments.
sort str
Sort the feature details based on the specified attribute.
tags str
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
environmentId This property is required. String
Environment Id.
guid This property is required. String
guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collections List<String>
Filter properties by a list of comma separated collections.
expand Boolean
If set to true, returns expanded view of the resource details.
id String
(String) The unique identifier of the PropertiesList.
includes List<String>
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.
segments List<String>
Filter properties by a list of comma separated segments.
sort String
Sort the feature details based on the specified attribute.
tags String
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

getAppConfigProperties Result

The following output properties are available:

EnvironmentId string
Guid string
Id string
(String) The unique identifier of the PropertiesList.
Properties List<GetAppConfigPropertiesProperty>
(List) Array of properties.
TotalCount double
Number of records returned in the current response.
Collections List<string>
List of collection id representing the collections that are associated with the specified property.
Expand bool
Includes List<string>
Limit double
Number of records returned
Offset double
Skipped number of records
Segments List<string>
(String) List of segment ids that are used for targeting using the rule.
Sort string
Tags string
(String) Tags associated with the property.
EnvironmentId string
Guid string
Id string
(String) The unique identifier of the PropertiesList.
Properties []GetAppConfigPropertiesProperty
(List) Array of properties.
TotalCount float64
Number of records returned in the current response.
Collections []string
List of collection id representing the collections that are associated with the specified property.
Expand bool
Includes []string
Limit float64
Number of records returned
Offset float64
Skipped number of records
Segments []string
(String) List of segment ids that are used for targeting using the rule.
Sort string
Tags string
(String) Tags associated with the property.
environmentId String
guid String
id String
(String) The unique identifier of the PropertiesList.
properties List<GetAppConfigPropertiesProperty>
(List) Array of properties.
totalCount Double
Number of records returned in the current response.
collections List<String>
List of collection id representing the collections that are associated with the specified property.
expand Boolean
includes List<String>
limit Double
Number of records returned
offset Double
Skipped number of records
segments List<String>
(String) List of segment ids that are used for targeting using the rule.
sort String
tags String
(String) Tags associated with the property.
environmentId string
guid string
id string
(String) The unique identifier of the PropertiesList.
properties GetAppConfigPropertiesProperty[]
(List) Array of properties.
totalCount number
Number of records returned in the current response.
collections string[]
List of collection id representing the collections that are associated with the specified property.
expand boolean
includes string[]
limit number
Number of records returned
offset number
Skipped number of records
segments string[]
(String) List of segment ids that are used for targeting using the rule.
sort string
tags string
(String) Tags associated with the property.
environment_id str
guid str
id str
(String) The unique identifier of the PropertiesList.
properties Sequence[GetAppConfigPropertiesProperty]
(List) Array of properties.
total_count float
Number of records returned in the current response.
collections Sequence[str]
List of collection id representing the collections that are associated with the specified property.
expand bool
includes Sequence[str]
limit float
Number of records returned
offset float
Skipped number of records
segments Sequence[str]
(String) List of segment ids that are used for targeting using the rule.
sort str
tags str
(String) Tags associated with the property.
environmentId String
guid String
id String
(String) The unique identifier of the PropertiesList.
properties List<Property Map>
(List) Array of properties.
totalCount Number
Number of records returned in the current response.
collections List<String>
List of collection id representing the collections that are associated with the specified property.
expand Boolean
includes List<String>
limit Number
Number of records returned
offset Number
Skipped number of records
segments List<String>
(String) List of segment ids that are used for targeting using the rule.
sort String
tags String
(String) Tags associated with the property.

Supporting Types

GetAppConfigPropertiesProperty

Collections This property is required. List<GetAppConfigPropertiesPropertyCollection>
Filter properties by a list of comma separated collections.
CreatedTime This property is required. string
Creation time of the property.
Description This property is required. string
(String) Property description.
Format This property is required. string
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
Href This property is required. string
(String) The next href URL.
Name This property is required. string
(String) Name of the collection.
PropertyId This property is required. string
(String) Property id.
SegmentExists This property is required. bool
(String) Denotes if the targeting rules are specified for the property.
SegmentRules This property is required. List<GetAppConfigPropertiesPropertySegmentRule>
(List) Specify the targeting rules that is used to set different property values for different segments.
Tags This property is required. string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
Type This property is required. string
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
UpdatedTime This property is required. string
Last modified time of the property data.
Value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
Collections This property is required. []GetAppConfigPropertiesPropertyCollection
Filter properties by a list of comma separated collections.
CreatedTime This property is required. string
Creation time of the property.
Description This property is required. string
(String) Property description.
Format This property is required. string
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
Href This property is required. string
(String) The next href URL.
Name This property is required. string
(String) Name of the collection.
PropertyId This property is required. string
(String) Property id.
SegmentExists This property is required. bool
(String) Denotes if the targeting rules are specified for the property.
SegmentRules This property is required. []GetAppConfigPropertiesPropertySegmentRule
(List) Specify the targeting rules that is used to set different property values for different segments.
Tags This property is required. string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
Type This property is required. string
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
UpdatedTime This property is required. string
Last modified time of the property data.
Value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
collections This property is required. List<GetAppConfigPropertiesPropertyCollection>
Filter properties by a list of comma separated collections.
createdTime This property is required. String
Creation time of the property.
description This property is required. String
(String) Property description.
format This property is required. String
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
href This property is required. String
(String) The next href URL.
name This property is required. String
(String) Name of the collection.
propertyId This property is required. String
(String) Property id.
segmentExists This property is required. Boolean
(String) Denotes if the targeting rules are specified for the property.
segmentRules This property is required. List<GetAppConfigPropertiesPropertySegmentRule>
(List) Specify the targeting rules that is used to set different property values for different segments.
tags This property is required. String
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
type This property is required. String
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
updatedTime This property is required. String
Last modified time of the property data.
value This property is required. String
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
collections This property is required. GetAppConfigPropertiesPropertyCollection[]
Filter properties by a list of comma separated collections.
createdTime This property is required. string
Creation time of the property.
description This property is required. string
(String) Property description.
format This property is required. string
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
href This property is required. string
(String) The next href URL.
name This property is required. string
(String) Name of the collection.
propertyId This property is required. string
(String) Property id.
segmentExists This property is required. boolean
(String) Denotes if the targeting rules are specified for the property.
segmentRules This property is required. GetAppConfigPropertiesPropertySegmentRule[]
(List) Specify the targeting rules that is used to set different property values for different segments.
tags This property is required. string
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
type This property is required. string
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
updatedTime This property is required. string
Last modified time of the property data.
value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
collections This property is required. Sequence[GetAppConfigPropertiesPropertyCollection]
Filter properties by a list of comma separated collections.
created_time This property is required. str
Creation time of the property.
description This property is required. str
(String) Property description.
format This property is required. str
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
href This property is required. str
(String) The next href URL.
name This property is required. str
(String) Name of the collection.
property_id This property is required. str
(String) Property id.
segment_exists This property is required. bool
(String) Denotes if the targeting rules are specified for the property.
segment_rules This property is required. Sequence[GetAppConfigPropertiesPropertySegmentRule]
(List) Specify the targeting rules that is used to set different property values for different segments.
tags This property is required. str
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
type This property is required. str
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
updated_time This property is required. str
Last modified time of the property data.
value This property is required. str
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
collections This property is required. List<Property Map>
Filter properties by a list of comma separated collections.
createdTime This property is required. String
Creation time of the property.
description This property is required. String
(String) Property description.
format This property is required. String
(String) Format of the property (TEXT, JSON, YAML) and this is a required attribute when TYPE STRING is used, not required for BOOLEAN and NUMERIC types.
href This property is required. String
(String) The next href URL.
name This property is required. String
(String) Name of the collection.
propertyId This property is required. String
(String) Property id.
segmentExists This property is required. Boolean
(String) Denotes if the targeting rules are specified for the property.
segmentRules This property is required. List<Property Map>
(List) Specify the targeting rules that is used to set different property values for different segments.
tags This property is required. String
Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
type This property is required. String
(String) Type of the Property (BOOLEAN, STRING, NUMERIC).
updatedTime This property is required. String
Last modified time of the property data.
value This property is required. String
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.

GetAppConfigPropertiesPropertyCollection

CollectionId This property is required. string
(String) Collection id.
Name This property is required. string
(String) Name of the collection.
CollectionId This property is required. string
(String) Collection id.
Name This property is required. string
(String) Name of the collection.
collectionId This property is required. String
(String) Collection id.
name This property is required. String
(String) Name of the collection.
collectionId This property is required. string
(String) Collection id.
name This property is required. string
(String) Name of the collection.
collection_id This property is required. str
(String) Collection id.
name This property is required. str
(String) Name of the collection.
collectionId This property is required. String
(String) Collection id.
name This property is required. String
(String) Name of the collection.

GetAppConfigPropertiesPropertySegmentRule

Order This property is required. double
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
Rules This property is required. List<GetAppConfigPropertiesPropertySegmentRuleRule>
(List) The rules array.
Value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
Order This property is required. float64
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
Rules This property is required. []GetAppConfigPropertiesPropertySegmentRuleRule
(List) The rules array.
Value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
order This property is required. Double
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
rules This property is required. List<GetAppConfigPropertiesPropertySegmentRuleRule>
(List) The rules array.
value This property is required. String
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
order This property is required. number
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
rules This property is required. GetAppConfigPropertiesPropertySegmentRuleRule[]
(List) The rules array.
value This property is required. string
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
order This property is required. float
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
rules This property is required. Sequence[GetAppConfigPropertiesPropertySegmentRuleRule]
(List) The rules array.
value This property is required. str
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
order This property is required. Number
(String) Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.
rules This property is required. List<Property Map>
(List) The rules array.
value This property is required. String
(String) Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.

GetAppConfigPropertiesPropertySegmentRuleRule

Segments This property is required. List<string>
Filter properties by a list of comma separated segments.
Segments This property is required. []string
Filter properties by a list of comma separated segments.
segments This property is required. List<String>
Filter properties by a list of comma separated segments.
segments This property is required. string[]
Filter properties by a list of comma separated segments.
segments This property is required. Sequence[str]
Filter properties by a list of comma separated segments.
segments This property is required. List<String>
Filter properties by a list of comma separated segments.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.