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

ibm.getAppConfigSnapshots

Explore with Pulumi AI

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

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.GetAppConfigSnapshotsArgs;
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 appConfigSnapshots = IbmFunctions.getAppConfigSnapshots(GetAppConfigSnapshotsArgs.builder()
            .collectionId("collection_id")
            .environmentId("environment_id")
            .guid("guid")
            .limit("limit")
            .offset("offset")
            .sort("sort")
            .build());

    }
}
Copy
variables:
  appConfigSnapshots:
    fn::invoke:
      function: ibm:getAppConfigSnapshots
      arguments:
        collectionId: collection_id
        environmentId: environment_id
        guid: guid
        limit: limit
        offset: offset
        sort: sort
Copy

Using getAppConfigSnapshots

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 getAppConfigSnapshots(args: GetAppConfigSnapshotsArgs, opts?: InvokeOptions): Promise<GetAppConfigSnapshotsResult>
function getAppConfigSnapshotsOutput(args: GetAppConfigSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetAppConfigSnapshotsResult>
Copy
def get_app_config_snapshots(collection_id: Optional[str] = None,
                             environment_id: Optional[str] = None,
                             guid: Optional[str] = None,
                             id: Optional[str] = None,
                             limit: Optional[float] = None,
                             offset: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAppConfigSnapshotsResult
def get_app_config_snapshots_output(collection_id: Optional[pulumi.Input[str]] = None,
                             environment_id: Optional[pulumi.Input[str]] = 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,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigSnapshotsResult]
Copy
func GetAppConfigSnapshots(ctx *Context, args *GetAppConfigSnapshotsArgs, opts ...InvokeOption) (*GetAppConfigSnapshotsResult, error)
func GetAppConfigSnapshotsOutput(ctx *Context, args *GetAppConfigSnapshotsOutputArgs, opts ...InvokeOption) GetAppConfigSnapshotsResultOutput
Copy

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

public static class GetAppConfigSnapshots 
{
    public static Task<GetAppConfigSnapshotsResult> InvokeAsync(GetAppConfigSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppConfigSnapshotsResult> Invoke(GetAppConfigSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAppConfigSnapshotsResult> getAppConfigSnapshots(GetAppConfigSnapshotsArgs args, InvokeOptions options)
public static Output<GetAppConfigSnapshotsResult> getAppConfigSnapshots(GetAppConfigSnapshotsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getAppConfigSnapshots:getAppConfigSnapshots
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Guid This property is required. string
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
CollectionId string
Filters the response based on the specified collection_id.
EnvironmentId string
Filters the response based on the specified environment_id.
Id string
Limit double
The number of records to retrieve. By default, the list operation return the first 10 records.
Offset double
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.
Guid This property is required. string
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
CollectionId string
Filters the response based on the specified collection_id.
EnvironmentId string
Filters the response based on the specified environment_id.
Id string
Limit float64
The number of records to retrieve. By default, the list operation return the first 10 records.
Offset float64
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.
guid This property is required. String
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collectionId String
Filters the response based on the specified collection_id.
environmentId String
Filters the response based on the specified environment_id.
id String
limit Double
The number of records to retrieve. By default, the list operation return the first 10 records.
offset Double
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.
guid This property is required. string
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collectionId string
Filters the response based on the specified collection_id.
environmentId string
Filters the response based on the specified environment_id.
id string
limit number
The number of records to retrieve. By default, the list operation return the first 10 records.
offset number
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.
guid This property is required. str
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collection_id str
Filters the response based on the specified collection_id.
environment_id str
Filters the response based on the specified environment_id.
id str
limit float
The number of records to retrieve. By default, the list operation return the first 10 records.
offset float
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.
guid This property is required. String
The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
collectionId String
Filters the response based on the specified collection_id.
environmentId String
Filters the response based on the specified environment_id.
id String
limit Number
The number of records to retrieve. By default, the list operation return the first 10 records.
offset Number
The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value.

getAppConfigSnapshots Result

The following output properties are available:

GitConfigs List<GetAppConfigSnapshotsGitConfig>
Array of git_configs.
Guid string
Id string
TotalCount double
(Integer) Total number of records
CollectionId string
(String) Collection id.
EnvironmentId string
(String) Environment Id.
Limit double
(Integer) Number of records returned.
Offset double
(Integer) Skipped number of records.
GitConfigs []GetAppConfigSnapshotsGitConfig
Array of git_configs.
Guid string
Id string
TotalCount float64
(Integer) Total number of records
CollectionId string
(String) Collection id.
EnvironmentId string
(String) Environment Id.
Limit float64
(Integer) Number of records returned.
Offset float64
(Integer) Skipped number of records.
gitConfigs List<GetAppConfigSnapshotsGitConfig>
Array of git_configs.
guid String
id String
totalCount Double
(Integer) Total number of records
collectionId String
(String) Collection id.
environmentId String
(String) Environment Id.
limit Double
(Integer) Number of records returned.
offset Double
(Integer) Skipped number of records.
gitConfigs GetAppConfigSnapshotsGitConfig[]
Array of git_configs.
guid string
id string
totalCount number
(Integer) Total number of records
collectionId string
(String) Collection id.
environmentId string
(String) Environment Id.
limit number
(Integer) Number of records returned.
offset number
(Integer) Skipped number of records.
git_configs Sequence[GetAppConfigSnapshotsGitConfig]
Array of git_configs.
guid str
id str
total_count float
(Integer) Total number of records
collection_id str
(String) Collection id.
environment_id str
(String) Environment Id.
limit float
(Integer) Number of records returned.
offset float
(Integer) Skipped number of records.
gitConfigs List<Property Map>
Array of git_configs.
guid String
id String
totalCount Number
(Integer) Total number of records
collectionId String
(String) Collection id.
environmentId String
(String) Environment Id.
limit Number
(Integer) Number of records returned.
offset Number
(Integer) Skipped number of records.

Supporting Types

GetAppConfigSnapshotsGitConfig

Collections This property is required. List<GetAppConfigSnapshotsGitConfigCollection>
(Object) Collection object will be returned containing attributes collection_id, collection_name.
CreatedTime This property is required. string
(Timestamp) Creation time of the git config.
Environments This property is required. List<GetAppConfigSnapshotsGitConfigEnvironment>
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
GitBranch This property is required. string
(String) Branch name to which you need to write or update the configuration.
GitConfigId This property is required. string
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
GitConfigName This property is required. string
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
GitFilePath This property is required. string
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
GitUrl This property is required. string
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
Href This property is required. string
(String) Git config URL.
LastSyncTime This property is required. string
(Timestamp) Latest time when the snapshot was synced to git.
UpdatedTime This property is required. string
(Timestamp) Last modified time of the git config data.
Collections This property is required. []GetAppConfigSnapshotsGitConfigCollection
(Object) Collection object will be returned containing attributes collection_id, collection_name.
CreatedTime This property is required. string
(Timestamp) Creation time of the git config.
Environments This property is required. []GetAppConfigSnapshotsGitConfigEnvironment
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
GitBranch This property is required. string
(String) Branch name to which you need to write or update the configuration.
GitConfigId This property is required. string
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
GitConfigName This property is required. string
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
GitFilePath This property is required. string
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
GitUrl This property is required. string
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
Href This property is required. string
(String) Git config URL.
LastSyncTime This property is required. string
(Timestamp) Latest time when the snapshot was synced to git.
UpdatedTime This property is required. string
(Timestamp) Last modified time of the git config data.
collections This property is required. List<GetAppConfigSnapshotsGitConfigCollection>
(Object) Collection object will be returned containing attributes collection_id, collection_name.
createdTime This property is required. String
(Timestamp) Creation time of the git config.
environments This property is required. List<GetAppConfigSnapshotsGitConfigEnvironment>
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
gitBranch This property is required. String
(String) Branch name to which you need to write or update the configuration.
gitConfigId This property is required. String
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
gitConfigName This property is required. String
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
gitFilePath This property is required. String
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
gitUrl This property is required. String
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
href This property is required. String
(String) Git config URL.
lastSyncTime This property is required. String
(Timestamp) Latest time when the snapshot was synced to git.
updatedTime This property is required. String
(Timestamp) Last modified time of the git config data.
collections This property is required. GetAppConfigSnapshotsGitConfigCollection[]
(Object) Collection object will be returned containing attributes collection_id, collection_name.
createdTime This property is required. string
(Timestamp) Creation time of the git config.
environments This property is required. GetAppConfigSnapshotsGitConfigEnvironment[]
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
gitBranch This property is required. string
(String) Branch name to which you need to write or update the configuration.
gitConfigId This property is required. string
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
gitConfigName This property is required. string
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
gitFilePath This property is required. string
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
gitUrl This property is required. string
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
href This property is required. string
(String) Git config URL.
lastSyncTime This property is required. string
(Timestamp) Latest time when the snapshot was synced to git.
updatedTime This property is required. string
(Timestamp) Last modified time of the git config data.
collections This property is required. Sequence[GetAppConfigSnapshotsGitConfigCollection]
(Object) Collection object will be returned containing attributes collection_id, collection_name.
created_time This property is required. str
(Timestamp) Creation time of the git config.
environments This property is required. Sequence[GetAppConfigSnapshotsGitConfigEnvironment]
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
git_branch This property is required. str
(String) Branch name to which you need to write or update the configuration.
git_config_id This property is required. str
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
git_config_name This property is required. str
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
git_file_path This property is required. str
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
git_url This property is required. str
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
href This property is required. str
(String) Git config URL.
last_sync_time This property is required. str
(Timestamp) Latest time when the snapshot was synced to git.
updated_time This property is required. str
(Timestamp) Last modified time of the git config data.
collections This property is required. List<Property Map>
(Object) Collection object will be returned containing attributes collection_id, collection_name.
createdTime This property is required. String
(Timestamp) Creation time of the git config.
environments This property is required. List<Property Map>
(Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
gitBranch This property is required. String
(String) Branch name to which you need to write or update the configuration.
gitConfigId This property is required. String
(String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
gitConfigName This property is required. String
(String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
gitFilePath This property is required. String
(String) Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension.
gitUrl This property is required. String
(String) Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account.
href This property is required. String
(String) Git config URL.
lastSyncTime This property is required. String
(Timestamp) Latest time when the snapshot was synced to git.
updatedTime This property is required. String
(Timestamp) Last modified time of the git config data.

GetAppConfigSnapshotsGitConfigCollection

CollectionId This property is required. string
Filters the response based on the specified collection_id.
CollectionName This property is required. string
CollectionId This property is required. string
Filters the response based on the specified collection_id.
CollectionName This property is required. string
collectionId This property is required. String
Filters the response based on the specified collection_id.
collectionName This property is required. String
collectionId This property is required. string
Filters the response based on the specified collection_id.
collectionName This property is required. string
collection_id This property is required. str
Filters the response based on the specified collection_id.
collection_name This property is required. str
collectionId This property is required. String
Filters the response based on the specified collection_id.
collectionName This property is required. String

GetAppConfigSnapshotsGitConfigEnvironment

ColorCode This property is required. string
(String) Color code to distinguish the environment.
EnvironmentId This property is required. string
Filters the response based on the specified environment_id.
EnvironmentName This property is required. string
(String) Environment name.
ColorCode This property is required. string
(String) Color code to distinguish the environment.
EnvironmentId This property is required. string
Filters the response based on the specified environment_id.
EnvironmentName This property is required. string
(String) Environment name.
colorCode This property is required. String
(String) Color code to distinguish the environment.
environmentId This property is required. String
Filters the response based on the specified environment_id.
environmentName This property is required. String
(String) Environment name.
colorCode This property is required. string
(String) Color code to distinguish the environment.
environmentId This property is required. string
Filters the response based on the specified environment_id.
environmentName This property is required. string
(String) Environment name.
color_code This property is required. str
(String) Color code to distinguish the environment.
environment_id This property is required. str
Filters the response based on the specified environment_id.
environment_name This property is required. str
(String) Environment name.
colorCode This property is required. String
(String) Color code to distinguish the environment.
environmentId This property is required. String
Filters the response based on the specified environment_id.
environmentName This property is required. String
(String) Environment name.

Package Details

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