ibm 1.78.0, Apr 30 25

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

ibm.getAppConfigEnvironments

Explore with Pulumi AI

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

Retrieve information about an existing IBM Cloud App Configuration environments. 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 environments, see Managing access levels for App Configuration environments.

Example Usage

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

const appConfigEnvironments = ibm.getAppConfigEnvironments({
    expand: "expand",
    guid: "guid",
    limit: "limit",
    offset: "limit",
    tags: "tags",
});

import pulumi
import pulumi_ibm as ibm

app_config_environments = ibm.get_app_config_environments(expand="expand",
    guid="guid",
    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.GetAppConfigEnvironments(ctx, &ibm.GetAppConfigEnvironmentsArgs{
			Expand: pulumi.BoolRef("expand"),
			Guid:   "guid",
			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 appConfigEnvironments = Ibm.GetAppConfigEnvironments.Invoke(new()
    {
        Expand = "expand",
        Guid = "guid",
        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.GetAppConfigEnvironmentsArgs;
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 appConfigEnvironments = IbmFunctions.getAppConfigEnvironments(GetAppConfigEnvironmentsArgs.builder()
            .expand("expand")
            .guid("guid")
            .limit("limit")
            .offset("limit")
            .tags("tags")
            .build());

    }
}

variables:
  appConfigEnvironments:
    fn::invoke:
      function: ibm:getAppConfigEnvironments
      arguments:
        expand: expand
        guid: guid
        limit: limit
        offset: limit
        tags: tags

Using getAppConfigEnvironments

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 getAppConfigEnvironments(args: GetAppConfigEnvironmentsArgs, opts?: InvokeOptions): Promise<GetAppConfigEnvironmentsResult>
function getAppConfigEnvironmentsOutput(args: GetAppConfigEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetAppConfigEnvironmentsResult>

def get_app_config_environments(expand: Optional[bool] = None,
                                guid: Optional[str] = None,
                                id: Optional[str] = None,
                                limit: Optional[float] = None,
                                offset: Optional[float] = None,
                                tags: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAppConfigEnvironmentsResult
def get_app_config_environments_output(expand: Optional[pulumi.Input[bool]] = None,
                                guid: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                limit: Optional[pulumi.Input[float]] = None,
                                offset: Optional[pulumi.Input[float]] = None,
                                tags: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigEnvironmentsResult]

func GetAppConfigEnvironments(ctx *Context, args *GetAppConfigEnvironmentsArgs, opts ...InvokeOption) (*GetAppConfigEnvironmentsResult, error)
func GetAppConfigEnvironmentsOutput(ctx *Context, args *GetAppConfigEnvironmentsOutputArgs, opts ...InvokeOption) GetAppConfigEnvironmentsResultOutput

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

public static class GetAppConfigEnvironments 
{
    public static Task<GetAppConfigEnvironmentsResult> InvokeAsync(GetAppConfigEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppConfigEnvironmentsResult> Invoke(GetAppConfigEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppConfigEnvironmentsResult> getAppConfigEnvironments(GetAppConfigEnvironmentsArgs args, InvokeOptions options)
public static Output<GetAppConfigEnvironmentsResult> getAppConfigEnvironments(GetAppConfigEnvironmentsArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getAppConfigEnvironments:getAppConfigEnvironments
  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: (String) The unique identifier of the Environment List.
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.
Tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

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: (String) The unique identifier of the Environment List.
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.
Tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

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: (String) The unique identifier of the Environment List.
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.
tags String: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

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: (String) The unique identifier of the Environment List.
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.
tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

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: (String) The unique identifier of the Environment List.
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.
tags str: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

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: (String) The unique identifier of the Environment List.
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.
tags String: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.

getAppConfigEnvironments Result

The following output properties are available:

Environments List<GetAppConfigEnvironmentsEnvironment>: (List) Array of environments. Nested environments blocks have the following structure:
Firsts List<GetAppConfigEnvironmentsFirst>: (List) URL to navigate to the first page of records.
Guid string
Id string: (String) The unique identifier of the Environment List.
Lasts List<GetAppConfigEnvironmentsLast>: (List) URL to navigate to the last list of records.
Nexts List<GetAppConfigEnvironmentsNext>: (List) URL to navigate to the next list of records.
Previouses List<GetAppConfigEnvironmentsPreviouse>: (List) URL to navigate to the previous list of records.
TotalCount double: Number of records returned in the current response.
Expand bool
Limit double
Offset double
Tags string: (String) The tags associated with the environment.

Environments []GetAppConfigEnvironmentsEnvironment: (List) Array of environments. Nested environments blocks have the following structure:
Firsts []GetAppConfigEnvironmentsFirst: (List) URL to navigate to the first page of records.
Guid string
Id string: (String) The unique identifier of the Environment List.
Lasts []GetAppConfigEnvironmentsLast: (List) URL to navigate to the last list of records.
Nexts []GetAppConfigEnvironmentsNext: (List) URL to navigate to the next list of records.
Previouses []GetAppConfigEnvironmentsPreviouse: (List) URL to navigate to the previous list of records.
TotalCount float64: Number of records returned in the current response.
Expand bool
Limit float64
Offset float64
Tags string: (String) The tags associated with the environment.

environments List<GetAppConfigEnvironmentsEnvironment>: (List) Array of environments. Nested environments blocks have the following structure:
firsts List<GetAppConfigEnvironmentsFirst>: (List) URL to navigate to the first page of records.
guid String
id String: (String) The unique identifier of the Environment List.
lasts List<GetAppConfigEnvironmentsLast>: (List) URL to navigate to the last list of records.
nexts List<GetAppConfigEnvironmentsNext>: (List) URL to navigate to the next list of records.
previouses List<GetAppConfigEnvironmentsPreviouse>: (List) URL to navigate to the previous list of records.
totalCount Double: Number of records returned in the current response.
expand Boolean
limit Double
offset Double
tags String: (String) The tags associated with the environment.

environments GetAppConfigEnvironmentsEnvironment[]: (List) Array of environments. Nested environments blocks have the following structure:
firsts GetAppConfigEnvironmentsFirst[]: (List) URL to navigate to the first page of records.
guid string
id string: (String) The unique identifier of the Environment List.
lasts GetAppConfigEnvironmentsLast[]: (List) URL to navigate to the last list of records.
nexts GetAppConfigEnvironmentsNext[]: (List) URL to navigate to the next list of records.
previouses GetAppConfigEnvironmentsPreviouse[]: (List) URL to navigate to the previous list of records.
totalCount number: Number of records returned in the current response.
expand boolean
limit number
offset number
tags string: (String) The tags associated with the environment.

environments Sequence[GetAppConfigEnvironmentsEnvironment]: (List) Array of environments. Nested environments blocks have the following structure:
firsts Sequence[GetAppConfigEnvironmentsFirst]: (List) URL to navigate to the first page of records.
guid str
id str: (String) The unique identifier of the Environment List.
lasts Sequence[GetAppConfigEnvironmentsLast]: (List) URL to navigate to the last list of records.
nexts Sequence[GetAppConfigEnvironmentsNext]: (List) URL to navigate to the next list of records.
previouses Sequence[GetAppConfigEnvironmentsPreviouse]: (List) URL to navigate to the previous list of records.
total_count float: Number of records returned in the current response.
expand bool
limit float
offset float
tags str: (String) The tags associated with the environment.

environments List<Property Map>: (List) Array of environments. Nested environments blocks have the following structure:
firsts List<Property Map>: (List) URL to navigate to the first page of records.
guid String
id String: (String) The unique identifier of the Environment List.
lasts List<Property Map>: (List) URL to navigate to the last list of records.
nexts List<Property Map>: (List) URL to navigate to the next list of records.
previouses List<Property Map>: (List) URL to navigate to the previous list of records.
totalCount Number: Number of records returned in the current response.
expand Boolean
limit Number
offset Number
tags String: (String) The tags associated with the environment.

Supporting Types

GetAppConfigEnvironmentsEnvironment

ColorCode string: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
CreatedTime string: (Timestamp) The creation time of the environment.
Description string: (String) The environment description.
EnvironmentId string: (String) Environment ID.
Href string: (String) The next href URL.
Name string: (String) Environment name.
Tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
UpdatedTime string: (Timestamp) The last modified time of the environment data.

ColorCode string: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
CreatedTime string: (Timestamp) The creation time of the environment.
Description string: (String) The environment description.
EnvironmentId string: (String) Environment ID.
Href string: (String) The next href URL.
Name string: (String) Environment name.
Tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
UpdatedTime string: (Timestamp) The last modified time of the environment data.

colorCode String: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
createdTime String: (Timestamp) The creation time of the environment.
description String: (String) The environment description.
environmentId String: (String) Environment ID.
href String: (String) The next href URL.
name String: (String) Environment name.
tags String: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
updatedTime String: (Timestamp) The last modified time of the environment data.

colorCode string: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
createdTime string: (Timestamp) The creation time of the environment.
description string: (String) The environment description.
environmentId string: (String) Environment ID.
href string: (String) The next href URL.
name string: (String) Environment name.
tags string: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
updatedTime string: (Timestamp) The last modified time of the environment data.

color_code str: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
created_time str: (Timestamp) The creation time of the environment.
description str: (String) The environment description.
environment_id str: (String) Environment ID.
href str: (String) The next href URL.
name str: (String) Environment name.
tags str: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
updated_time str: (Timestamp) The last modified time of the environment data.

colorCode String: (String) The color code to distinguish the environment. The Hexadecimal code for the color. For example #FF2200 for red.
createdTime String: (Timestamp) The creation time of the environment.
description String: (String) The environment description.
environmentId String: (String) Environment ID.
href String: (String) The next href URL.
name String: (String) Environment name.
tags String: Filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags.
updatedTime String: (Timestamp) The last modified time of the environment data.

GetAppConfigEnvironmentsFirst

Href string: (String) The next href URL.

Href string: (String) The next href URL.

href String: (String) The next href URL.

href string: (String) The next href URL.

href str: (String) The next href URL.

href String: (String) The next href URL.

GetAppConfigEnvironmentsLast

Href string: (String) The next href URL.

Href string: (String) The next href URL.

href String: (String) The next href URL.

href string: (String) The next href URL.

href str: (String) The next href URL.

href String: (String) The next href URL.

GetAppConfigEnvironmentsNext

Href string: (String) The next href URL.

Href string: (String) The next href URL.

href String: (String) The next href URL.

href string: (String) The next href URL.

href str: (String) The next href URL.

href String: (String) The next href URL.

GetAppConfigEnvironmentsPreviouse

Href string: (String) The next href URL.

Href string: (String) The next href URL.

href String: (String) The next href URL.

href string: (String) The next href URL.

href str: (String) The next href URL.

href String: (String) The next href URL.

Package Details

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

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

ibm-cloud/terraform-provider-ibm

ibm.getAppConfigEnvironments

On this page

On this page

Example Usage

Using getAppConfigEnvironments

getAppConfigEnvironments Result

Supporting Types

GetAppConfigEnvironmentsEnvironment

GetAppConfigEnvironmentsFirst

GetAppConfigEnvironmentsLast

GetAppConfigEnvironmentsNext

GetAppConfigEnvironmentsPreviouse

Package Details

On this page

On this page