Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. getSecret

getSecret

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

Depending of the availability, there are 2 types of Rancher v2 secrets: - Project secret: Available to all namespaces in the project_id - Namespaced secret: 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.GetSecret.InvokeAsync(new Rancher2.GetSecretArgs
        {
            Name = "<name>",
            ProjectId = "<project_id>",
        }));
    }

}

package main

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

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

foo = rancher2.get_secret(name="<name>",
    project_id="<project_id>")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

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

Using getSecret

function getSecret(args: GetSecretArgs, opts?: InvokeOptions): Promise<GetSecretResult>
def get_secret(name: Optional[str] = None, namespace_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetSecretResult
func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)

Note: This function is named LookupSecret in the Go SDK.

public static class GetSecret {
    public static Task<GetSecretResult> InvokeAsync(GetSecretArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the secret (string)

ProjectId string

The project id where to assign the secret (string)

NamespaceId string

The namespace id where to assign the namespaced secret (string)

Name string

The name of the secret (string)

ProjectId string

The project id where to assign the secret (string)

NamespaceId string

The namespace id where to assign the namespaced secret (string)

name string

The name of the secret (string)

projectId string

The project id where to assign the secret (string)

namespaceId string

The namespace id where to assign the namespaced secret (string)

name str

The name of the secret (string)

project_id str

The project id where to assign the secret (string)

namespace_id str

The namespace id where to assign the namespaced secret (string)

getSecret Result

The following output properties are available:

Annotations Dictionary<string, object>

(Computed) Annotations for secret object (map)

Data Dictionary<string, object>

(Computed) Secret key/value data. Base64 encoding required for values (map)

Description string

(Computed) A secret description (string)

Id string

The provider-assigned unique ID for this managed resource.

Labels Dictionary<string, object>

(Computed) Labels for secret object (map)

Name string
ProjectId string
NamespaceId string
Annotations map[string]interface{}

(Computed) Annotations for secret object (map)

Data map[string]interface{}

(Computed) Secret key/value data. Base64 encoding required for values (map)

Description string

(Computed) A secret description (string)

Id string

The provider-assigned unique ID for this managed resource.

Labels map[string]interface{}

(Computed) Labels for secret object (map)

Name string
ProjectId string
NamespaceId string
annotations {[key: string]: any}

(Computed) Annotations for secret object (map)

data {[key: string]: any}

(Computed) Secret key/value data. Base64 encoding required for values (map)

description string

(Computed) A secret description (string)

id string

The provider-assigned unique ID for this managed resource.

labels {[key: string]: any}

(Computed) Labels for secret object (map)

name string
projectId string
namespaceId string
annotations Mapping[str, Any]

(Computed) Annotations for secret object (map)

data Mapping[str, Any]

(Computed) Secret key/value data. Base64 encoding required for values (map)

description str

(Computed) A secret description (string)

id str

The provider-assigned unique ID for this managed resource.

labels Mapping[str, Any]

(Computed) Labels for secret object (map)

name str
project_id str
namespace_id str

Package Details

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