1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppConfigProperty
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getAppConfigProperty

Explore with Pulumi AI

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

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const appConfigProperty = ibm.getAppConfigProperty({
        environmentId: "environment_id",
        guid: "guid",
        propertyId: "property_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    app_config_property = ibm.get_app_config_property(environment_id="environment_id",
        guid="guid",
        property_id="property_id")
    
    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.LookupAppConfigProperty(ctx, &ibm.LookupAppConfigPropertyArgs{
    			EnvironmentId: "environment_id",
    			Guid:          "guid",
    			PropertyId:    "property_id",
    		}, 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 appConfigProperty = Ibm.GetAppConfigProperty.Invoke(new()
        {
            EnvironmentId = "environment_id",
            Guid = "guid",
            PropertyId = "property_id",
        });
    
    });
    
    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.GetAppConfigPropertyArgs;
    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 appConfigProperty = IbmFunctions.getAppConfigProperty(GetAppConfigPropertyArgs.builder()
                .environmentId("environment_id")
                .guid("guid")
                .propertyId("property_id")
                .build());
    
        }
    }
    
    variables:
      appConfigProperty:
        fn::invoke:
          function: ibm:getAppConfigProperty
          arguments:
            environmentId: environment_id
            guid: guid
            propertyId: property_id
    

    Using getAppConfigProperty

    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 getAppConfigProperty(args: GetAppConfigPropertyArgs, opts?: InvokeOptions): Promise<GetAppConfigPropertyResult>
    function getAppConfigPropertyOutput(args: GetAppConfigPropertyOutputArgs, opts?: InvokeOptions): Output<GetAppConfigPropertyResult>
    def get_app_config_property(environment_id: Optional[str] = None,
                                guid: Optional[str] = None,
                                id: Optional[str] = None,
                                include: Optional[str] = None,
                                property_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAppConfigPropertyResult
    def get_app_config_property_output(environment_id: Optional[pulumi.Input[str]] = None,
                                guid: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                include: Optional[pulumi.Input[str]] = None,
                                property_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigPropertyResult]
    func LookupAppConfigProperty(ctx *Context, args *LookupAppConfigPropertyArgs, opts ...InvokeOption) (*LookupAppConfigPropertyResult, error)
    func LookupAppConfigPropertyOutput(ctx *Context, args *LookupAppConfigPropertyOutputArgs, opts ...InvokeOption) LookupAppConfigPropertyResultOutput

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

    public static class GetAppConfigProperty 
    {
        public static Task<GetAppConfigPropertyResult> InvokeAsync(GetAppConfigPropertyArgs args, InvokeOptions? opts = null)
        public static Output<GetAppConfigPropertyResult> Invoke(GetAppConfigPropertyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppConfigPropertyResult> getAppConfigProperty(GetAppConfigPropertyArgs args, InvokeOptions options)
    public static Output<GetAppConfigPropertyResult> getAppConfigProperty(GetAppConfigPropertyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getAppConfigProperty:getAppConfigProperty
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EnvironmentId string
    Environment Id.
    Guid string
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    PropertyId string
    Property Id.
    Id string
    Include string
    Include the associated collections in the response.
    EnvironmentId string
    Environment Id.
    Guid string
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    PropertyId string
    Property Id.
    Id string
    Include string
    Include the associated collections in the response.
    environmentId String
    Environment Id.
    guid String
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    propertyId String
    Property Id.
    id String
    include String
    Include the associated collections in the response.
    environmentId string
    Environment Id.
    guid string
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    propertyId string
    Property Id.
    id string
    include string
    Include the associated collections in the response.
    environment_id str
    Environment Id.
    guid str
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    property_id str
    Property Id.
    id str
    include str
    Include the associated collections in the response.
    environmentId String
    Environment Id.
    guid String
    guid of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    propertyId String
    Property Id.
    id String
    include String
    Include the associated collections in the response.

    getAppConfigProperty Result

    The following output properties are available:

    Collections List<GetAppConfigPropertyCollection>
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    CreatedTime string
    Creation time of the property.
    Description string
    Property description.
    EnvironmentId string
    Format 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.
    Guid string
    Href string
    Property URL.
    Id string
    Name string
    Name of the collection.
    PropertyId string
    The unique identifier of the app_config_property.
    SegmentExists bool
    Denotes if the targeting rules are specified for the property.
    SegmentRules List<GetAppConfigPropertySegmentRule>
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    Tags string
    Tags associated with the property.
    Type string
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    UpdatedTime string
    Last modified time of the property data.
    Value 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.
    Include string
    Collections []GetAppConfigPropertyCollection
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    CreatedTime string
    Creation time of the property.
    Description string
    Property description.
    EnvironmentId string
    Format 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.
    Guid string
    Href string
    Property URL.
    Id string
    Name string
    Name of the collection.
    PropertyId string
    The unique identifier of the app_config_property.
    SegmentExists bool
    Denotes if the targeting rules are specified for the property.
    SegmentRules []GetAppConfigPropertySegmentRule
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    Tags string
    Tags associated with the property.
    Type string
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    UpdatedTime string
    Last modified time of the property data.
    Value 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.
    Include string
    collections List<GetAppConfigPropertyCollection>
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    createdTime String
    Creation time of the property.
    description String
    Property description.
    environmentId String
    format 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.
    guid String
    href String
    Property URL.
    id String
    name String
    Name of the collection.
    propertyId String
    The unique identifier of the app_config_property.
    segmentExists Boolean
    Denotes if the targeting rules are specified for the property.
    segmentRules List<GetAppConfigPropertySegmentRule>
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    tags String
    Tags associated with the property.
    type String
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    updatedTime String
    Last modified time of the property data.
    value 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.
    include String
    collections GetAppConfigPropertyCollection[]
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    createdTime string
    Creation time of the property.
    description string
    Property description.
    environmentId string
    format 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.
    guid string
    href string
    Property URL.
    id string
    name string
    Name of the collection.
    propertyId string
    The unique identifier of the app_config_property.
    segmentExists boolean
    Denotes if the targeting rules are specified for the property.
    segmentRules GetAppConfigPropertySegmentRule[]
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    tags string
    Tags associated with the property.
    type string
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    updatedTime string
    Last modified time of the property data.
    value 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.
    include string
    collections Sequence[GetAppConfigPropertyCollection]
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    created_time str
    Creation time of the property.
    description str
    Property description.
    environment_id str
    format str
    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.
    guid str
    href str
    Property URL.
    id str
    name str
    Name of the collection.
    property_id str
    The unique identifier of the app_config_property.
    segment_exists bool
    Denotes if the targeting rules are specified for the property.
    segment_rules Sequence[GetAppConfigPropertySegmentRule]
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    tags str
    Tags associated with the property.
    type str
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    updated_time str
    Last modified time of the property data.
    value str
    Value to be used for evaluation for this rule. The value can be Boolean, String or a Numeric value as per the type attribute.
    include str
    collections List<Property Map>
    List of collection id representing the collections that are associated with the specified property. Nested collections blocks have the following structure:
    createdTime String
    Creation time of the property.
    description String
    Property description.
    environmentId String
    format 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.
    guid String
    href String
    Property URL.
    id String
    name String
    Name of the collection.
    propertyId String
    The unique identifier of the app_config_property.
    segmentExists Boolean
    Denotes if the targeting rules are specified for the property.
    segmentRules List<Property Map>
    Specify the targeting rules that is used to set different property values for different segments. Nested segment_rules blocks have the following structure:
    tags String
    Tags associated with the property.
    type String
    Type of the Property (BOOLEAN, STRING, NUMERIC).
    updatedTime String
    Last modified time of the property data.
    value 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.
    include String

    Supporting Types

    GetAppConfigPropertyCollection

    CollectionId string
    Collection id.
    Name string
    Name of the collection.
    CollectionId string
    Collection id.
    Name string
    Name of the collection.
    collectionId String
    Collection id.
    name String
    Name of the collection.
    collectionId string
    Collection id.
    name string
    Name of the collection.
    collection_id str
    Collection id.
    name str
    Name of the collection.
    collectionId String
    Collection id.
    name String
    Name of the collection.

    GetAppConfigPropertySegmentRule

    Order double
    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 List<GetAppConfigPropertySegmentRuleRule>
    Rules array. Nested rules blocks have the following structure:
    Value 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 float64
    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 []GetAppConfigPropertySegmentRuleRule
    Rules array. Nested rules blocks have the following structure:
    Value 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 Double
    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 List<GetAppConfigPropertySegmentRuleRule>
    Rules array. Nested rules blocks have the following structure:
    value 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 number
    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 GetAppConfigPropertySegmentRuleRule[]
    Rules array. Nested rules blocks have the following structure:
    value 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 float
    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 Sequence[GetAppConfigPropertySegmentRuleRule]
    Rules array. Nested rules blocks have the following structure:
    value str
    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 Number
    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 List<Property Map>
    Rules array. Nested rules blocks have the following structure:
    value 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.

    GetAppConfigPropertySegmentRuleRule

    Segments List<string>
    List of segment ids that are used for targeting using the rule.
    Segments []string
    List of segment ids that are used for targeting using the rule.
    segments List<String>
    List of segment ids that are used for targeting using the rule.
    segments string[]
    List of segment ids that are used for targeting using the rule.
    segments Sequence[str]
    List of segment ids that are used for targeting using the rule.
    segments List<String>
    List of segment ids that are used for targeting using the rule.

    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