Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. getCertificate
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.getCertificate

Explore with Pulumi AI

Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2

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

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

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

# Retrieve a rancher2 Project Certificate
foo = rancher2.get_certificate(name="<name>",
    project_id="<project_id>")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Retrieve a rancher2 Project Certificate
		_, err := rancher2.LookupCertificate(ctx, &rancher2.LookupCertificateArgs{
			Name:      "<name>",
			ProjectId: "<project_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Retrieve a rancher2 Project Certificate
    var foo = Rancher2.GetCertificate.Invoke(new()
    {
        Name = "<name>",
        ProjectId = "<project_id>",
    });

});
Copy
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.GetCertificateArgs;
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) {
        // Retrieve a rancher2 Project Certificate
        final var foo = Rancher2Functions.getCertificate(GetCertificateArgs.builder()
            .name("<name>")
            .projectId("<project_id>")
            .build());

    }
}
Copy
variables:
  # Retrieve a rancher2 Project Certificate
  foo:
    fn::invoke:
      function: rancher2:getCertificate
      arguments:
        name: <name>
        projectId: <project_id>
Copy
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

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

# Retrieve a rancher2 Namespaced Certificate
foo = rancher2.get_certificate(name="<name>",
    project_id="<project_id>",
    namespace_id="<namespace_id>")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Retrieve a rancher2 Namespaced Certificate
		_, err := rancher2.LookupCertificate(ctx, &rancher2.LookupCertificateArgs{
			Name:        "<name>",
			ProjectId:   "<project_id>",
			NamespaceId: pulumi.StringRef("<namespace_id>"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Retrieve a rancher2 Namespaced Certificate
    var foo = Rancher2.GetCertificate.Invoke(new()
    {
        Name = "<name>",
        ProjectId = "<project_id>",
        NamespaceId = "<namespace_id>",
    });

});
Copy
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.GetCertificateArgs;
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) {
        // Retrieve a rancher2 Namespaced Certificate
        final var foo = Rancher2Functions.getCertificate(GetCertificateArgs.builder()
            .name("<name>")
            .projectId("<project_id>")
            .namespaceId("<namespace_id>")
            .build());

    }
}
Copy
variables:
  # Retrieve a rancher2 Namespaced Certificate
  foo:
    fn::invoke:
      function: rancher2:getCertificate
      arguments:
        name: <name>
        projectId: <project_id>
        namespaceId: <namespace_id>
Copy

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>
Copy
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]
Copy
func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: rancher2:index/getCertificate:getCertificate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the certificate (string)
ProjectId This property is required. string
The project id where to assign the certificate (string)
NamespaceId string
The namespace id where to assign the namespaced certificate (string)
Name This property is required. string
The name of the certificate (string)
ProjectId This property is required. string
The project id where to assign the certificate (string)
NamespaceId string
The namespace id where to assign the namespaced certificate (string)
name This property is required. String
The name of the certificate (string)
projectId This property is required. String
The project id where to assign the certificate (string)
namespaceId String
The namespace id where to assign the namespaced certificate (string)
name This property is required. string
The name of the certificate (string)
projectId This property is required. string
The project id where to assign the certificate (string)
namespaceId string
The namespace id where to assign the namespaced certificate (string)
name This property is required. str
The name of the certificate (string)
project_id This property is required. str
The project id where to assign the certificate (string)
namespace_id str
The namespace id where to assign the namespaced certificate (string)
name This property is required. String
The name of the certificate (string)
projectId This property is required. 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, string>
(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, string>
(Computed) Labels for certificate object (map)
Name string
ProjectId string
NamespaceId string
Annotations map[string]string
(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]string
(Computed) Labels for certificate object (map)
Name string
ProjectId string
NamespaceId string
annotations Map<String,String>
(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,String>
(Computed) Labels for certificate object (map)
name String
projectId String
namespaceId String
annotations {[key: string]: string}
(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]: string}
(Computed) Labels for certificate object (map)
name string
projectId string
namespaceId string
annotations Mapping[str, str]
(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, str]
(Computed) Labels for certificate object (map)
name str
project_id str
namespace_id str
annotations Map<String>
(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>
(Computed) Labels for certificate object (map)
name String
projectId String
namespaceId 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 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2