rancher2.getCatalog

Explore with Pulumi AI

Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi

Example Usage

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

const library = rancher2.getCatalog({
    name: "catalog",
});

import pulumi
import pulumi_rancher2 as rancher2

library = rancher2.get_catalog(name="catalog")

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.LookupCatalog(ctx, &rancher2.LookupCatalogArgs{
			Name: "catalog",
		}, 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 library = Rancher2.GetCatalog.Invoke(new()
    {
        Name = "catalog",
    });

});

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.GetCatalogArgs;
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 library = Rancher2Functions.getCatalog(GetCatalogArgs.builder()
            .name("catalog")
            .build());

    }
}

variables:
  library:
    fn::invoke:
      Function: rancher2:getCatalog
      Arguments:
        name: catalog

Using getCatalog

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 getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
function getCatalogOutput(args: GetCatalogOutputArgs, opts?: InvokeOptions): Output<GetCatalogResult>

def get_catalog(name: Optional[str] = None,
                scope: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCatalogResult
def get_catalog_output(name: Optional[pulumi.Input[str]] = None,
                scope: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCatalogResult]

func LookupCatalog(ctx *Context, args *LookupCatalogArgs, opts ...InvokeOption) (*LookupCatalogResult, error)
func LookupCatalogOutput(ctx *Context, args *LookupCatalogOutputArgs, opts ...InvokeOption) LookupCatalogResultOutput

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

public static class GetCatalog 
{
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogResult> Invoke(GetCatalogInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getCatalog:getCatalog
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The catalog name.
Scope string: The scope of the catalog. cluster, global, and project are supported. Default global (string)

Name string: The catalog name.
Scope string: The scope of the catalog. cluster, global, and project are supported. Default global (string)

name String: The catalog name.
scope String: The scope of the catalog. cluster, global, and project are supported. Default global (string)

name string: The catalog name.
scope string: The scope of the catalog. cluster, global, and project are supported. Default global (string)

name str: The catalog name.
scope str: The scope of the catalog. cluster, global, and project are supported. Default global (string)

name String: The catalog name.
scope String: The scope of the catalog. cluster, global, and project are supported. Default global (string)

getCatalog Result

The following output properties are available:

Annotations Dictionary<string, object>: (Computed) Annotations for the catalog (map)
Branch string: (Computed) The branch of the catalog repo to use (string)
ClusterId string: (Computed) The cluster id of the catalog (string)
Description string: (Computed) A catalog description (string)
Id string: The provider-assigned unique ID for this managed resource.
Kind string: (Computed) The kind of the catalog. Just helm by the moment (string)
Labels Dictionary<string, object>: (Computed) Labels for the catalog (map)
Name string
Password string: (Computed/Sensitive) The password to access the catalog if needed (string)
ProjectId string: (Computed) The project id of the catalog (string)
Url string: (Computed) The url of the catalog repo (string)
Username string: (Computed/Sensitive) The username to access the catalog if needed (string)
Version string: (Computed) Helm version for the catalog (string)
Scope string

Annotations map[string]interface{}: (Computed) Annotations for the catalog (map)
Branch string: (Computed) The branch of the catalog repo to use (string)
ClusterId string: (Computed) The cluster id of the catalog (string)
Description string: (Computed) A catalog description (string)
Id string: The provider-assigned unique ID for this managed resource.
Kind string: (Computed) The kind of the catalog. Just helm by the moment (string)
Labels map[string]interface{}: (Computed) Labels for the catalog (map)
Name string
Password string: (Computed/Sensitive) The password to access the catalog if needed (string)
ProjectId string: (Computed) The project id of the catalog (string)
Url string: (Computed) The url of the catalog repo (string)
Username string: (Computed/Sensitive) The username to access the catalog if needed (string)
Version string: (Computed) Helm version for the catalog (string)
Scope string

annotations Map<String,Object>: (Computed) Annotations for the catalog (map)
branch String: (Computed) The branch of the catalog repo to use (string)
clusterId String: (Computed) The cluster id of the catalog (string)
description String: (Computed) A catalog description (string)
id String: The provider-assigned unique ID for this managed resource.
kind String: (Computed) The kind of the catalog. Just helm by the moment (string)
labels Map<String,Object>: (Computed) Labels for the catalog (map)
name String
password String: (Computed/Sensitive) The password to access the catalog if needed (string)
projectId String: (Computed) The project id of the catalog (string)
url String: (Computed) The url of the catalog repo (string)
username String: (Computed/Sensitive) The username to access the catalog if needed (string)
version String: (Computed) Helm version for the catalog (string)
scope String

annotations {[key: string]: any}: (Computed) Annotations for the catalog (map)
branch string: (Computed) The branch of the catalog repo to use (string)
clusterId string: (Computed) The cluster id of the catalog (string)
description string: (Computed) A catalog description (string)
id string: The provider-assigned unique ID for this managed resource.
kind string: (Computed) The kind of the catalog. Just helm by the moment (string)
labels {[key: string]: any}: (Computed) Labels for the catalog (map)
name string
password string: (Computed/Sensitive) The password to access the catalog if needed (string)
projectId string: (Computed) The project id of the catalog (string)
url string: (Computed) The url of the catalog repo (string)
username string: (Computed/Sensitive) The username to access the catalog if needed (string)
version string: (Computed) Helm version for the catalog (string)
scope string

annotations Mapping[str, Any]: (Computed) Annotations for the catalog (map)
branch str: (Computed) The branch of the catalog repo to use (string)
cluster_id str: (Computed) The cluster id of the catalog (string)
description str: (Computed) A catalog description (string)
id str: The provider-assigned unique ID for this managed resource.
kind str: (Computed) The kind of the catalog. Just helm by the moment (string)
labels Mapping[str, Any]: (Computed) Labels for the catalog (map)
name str
password str: (Computed/Sensitive) The password to access the catalog if needed (string)
project_id str: (Computed) The project id of the catalog (string)
url str: (Computed) The url of the catalog repo (string)
username str: (Computed/Sensitive) The username to access the catalog if needed (string)
version str: (Computed) Helm version for the catalog (string)
scope str

annotations Map<Any>: (Computed) Annotations for the catalog (map)
branch String: (Computed) The branch of the catalog repo to use (string)
clusterId String: (Computed) The cluster id of the catalog (string)
description String: (Computed) A catalog description (string)
id String: The provider-assigned unique ID for this managed resource.
kind String: (Computed) The kind of the catalog. Just helm by the moment (string)
labels Map<Any>: (Computed) Labels for the catalog (map)
name String
password String: (Computed/Sensitive) The password to access the catalog if needed (string)
projectId String: (Computed) The project id of the catalog (string)
url String: (Computed) The url of the catalog repo (string)
username String: (Computed/Sensitive) The username to access the catalog if needed (string)
version String: (Computed) Helm version for the catalog (string)
scope String

Package Details

Repository: Rancher2 pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.

Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi

pulumi/pulumi-rancher2

rancher2.getCatalog

On this page

On this page

Example Usage

Using getCatalog

getCatalog Result

Package Details

On this page

On this page