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

ibm.getAppConfigCollections

Explore with Pulumi AI

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

    Provides a read-only data source for collection. 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 features flag, see App Configuration concepts.

    Using getAppConfigCollections

    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 getAppConfigCollections(args: GetAppConfigCollectionsArgs, opts?: InvokeOptions): Promise<GetAppConfigCollectionsResult>
    function getAppConfigCollectionsOutput(args: GetAppConfigCollectionsOutputArgs, opts?: InvokeOptions): Output<GetAppConfigCollectionsResult>
    def get_app_config_collections(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,
                                   opts: Optional[InvokeOptions] = None) -> GetAppConfigCollectionsResult
    def get_app_config_collections_output(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,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigCollectionsResult]
    func GetAppConfigCollections(ctx *Context, args *GetAppConfigCollectionsArgs, opts ...InvokeOption) (*GetAppConfigCollectionsResult, error)
    func GetAppConfigCollectionsOutput(ctx *Context, args *GetAppConfigCollectionsOutputArgs, opts ...InvokeOption) GetAppConfigCollectionsResultOutput

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

    public static class GetAppConfigCollections 
    {
        public static Task<GetAppConfigCollectionsResult> InvokeAsync(GetAppConfigCollectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetAppConfigCollectionsResult> Invoke(GetAppConfigCollectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppConfigCollectionsResult> getAppConfigCollections(GetAppConfigCollectionsArgs args, InvokeOptions options)
    public static Output<GetAppConfigCollectionsResult> getAppConfigCollections(GetAppConfigCollectionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getAppConfigCollections:getAppConfigCollections
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Guid string
    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
    The unique identifier of the collections source.
    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.
    Guid string
    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
    The unique identifier of the collections source.
    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.
    guid String
    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
    The unique identifier of the collections source.
    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.
    guid string
    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
    The unique identifier of the collections source.
    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.
    guid str
    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
    The unique identifier of the collections source.
    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.
    guid String
    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
    The unique identifier of the collections source.
    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.

    getAppConfigCollections Result

    The following output properties are available:

    Collections List<GetAppConfigCollectionsCollection>
    Array of collections. Nested collections blocks have the following structure:
    Guid string
    Id string
    The unique identifier of the collections source.
    TotalCount double
    Number of records returned in the current response.
    Expand bool
    Includes List<string>
    Limit double
    Offset double
    Collections []GetAppConfigCollectionsCollection
    Array of collections. Nested collections blocks have the following structure:
    Guid string
    Id string
    The unique identifier of the collections source.
    TotalCount float64
    Number of records returned in the current response.
    Expand bool
    Includes []string
    Limit float64
    Offset float64
    collections List<GetAppConfigCollectionsCollection>
    Array of collections. Nested collections blocks have the following structure:
    guid String
    id String
    The unique identifier of the collections source.
    totalCount Double
    Number of records returned in the current response.
    expand Boolean
    includes List<String>
    limit Double
    offset Double
    collections GetAppConfigCollectionsCollection[]
    Array of collections. Nested collections blocks have the following structure:
    guid string
    id string
    The unique identifier of the collections source.
    totalCount number
    Number of records returned in the current response.
    expand boolean
    includes string[]
    limit number
    offset number
    collections Sequence[GetAppConfigCollectionsCollection]
    Array of collections. Nested collections blocks have the following structure:
    guid str
    id str
    The unique identifier of the collections source.
    total_count float
    Number of records returned in the current response.
    expand bool
    includes Sequence[str]
    limit float
    offset float
    collections List<Property Map>
    Array of collections. Nested collections blocks have the following structure:
    guid String
    id String
    The unique identifier of the collections source.
    totalCount Number
    Number of records returned in the current response.
    expand Boolean
    includes List<String>
    limit Number
    offset Number

    Supporting Types

    GetAppConfigCollectionsCollection

    CollectionId string
    Collection Id.
    CreatedTime string
    Creation time of the collection.
    Description string
    Collection description.
    Features List<GetAppConfigCollectionsCollectionFeature>
    Include the associated collections or targeting rules details in the response.
    FeaturesCount double
    Number of features associated with the collection.
    Href string
    (String) The next href URL.
    Name string
    Property name.
    Properties List<GetAppConfigCollectionsCollectionProperty>
    Filter collections by a list of comma separated properties.
    PropertiesCount double
    Number of features associated with the collection.
    Tags string
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    UpdatedTime string
    Last updated time of the collection data.
    CollectionId string
    Collection Id.
    CreatedTime string
    Creation time of the collection.
    Description string
    Collection description.
    Features []GetAppConfigCollectionsCollectionFeature
    Include the associated collections or targeting rules details in the response.
    FeaturesCount float64
    Number of features associated with the collection.
    Href string
    (String) The next href URL.
    Name string
    Property name.
    Properties []GetAppConfigCollectionsCollectionProperty
    Filter collections by a list of comma separated properties.
    PropertiesCount float64
    Number of features associated with the collection.
    Tags string
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    UpdatedTime string
    Last updated time of the collection data.
    collectionId String
    Collection Id.
    createdTime String
    Creation time of the collection.
    description String
    Collection description.
    features List<GetAppConfigCollectionsCollectionFeature>
    Include the associated collections or targeting rules details in the response.
    featuresCount Double
    Number of features associated with the collection.
    href String
    (String) The next href URL.
    name String
    Property name.
    properties List<GetAppConfigCollectionsCollectionProperty>
    Filter collections by a list of comma separated properties.
    propertiesCount Double
    Number of features associated with the collection.
    tags String
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    updatedTime String
    Last updated time of the collection data.
    collectionId string
    Collection Id.
    createdTime string
    Creation time of the collection.
    description string
    Collection description.
    features GetAppConfigCollectionsCollectionFeature[]
    Include the associated collections or targeting rules details in the response.
    featuresCount number
    Number of features associated with the collection.
    href string
    (String) The next href URL.
    name string
    Property name.
    properties GetAppConfigCollectionsCollectionProperty[]
    Filter collections by a list of comma separated properties.
    propertiesCount number
    Number of features associated with the collection.
    tags string
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    updatedTime string
    Last updated time of the collection data.
    collection_id str
    Collection Id.
    created_time str
    Creation time of the collection.
    description str
    Collection description.
    features Sequence[GetAppConfigCollectionsCollectionFeature]
    Include the associated collections or targeting rules details in the response.
    features_count float
    Number of features associated with the collection.
    href str
    (String) The next href URL.
    name str
    Property name.
    properties Sequence[GetAppConfigCollectionsCollectionProperty]
    Filter collections by a list of comma separated properties.
    properties_count float
    Number of features associated with the collection.
    tags str
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    updated_time str
    Last updated time of the collection data.
    collectionId String
    Collection Id.
    createdTime String
    Creation time of the collection.
    description String
    Collection description.
    features List<Property Map>
    Include the associated collections or targeting rules details in the response.
    featuresCount Number
    Number of features associated with the collection.
    href String
    (String) The next href URL.
    name String
    Property name.
    properties List<Property Map>
    Filter collections by a list of comma separated properties.
    propertiesCount Number
    Number of features associated with the collection.
    tags String
    Flter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
    updatedTime String
    Last updated time of the collection data.

    GetAppConfigCollectionsCollectionFeature

    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.

    GetAppConfigCollectionsCollectionProperty

    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.

    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