Rancher2

v3.8.0 published on Tuesday, May 31, 2022 by Pulumi

getCertificate

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

Depending of the availability, there are 2 types of Rancher v2 certificates:

Project certificate: Available to all namespaces in the project_id
Namespaced certificate: Available to just namespace_id in the project_id

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Rancher2.GetCertificate.InvokeAsync(new Rancher2.GetCertificateArgs
        {
            Name = "<name>",
            ProjectId = "<project_id>",
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupCertificate(ctx, &GetCertificateArgs{
			Name:      "<name>",
			ProjectId: "<project_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_certificate(name="<name>",
    project_id="<project_id>")

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

// Retrieve a rancher2 Project Certificate
const foo = pulumi.output(rancher2.getCertificate({
    name: "<name>",
    projectId: "<project_id>",
}));

Coming soon!

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Rancher2.GetCertificate.InvokeAsync(new Rancher2.GetCertificateArgs
        {
            Name = "<name>",
            NamespaceId = "<namespace_id>",
            ProjectId = "<project_id>",
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupCertificate(ctx, &GetCertificateArgs{
			Name:        "<name>",
			NamespaceId: pulumi.StringRef("<namespace_id>"),
			ProjectId:   "<project_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_certificate(name="<name>",
    namespace_id="<namespace_id>",
    project_id="<project_id>")

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

// Retrieve a rancher2 Namespaced Certificate
const foo = pulumi.output(rancher2.getCertificate({
    name: "<name>",
    namespaceId: "<namespace_id>",
    projectId: "<project_id>",
}));

Coming soon!

Using getCertificate

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 getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOptions): Output<GetCertificateResult>

def get_certificate(name: Optional[str] = None,
                    namespace_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCertificateResult
def get_certificate_output(name: Optional[pulumi.Input[str]] = None,
                    namespace_id: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCertificateResult]

func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput

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

public static class GetCertificate 
{
    public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
    public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Name string: The name of the certificate (string)
ProjectId string: The project id where to assign the certificate (string)
NamespaceId string: The namespace id where to assign the namespaced certificate (string)

Name string: The name of the certificate (string)
ProjectId string: The project id where to assign the certificate (string)
NamespaceId string: The namespace id where to assign the namespaced certificate (string)

name String: The name of the certificate (string)
projectId String: The project id where to assign the certificate (string)
namespaceId String: The namespace id where to assign the namespaced certificate (string)

name string: The name of the certificate (string)
projectId string: The project id where to assign the certificate (string)
namespaceId string: The namespace id where to assign the namespaced certificate (string)

name str: The name of the certificate (string)
project_id str: The project id where to assign the certificate (string)
namespace_id str: The namespace id where to assign the namespaced certificate (string)

name String: The name of the certificate (string)
projectId String: The project id where to assign the certificate (string)
namespaceId String: The namespace id where to assign the namespaced certificate (string)

getCertificate Result

The following output properties are available:

Annotations Dictionary<string, object>: (Computed) Annotations for certificate object (map)
Certs string: (Computed) Base64 encoded certs (string)
Description string: (Computed) A certificate description (string)
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, object>: (Computed) Labels for certificate object (map)
Name string
ProjectId string
NamespaceId string

Annotations map[string]interface{}: (Computed) Annotations for certificate object (map)
Certs string: (Computed) Base64 encoded certs (string)
Description string: (Computed) A certificate description (string)
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]interface{}: (Computed) Labels for certificate object (map)
Name string
ProjectId string
NamespaceId string

annotations Map<String,Object>: (Computed) Annotations for certificate object (map)
certs String: (Computed) Base64 encoded certs (string)
description String: (Computed) A certificate description (string)
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,Object>: (Computed) Labels for certificate object (map)
name String
projectId String
namespaceId String

annotations {[key: string]: any}: (Computed) Annotations for certificate object (map)
certs string: (Computed) Base64 encoded certs (string)
description string: (Computed) A certificate description (string)
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: any}: (Computed) Labels for certificate object (map)
name string
projectId string
namespaceId string

annotations Mapping[str, Any]: (Computed) Annotations for certificate object (map)
certs str: (Computed) Base64 encoded certs (string)
description str: (Computed) A certificate description (string)
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, Any]: (Computed) Labels for certificate object (map)
name str
project_id str
namespace_id str

annotations Map<Any>: (Computed) Annotations for certificate object (map)
certs String: (Computed) Base64 encoded certs (string)
description String: (Computed) A certificate description (string)
id String: The provider-assigned unique ID for this managed resource.
labels Map<Any>: (Computed) Labels for certificate object (map)
name String
projectId String
namespaceId String

Package Details

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

Rancher2

getCertificate

Example Usage

Using getCertificate

getCertificate Result

Package Details

Contents