1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. getAuthBackends
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi

vault.getAuthBackends

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const example = vault.getAuthBackends({});
    
    import pulumi
    import pulumi_vault as vault
    
    example = vault.get_auth_backends()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vault.GetAuthBackends(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vault = Pulumi.Vault;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Vault.GetAuthBackends.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.VaultFunctions;
    import com.pulumi.vault.inputs.GetAuthBackendsArgs;
    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 example = VaultFunctions.getAuthBackends();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: vault:getAuthBackends
          Arguments: {}
    
    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const example-filter = vault.getAuthBackends({
        type: "kubernetes",
    });
    
    import pulumi
    import pulumi_vault as vault
    
    example_filter = vault.get_auth_backends(type="kubernetes")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vault.GetAuthBackends(ctx, &vault.GetAuthBackendsArgs{
    			Type: pulumi.StringRef("kubernetes"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vault = Pulumi.Vault;
    
    return await Deployment.RunAsync(() => 
    {
        var example_filter = Vault.GetAuthBackends.Invoke(new()
        {
            Type = "kubernetes",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.VaultFunctions;
    import com.pulumi.vault.inputs.GetAuthBackendsArgs;
    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 example-filter = VaultFunctions.getAuthBackends(GetAuthBackendsArgs.builder()
                .type("kubernetes")
                .build());
    
        }
    }
    
    variables:
      example-filter:
        fn::invoke:
          Function: vault:getAuthBackends
          Arguments:
            type: kubernetes
    

    Using getAuthBackends

    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 getAuthBackends(args: GetAuthBackendsArgs, opts?: InvokeOptions): Promise<GetAuthBackendsResult>
    function getAuthBackendsOutput(args: GetAuthBackendsOutputArgs, opts?: InvokeOptions): Output<GetAuthBackendsResult>
    def get_auth_backends(namespace: Optional[str] = None,
                          type: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAuthBackendsResult
    def get_auth_backends_output(namespace: Optional[pulumi.Input[str]] = None,
                          type: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAuthBackendsResult]
    func GetAuthBackends(ctx *Context, args *GetAuthBackendsArgs, opts ...InvokeOption) (*GetAuthBackendsResult, error)
    func GetAuthBackendsOutput(ctx *Context, args *GetAuthBackendsOutputArgs, opts ...InvokeOption) GetAuthBackendsResultOutput

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

    public static class GetAuthBackends 
    {
        public static Task<GetAuthBackendsResult> InvokeAsync(GetAuthBackendsArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthBackendsResult> Invoke(GetAuthBackendsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthBackendsResult> getAuthBackends(GetAuthBackendsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: vault:index/getAuthBackends:getAuthBackends
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Namespace string
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    Type string
    The name of the auth method type. Allows filtering of backends returned by type.
    Namespace string
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    Type string
    The name of the auth method type. Allows filtering of backends returned by type.
    namespace String
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    type String
    The name of the auth method type. Allows filtering of backends returned by type.
    namespace string
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    type string
    The name of the auth method type. Allows filtering of backends returned by type.
    namespace str
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    type str
    The name of the auth method type. Allows filtering of backends returned by type.
    namespace String
    The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    type String
    The name of the auth method type. Allows filtering of backends returned by type.

    getAuthBackends Result

    The following output properties are available:

    Accessors List<string>
    The accessor IDs for the auth methods.
    Id string
    The provider-assigned unique ID for this managed resource.
    Paths List<string>
    List of auth backend mount points.
    Namespace string
    Type string
    Accessors []string
    The accessor IDs for the auth methods.
    Id string
    The provider-assigned unique ID for this managed resource.
    Paths []string
    List of auth backend mount points.
    Namespace string
    Type string
    accessors List<String>
    The accessor IDs for the auth methods.
    id String
    The provider-assigned unique ID for this managed resource.
    paths List<String>
    List of auth backend mount points.
    namespace String
    type String
    accessors string[]
    The accessor IDs for the auth methods.
    id string
    The provider-assigned unique ID for this managed resource.
    paths string[]
    List of auth backend mount points.
    namespace string
    type string
    accessors Sequence[str]
    The accessor IDs for the auth methods.
    id str
    The provider-assigned unique ID for this managed resource.
    paths Sequence[str]
    List of auth backend mount points.
    namespace str
    type str
    accessors List<String>
    The accessor IDs for the auth methods.
    id String
    The provider-assigned unique ID for this managed resource.
    paths List<String>
    List of auth backend mount points.
    namespace String
    type String

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi