1. Packages
  2. Rancher2
  3. API Docs
  4. getApp
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi

rancher2.getApp

Explore with Pulumi AI

rancher2 logo
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi

    Use this data source to retrieve information about a Rancher v2 app.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const rancher2 = rancher2.getApp({
        name: "foo",
        projectId: "<project_id>",
        targetNamespace: "<namespace_name>",
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    rancher2 = rancher2.get_app(name="foo",
        project_id="<project_id>",
        target_namespace="<namespace_name>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v6/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rancher2.LookupApp(ctx, &rancher2.LookupAppArgs{
    			Name:            "foo",
    			ProjectId:       "<project_id>",
    			TargetNamespace: pulumi.StringRef("<namespace_name>"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        var rancher2 = Rancher2.GetApp.Invoke(new()
        {
            Name = "foo",
            ProjectId = "<project_id>",
            TargetNamespace = "<namespace_name>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.Rancher2Functions;
    import com.pulumi.rancher2.inputs.GetAppArgs;
    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 rancher2 = Rancher2Functions.getApp(GetAppArgs.builder()
                .name("foo")
                .projectId("<project_id>")
                .targetNamespace("<namespace_name>")
                .build());
    
        }
    }
    
    variables:
      rancher2:
        fn::invoke:
          Function: rancher2:getApp
          Arguments:
            name: foo
            projectId: <project_id>
            targetNamespace: <namespace_name>
    

    Using getApp

    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 getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
    function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>
    def get_app(annotations: Optional[Mapping[str, Any]] = None,
                name: Optional[str] = None,
                project_id: Optional[str] = None,
                target_namespace: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAppResult
    def get_app_output(annotations: Optional[pulumi.Input[Mapping[str, Any]]] = None,
                name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                target_namespace: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]
    func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
    func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput

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

    public static class GetApp 
    {
        public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
        public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: rancher2:index/getApp:getApp
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The app name (string)
    ProjectId string
    The id of the project where the app is deployed (string)
    Annotations Dictionary<string, object>
    (Computed) Annotations for the catalog (map)
    TargetNamespace string
    The namespace name where the app is deployed (string)
    Name string
    The app name (string)
    ProjectId string
    The id of the project where the app is deployed (string)
    Annotations map[string]interface{}
    (Computed) Annotations for the catalog (map)
    TargetNamespace string
    The namespace name where the app is deployed (string)
    name String
    The app name (string)
    projectId String
    The id of the project where the app is deployed (string)
    annotations Map<String,Object>
    (Computed) Annotations for the catalog (map)
    targetNamespace String
    The namespace name where the app is deployed (string)
    name string
    The app name (string)
    projectId string
    The id of the project where the app is deployed (string)
    annotations {[key: string]: any}
    (Computed) Annotations for the catalog (map)
    targetNamespace string
    The namespace name where the app is deployed (string)
    name str
    The app name (string)
    project_id str
    The id of the project where the app is deployed (string)
    annotations Mapping[str, Any]
    (Computed) Annotations for the catalog (map)
    target_namespace str
    The namespace name where the app is deployed (string)
    name String
    The app name (string)
    projectId String
    The id of the project where the app is deployed (string)
    annotations Map<Any>
    (Computed) Annotations for the catalog (map)
    targetNamespace String
    The namespace name where the app is deployed (string)

    getApp Result

    The following output properties are available:

    Annotations Dictionary<string, object>
    (Computed) Annotations for the catalog (map)
    Answers Dictionary<string, object>
    (Computed) Answers for the app (map)
    CatalogName string
    (Computed) Catalog name of the app (string)
    Description string
    (Computed) Description for the app (string)
    ExternalId string
    (Computed) The URL of the helm catalog app (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, object>
    (Computed) Labels for the catalog (map)
    Name string
    ProjectId string
    RevisionId string
    (Computed) Current revision id for the app (string)
    TargetNamespace string
    TemplateName string
    (Computed) Template name of the app (string)
    TemplateVersion string
    (Computed) Template version of the app (string)
    ValuesYaml string
    (Computed) values.yaml base64 encoded file content for the app (string)
    Annotations map[string]interface{}
    (Computed) Annotations for the catalog (map)
    Answers map[string]interface{}
    (Computed) Answers for the app (map)
    CatalogName string
    (Computed) Catalog name of the app (string)
    Description string
    (Computed) Description for the app (string)
    ExternalId string
    (Computed) The URL of the helm catalog app (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]interface{}
    (Computed) Labels for the catalog (map)
    Name string
    ProjectId string
    RevisionId string
    (Computed) Current revision id for the app (string)
    TargetNamespace string
    TemplateName string
    (Computed) Template name of the app (string)
    TemplateVersion string
    (Computed) Template version of the app (string)
    ValuesYaml string
    (Computed) values.yaml base64 encoded file content for the app (string)
    annotations Map<String,Object>
    (Computed) Annotations for the catalog (map)
    answers Map<String,Object>
    (Computed) Answers for the app (map)
    catalogName String
    (Computed) Catalog name of the app (string)
    description String
    (Computed) Description for the app (string)
    externalId String
    (Computed) The URL of the helm catalog app (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,Object>
    (Computed) Labels for the catalog (map)
    name String
    projectId String
    revisionId String
    (Computed) Current revision id for the app (string)
    targetNamespace String
    templateName String
    (Computed) Template name of the app (string)
    templateVersion String
    (Computed) Template version of the app (string)
    valuesYaml String
    (Computed) values.yaml base64 encoded file content for the app (string)
    annotations {[key: string]: any}
    (Computed) Annotations for the catalog (map)
    answers {[key: string]: any}
    (Computed) Answers for the app (map)
    catalogName string
    (Computed) Catalog name of the app (string)
    description string
    (Computed) Description for the app (string)
    externalId string
    (Computed) The URL of the helm catalog app (string)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: any}
    (Computed) Labels for the catalog (map)
    name string
    projectId string
    revisionId string
    (Computed) Current revision id for the app (string)
    targetNamespace string
    templateName string
    (Computed) Template name of the app (string)
    templateVersion string
    (Computed) Template version of the app (string)
    valuesYaml string
    (Computed) values.yaml base64 encoded file content for the app (string)
    annotations Mapping[str, Any]
    (Computed) Annotations for the catalog (map)
    answers Mapping[str, Any]
    (Computed) Answers for the app (map)
    catalog_name str
    (Computed) Catalog name of the app (string)
    description str
    (Computed) Description for the app (string)
    external_id str
    (Computed) The URL of the helm catalog app (string)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, Any]
    (Computed) Labels for the catalog (map)
    name str
    project_id str
    revision_id str
    (Computed) Current revision id for the app (string)
    target_namespace str
    template_name str
    (Computed) Template name of the app (string)
    template_version str
    (Computed) Template version of the app (string)
    values_yaml str
    (Computed) values.yaml base64 encoded file content for the app (string)
    annotations Map<Any>
    (Computed) Annotations for the catalog (map)
    answers Map<Any>
    (Computed) Answers for the app (map)
    catalogName String
    (Computed) Catalog name of the app (string)
    description String
    (Computed) Description for the app (string)
    externalId String
    (Computed) The URL of the helm catalog app (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<Any>
    (Computed) Labels for the catalog (map)
    name String
    projectId String
    revisionId String
    (Computed) Current revision id for the app (string)
    targetNamespace String
    templateName String
    (Computed) Template name of the app (string)
    templateVersion String
    (Computed) Template version of the app (string)
    valuesYaml String
    (Computed) values.yaml base64 encoded file content for the app (string)

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi