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

rancher2.getNamespace

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 namespace.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getNamespace({
        name: "foo",
        projectId: rancher2_cluster["foo-custom"].default_project_id,
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_namespace(name="foo",
        project_id=rancher2_cluster["foo-custom"]["default_project_id"])
    
    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.LookupNamespace(ctx, &rancher2.LookupNamespaceArgs{
    			Name:      "foo",
    			ProjectId: rancher2_cluster.FooCustom.Default_project_id,
    		}, 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 foo = Rancher2.GetNamespace.Invoke(new()
        {
            Name = "foo",
            ProjectId = rancher2_cluster.Foo_custom.Default_project_id,
        });
    
    });
    
    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.GetNamespaceArgs;
    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 foo = Rancher2Functions.getNamespace(GetNamespaceArgs.builder()
                .name("foo")
                .projectId(rancher2_cluster.foo-custom().default_project_id())
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getNamespace
          Arguments:
            name: foo
            projectId: ${rancher2_cluster"foo-custom"[%!s(MISSING)].default_project_id}
    

    Using getNamespace

    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 getNamespace(args: GetNamespaceArgs, opts?: InvokeOptions): Promise<GetNamespaceResult>
    function getNamespaceOutput(args: GetNamespaceOutputArgs, opts?: InvokeOptions): Output<GetNamespaceResult>
    def get_namespace(name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetNamespaceResult
    def get_namespace_output(name: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetNamespaceResult]
    func LookupNamespace(ctx *Context, args *LookupNamespaceArgs, opts ...InvokeOption) (*LookupNamespaceResult, error)
    func LookupNamespaceOutput(ctx *Context, args *LookupNamespaceOutputArgs, opts ...InvokeOption) LookupNamespaceResultOutput

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

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

    The following arguments are supported:

    Name string
    The name of the namespace (string)
    ProjectId string
    The project id where namespace is assigned (string)
    Name string
    The name of the namespace (string)
    ProjectId string
    The project id where namespace is assigned (string)
    name String
    The name of the namespace (string)
    projectId String
    The project id where namespace is assigned (string)
    name string
    The name of the namespace (string)
    projectId string
    The project id where namespace is assigned (string)
    name str
    The name of the namespace (string)
    project_id str
    The project id where namespace is assigned (string)
    name String
    The name of the namespace (string)
    projectId String
    The project id where namespace is assigned (string)

    getNamespace Result

    The following output properties are available:

    Annotations Dictionary<string, object>
    (Computed) Annotations for Node Pool object (map)
    ContainerResourceLimit GetNamespaceContainerResourceLimit
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    Description string
    (Computed) A namespace description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, object>
    (Computed) Labels for Node Pool object (map)
    Name string
    ProjectId string
    ResourceQuota GetNamespaceResourceQuota
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
    Annotations map[string]interface{}
    (Computed) Annotations for Node Pool object (map)
    ContainerResourceLimit GetNamespaceContainerResourceLimit
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    Description string
    (Computed) A namespace description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]interface{}
    (Computed) Labels for Node Pool object (map)
    Name string
    ProjectId string
    ResourceQuota GetNamespaceResourceQuota
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
    annotations Map<String,Object>
    (Computed) Annotations for Node Pool object (map)
    containerResourceLimit GetNamespaceContainerResourceLimit
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    description String
    (Computed) A namespace description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,Object>
    (Computed) Labels for Node Pool object (map)
    name String
    projectId String
    resourceQuota GetNamespaceResourceQuota
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
    annotations {[key: string]: any}
    (Computed) Annotations for Node Pool object (map)
    containerResourceLimit GetNamespaceContainerResourceLimit
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    description string
    (Computed) A namespace description (string)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: any}
    (Computed) Labels for Node Pool object (map)
    name string
    projectId string
    resourceQuota GetNamespaceResourceQuota
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
    annotations Mapping[str, Any]
    (Computed) Annotations for Node Pool object (map)
    container_resource_limit GetNamespaceContainerResourceLimit
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    description str
    (Computed) A namespace description (string)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, Any]
    (Computed) Labels for Node Pool object (map)
    name str
    project_id str
    resource_quota GetNamespaceResourceQuota
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
    annotations Map<Any>
    (Computed) Annotations for Node Pool object (map)
    containerResourceLimit Property Map
    (Computed) Default containers resource limits on namespace (List maxitem:1)
    description String
    (Computed) A namespace description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<Any>
    (Computed) Labels for Node Pool object (map)
    name String
    projectId String
    resourceQuota Property Map
    (Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

    Supporting Types

    GetNamespaceContainerResourceLimit

    GetNamespaceResourceQuota

    GetNamespaceResourceQuotaLimit

    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