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

ibm.getAppConfigSnapshot

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 snapshot. 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

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const appConfigSnapshotRead = ibm.getAppConfigSnapshot({
        gitConfigId: "git_config_id",
        guid: "guid",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    app_config_snapshot_read = ibm.get_app_config_snapshot(git_config_id="git_config_id",
        guid="guid")
    
    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.LookupAppConfigSnapshot(ctx, &ibm.LookupAppConfigSnapshotArgs{
    			GitConfigId: "git_config_id",
    			Guid:        "guid",
    		}, 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 appConfigSnapshotRead = Ibm.GetAppConfigSnapshot.Invoke(new()
        {
            GitConfigId = "git_config_id",
            Guid = "guid",
        });
    
    });
    
    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.GetAppConfigSnapshotArgs;
    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 appConfigSnapshotRead = IbmFunctions.getAppConfigSnapshot(GetAppConfigSnapshotArgs.builder()
                .gitConfigId("git_config_id")
                .guid("guid")
                .build());
    
        }
    }
    
    variables:
      appConfigSnapshotRead:
        fn::invoke:
          function: ibm:getAppConfigSnapshot
          arguments:
            gitConfigId: git_config_id
            guid: guid
    

    Using getAppConfigSnapshot

    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 getAppConfigSnapshot(args: GetAppConfigSnapshotArgs, opts?: InvokeOptions): Promise<GetAppConfigSnapshotResult>
    function getAppConfigSnapshotOutput(args: GetAppConfigSnapshotOutputArgs, opts?: InvokeOptions): Output<GetAppConfigSnapshotResult>
    def get_app_config_snapshot(git_config_id: Optional[str] = None,
                                guid: Optional[str] = None,
                                id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAppConfigSnapshotResult
    def get_app_config_snapshot_output(git_config_id: Optional[pulumi.Input[str]] = None,
                                guid: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAppConfigSnapshotResult]
    func LookupAppConfigSnapshot(ctx *Context, args *LookupAppConfigSnapshotArgs, opts ...InvokeOption) (*LookupAppConfigSnapshotResult, error)
    func LookupAppConfigSnapshotOutput(ctx *Context, args *LookupAppConfigSnapshotOutputArgs, opts ...InvokeOption) LookupAppConfigSnapshotResultOutput

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

    public static class GetAppConfigSnapshot 
    {
        public static Task<GetAppConfigSnapshotResult> InvokeAsync(GetAppConfigSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetAppConfigSnapshotResult> Invoke(GetAppConfigSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppConfigSnapshotResult> getAppConfigSnapshot(GetAppConfigSnapshotArgs args, InvokeOptions options)
    public static Output<GetAppConfigSnapshotResult> getAppConfigSnapshot(GetAppConfigSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getAppConfigSnapshot:getAppConfigSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GitConfigId string
    The Git Config Id.
    Guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    Id string
    GitConfigId string
    The Git Config Id.
    Guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    Id string
    gitConfigId String
    The Git Config Id.
    guid String
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    id String
    gitConfigId string
    The Git Config Id.
    guid string
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    id string
    git_config_id str
    The Git Config Id.
    guid str
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    id str
    gitConfigId String
    The Git Config Id.
    guid String
    The GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.
    id String

    getAppConfigSnapshot Result

    The following output properties are available:

    Collections List<GetAppConfigSnapshotCollection>
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    CreatedTime string
    (Timestamp) Creation time of the git config.
    Environments List<GetAppConfigSnapshotEnvironment>
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    GitBranch string
    (String) Branch name to which you need to write or update the configuration.
    GitConfigId string
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    GitConfigName string
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    GitFilePath 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 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.
    Guid string
    Href string
    (String) Git config URL.
    Id string
    LastSyncTime string
    (Timestamp) Latest time when the snapshot was synced to git.
    UpdatedTime string
    (Timestamp) Last modified time of the git config data.
    Collections []GetAppConfigSnapshotCollection
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    CreatedTime string
    (Timestamp) Creation time of the git config.
    Environments []GetAppConfigSnapshotEnvironment
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    GitBranch string
    (String) Branch name to which you need to write or update the configuration.
    GitConfigId string
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    GitConfigName string
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    GitFilePath 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 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.
    Guid string
    Href string
    (String) Git config URL.
    Id string
    LastSyncTime string
    (Timestamp) Latest time when the snapshot was synced to git.
    UpdatedTime string
    (Timestamp) Last modified time of the git config data.
    collections List<GetAppConfigSnapshotCollection>
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    createdTime String
    (Timestamp) Creation time of the git config.
    environments List<GetAppConfigSnapshotEnvironment>
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    gitBranch String
    (String) Branch name to which you need to write or update the configuration.
    gitConfigId String
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    gitConfigName String
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    gitFilePath 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 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.
    guid String
    href String
    (String) Git config URL.
    id String
    lastSyncTime String
    (Timestamp) Latest time when the snapshot was synced to git.
    updatedTime String
    (Timestamp) Last modified time of the git config data.
    collections GetAppConfigSnapshotCollection[]
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    createdTime string
    (Timestamp) Creation time of the git config.
    environments GetAppConfigSnapshotEnvironment[]
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    gitBranch string
    (String) Branch name to which you need to write or update the configuration.
    gitConfigId string
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    gitConfigName string
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    gitFilePath 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 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.
    guid string
    href string
    (String) Git config URL.
    id string
    lastSyncTime string
    (Timestamp) Latest time when the snapshot was synced to git.
    updatedTime string
    (Timestamp) Last modified time of the git config data.
    collections Sequence[GetAppConfigSnapshotCollection]
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    created_time str
    (Timestamp) Creation time of the git config.
    environments Sequence[GetAppConfigSnapshotEnvironment]
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    git_branch str
    (String) Branch name to which you need to write or update the configuration.
    git_config_id str
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    git_config_name str
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    git_file_path 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 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.
    guid str
    href str
    (String) Git config URL.
    id str
    last_sync_time str
    (Timestamp) Latest time when the snapshot was synced to git.
    updated_time str
    (Timestamp) Last modified time of the git config data.
    collections List<Property Map>
    (Object) Collection object will be returned containing attributes collection_id, collection_name.
    createdTime String
    (Timestamp) Creation time of the git config.
    environments List<Property Map>
    (Object) Environment object will be returned containing attributes environment_id, environment_name, color_code.
    gitBranch String
    (String) Branch name to which you need to write or update the configuration.
    gitConfigId String
    (String) Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only
    gitConfigName String
    (String) Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.
    gitFilePath 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 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.
    guid String
    href String
    (String) Git config URL.
    id String
    lastSyncTime String
    (Timestamp) Latest time when the snapshot was synced to git.
    updatedTime String
    (Timestamp) Last modified time of the git config data.

    Supporting Types

    GetAppConfigSnapshotCollection

    CollectionId string
    (String) Collection id.
    CollectionName string
    CollectionId string
    (String) Collection id.
    CollectionName string
    collectionId String
    (String) Collection id.
    collectionName String
    collectionId string
    (String) Collection id.
    collectionName string
    collection_id str
    (String) Collection id.
    collection_name str
    collectionId String
    (String) Collection id.
    collectionName String

    GetAppConfigSnapshotEnvironment

    ColorCode string
    EnvironmentId string
    (String) Environment Id.
    EnvironmentName string
    (String) Environment name.
    ColorCode string
    EnvironmentId string
    (String) Environment Id.
    EnvironmentName string
    (String) Environment name.
    colorCode String
    environmentId String
    (String) Environment Id.
    environmentName String
    (String) Environment name.
    colorCode string
    environmentId string
    (String) Environment Id.
    environmentName string
    (String) Environment name.
    color_code str
    environment_id str
    (String) Environment Id.
    environment_name str
    (String) Environment name.
    colorCode String
    environmentId String
    (String) Environment Id.
    environmentName 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.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud