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

rancher2.getRegistry

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 docker registry.

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

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getRegistry({
        name: "<name>",
        projectId: "<project_id>",
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_registry(name="<name>",
        project_id="<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.LookupRegistry(ctx, &rancher2.LookupRegistryArgs{
    			Name:      "<name>",
    			ProjectId: "<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.GetRegistry.Invoke(new()
        {
            Name = "<name>",
            ProjectId = "<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.GetRegistryArgs;
    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.getRegistry(GetRegistryArgs.builder()
                .name("<name>")
                .projectId("<project_id>")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getRegistry
          Arguments:
            name: <name>
            projectId: <project_id>
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getRegistry({
        name: "<name>",
        namespaceId: "<namespace_id>",
        projectId: "<project_id>",
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_registry(name="<name>",
        namespace_id="<namespace_id>",
        project_id="<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.LookupRegistry(ctx, &rancher2.LookupRegistryArgs{
    			Name:        "<name>",
    			NamespaceId: pulumi.StringRef("<namespace_id>"),
    			ProjectId:   "<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.GetRegistry.Invoke(new()
        {
            Name = "<name>",
            NamespaceId = "<namespace_id>",
            ProjectId = "<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.GetRegistryArgs;
    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.getRegistry(GetRegistryArgs.builder()
                .name("<name>")
                .namespaceId("<namespace_id>")
                .projectId("<project_id>")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getRegistry
          Arguments:
            name: <name>
            namespaceId: <namespace_id>
            projectId: <project_id>
    

    Using getRegistry

    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 getRegistry(args: GetRegistryArgs, opts?: InvokeOptions): Promise<GetRegistryResult>
    function getRegistryOutput(args: GetRegistryOutputArgs, opts?: InvokeOptions): Output<GetRegistryResult>
    def get_registry(name: Optional[str] = None,
                     namespace_id: Optional[str] = None,
                     project_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRegistryResult
    def get_registry_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[GetRegistryResult]
    func LookupRegistry(ctx *Context, args *LookupRegistryArgs, opts ...InvokeOption) (*LookupRegistryResult, error)
    func LookupRegistryOutput(ctx *Context, args *LookupRegistryOutputArgs, opts ...InvokeOption) LookupRegistryResultOutput

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

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

    The following arguments are supported:

    Name string
    The name of the registry (string)
    ProjectId string
    The project id where to assign the registry (string)
    NamespaceId string
    The namespace id where to assign the namespaced registry (string)
    Name string
    The name of the registry (string)
    ProjectId string
    The project id where to assign the registry (string)
    NamespaceId string
    The namespace id where to assign the namespaced registry (string)
    name String
    The name of the registry (string)
    projectId String
    The project id where to assign the registry (string)
    namespaceId String
    The namespace id where to assign the namespaced registry (string)
    name string
    The name of the registry (string)
    projectId string
    The project id where to assign the registry (string)
    namespaceId string
    The namespace id where to assign the namespaced registry (string)
    name str
    The name of the registry (string)
    project_id str
    The project id where to assign the registry (string)
    namespace_id str
    The namespace id where to assign the namespaced registry (string)
    name String
    The name of the registry (string)
    projectId String
    The project id where to assign the registry (string)
    namespaceId String
    The namespace id where to assign the namespaced registry (string)

    getRegistry Result

    The following output properties are available:

    Annotations Dictionary<string, object>
    (Computed) Annotations for Registry object (map)
    Description string
    (Computed) A registry description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, object>
    (Computed) Labels for Registry object (map)
    Name string
    ProjectId string
    Registries List<GetRegistryRegistry>
    (Computed) Registries data for registry (list)
    NamespaceId string
    Annotations map[string]interface{}
    (Computed) Annotations for Registry object (map)
    Description string
    (Computed) A registry description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]interface{}
    (Computed) Labels for Registry object (map)
    Name string
    ProjectId string
    Registries []GetRegistryRegistry
    (Computed) Registries data for registry (list)
    NamespaceId string
    annotations Map<String,Object>
    (Computed) Annotations for Registry object (map)
    description String
    (Computed) A registry description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,Object>
    (Computed) Labels for Registry object (map)
    name String
    projectId String
    registries List<GetRegistryRegistry>
    (Computed) Registries data for registry (list)
    namespaceId String
    annotations {[key: string]: any}
    (Computed) Annotations for Registry object (map)
    description string
    (Computed) A registry description (string)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: any}
    (Computed) Labels for Registry object (map)
    name string
    projectId string
    registries GetRegistryRegistry[]
    (Computed) Registries data for registry (list)
    namespaceId string
    annotations Mapping[str, Any]
    (Computed) Annotations for Registry object (map)
    description str
    (Computed) A registry description (string)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, Any]
    (Computed) Labels for Registry object (map)
    name str
    project_id str
    registries Sequence[GetRegistryRegistry]
    (Computed) Registries data for registry (list)
    namespace_id str
    annotations Map<Any>
    (Computed) Annotations for Registry object (map)
    description String
    (Computed) A registry description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<Any>
    (Computed) Labels for Registry object (map)
    name String
    projectId String
    registries List<Property Map>
    (Computed) Registries data for registry (list)
    namespaceId String

    Supporting Types

    GetRegistryRegistry

    Address string
    Password string
    Username string
    Address string
    Password string
    Username string
    address String
    password String
    username String
    address string
    password string
    username string
    address String
    password String
    username String

    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