1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. azure
  5. AuthBackendConfig
HashiCorp Vault v6.1.1 published on Wednesday, Jun 5, 2024 by Pulumi

vault.azure.AuthBackendConfig

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.1.1 published on Wednesday, Jun 5, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const example = new vault.AuthBackend("example", {type: "azure"});
    const exampleAuthBackendConfig = new vault.azure.AuthBackendConfig("example", {
        backend: example.path,
        tenantId: "11111111-2222-3333-4444-555555555555",
        clientId: "11111111-2222-3333-4444-555555555555",
        clientSecret: "01234567890123456789",
        resource: "https://vault.hashicorp.com",
    });
    
    import pulumi
    import pulumi_vault as vault
    
    example = vault.AuthBackend("example", type="azure")
    example_auth_backend_config = vault.azure.AuthBackendConfig("example",
        backend=example.path,
        tenant_id="11111111-2222-3333-4444-555555555555",
        client_id="11111111-2222-3333-4444-555555555555",
        client_secret="01234567890123456789",
        resource="https://vault.hashicorp.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/azure"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := vault.NewAuthBackend(ctx, "example", &vault.AuthBackendArgs{
    			Type: pulumi.String("azure"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azure.NewAuthBackendConfig(ctx, "example", &azure.AuthBackendConfigArgs{
    			Backend:      example.Path,
    			TenantId:     pulumi.String("11111111-2222-3333-4444-555555555555"),
    			ClientId:     pulumi.String("11111111-2222-3333-4444-555555555555"),
    			ClientSecret: pulumi.String("01234567890123456789"),
    			Resource:     pulumi.String("https://vault.hashicorp.com"),
    		})
    		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 = new Vault.AuthBackend("example", new()
        {
            Type = "azure",
        });
    
        var exampleAuthBackendConfig = new Vault.Azure.AuthBackendConfig("example", new()
        {
            Backend = example.Path,
            TenantId = "11111111-2222-3333-4444-555555555555",
            ClientId = "11111111-2222-3333-4444-555555555555",
            ClientSecret = "01234567890123456789",
            Resource = "https://vault.hashicorp.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.AuthBackend;
    import com.pulumi.vault.AuthBackendArgs;
    import com.pulumi.vault.azure.AuthBackendConfig;
    import com.pulumi.vault.azure.AuthBackendConfigArgs;
    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) {
            var example = new AuthBackend("example", AuthBackendArgs.builder()
                .type("azure")
                .build());
    
            var exampleAuthBackendConfig = new AuthBackendConfig("exampleAuthBackendConfig", AuthBackendConfigArgs.builder()
                .backend(example.path())
                .tenantId("11111111-2222-3333-4444-555555555555")
                .clientId("11111111-2222-3333-4444-555555555555")
                .clientSecret("01234567890123456789")
                .resource("https://vault.hashicorp.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vault:AuthBackend
        properties:
          type: azure
      exampleAuthBackendConfig:
        type: vault:azure:AuthBackendConfig
        name: example
        properties:
          backend: ${example.path}
          tenantId: 11111111-2222-3333-4444-555555555555
          clientId: 11111111-2222-3333-4444-555555555555
          clientSecret: '01234567890123456789'
          resource: https://vault.hashicorp.com
    

    Create AuthBackendConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthBackendConfig(name: string, args: AuthBackendConfigArgs, opts?: CustomResourceOptions);
    @overload
    def AuthBackendConfig(resource_name: str,
                          args: AuthBackendConfigArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthBackendConfig(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource: Optional[str] = None,
                          tenant_id: Optional[str] = None,
                          backend: Optional[str] = None,
                          client_id: Optional[str] = None,
                          client_secret: Optional[str] = None,
                          environment: Optional[str] = None,
                          namespace: Optional[str] = None)
    func NewAuthBackendConfig(ctx *Context, name string, args AuthBackendConfigArgs, opts ...ResourceOption) (*AuthBackendConfig, error)
    public AuthBackendConfig(string name, AuthBackendConfigArgs args, CustomResourceOptions? opts = null)
    public AuthBackendConfig(String name, AuthBackendConfigArgs args)
    public AuthBackendConfig(String name, AuthBackendConfigArgs args, CustomResourceOptions options)
    
    type: vault:azure:AuthBackendConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AuthBackendConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthBackendConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthBackendConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthBackendConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthBackendConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var authBackendConfigResource = new Vault.Azure.AuthBackendConfig("authBackendConfigResource", new()
    {
        Resource = "string",
        TenantId = "string",
        Backend = "string",
        ClientId = "string",
        ClientSecret = "string",
        Environment = "string",
        Namespace = "string",
    });
    
    example, err := azure.NewAuthBackendConfig(ctx, "authBackendConfigResource", &azure.AuthBackendConfigArgs{
    	Resource:     pulumi.String("string"),
    	TenantId:     pulumi.String("string"),
    	Backend:      pulumi.String("string"),
    	ClientId:     pulumi.String("string"),
    	ClientSecret: pulumi.String("string"),
    	Environment:  pulumi.String("string"),
    	Namespace:    pulumi.String("string"),
    })
    
    var authBackendConfigResource = new AuthBackendConfig("authBackendConfigResource", AuthBackendConfigArgs.builder()
        .resource("string")
        .tenantId("string")
        .backend("string")
        .clientId("string")
        .clientSecret("string")
        .environment("string")
        .namespace("string")
        .build());
    
    auth_backend_config_resource = vault.azure.AuthBackendConfig("authBackendConfigResource",
        resource="string",
        tenant_id="string",
        backend="string",
        client_id="string",
        client_secret="string",
        environment="string",
        namespace="string")
    
    const authBackendConfigResource = new vault.azure.AuthBackendConfig("authBackendConfigResource", {
        resource: "string",
        tenantId: "string",
        backend: "string",
        clientId: "string",
        clientSecret: "string",
        environment: "string",
        namespace: "string",
    });
    
    type: vault:azure:AuthBackendConfig
    properties:
        backend: string
        clientId: string
        clientSecret: string
        environment: string
        namespace: string
        resource: string
        tenantId: string
    

    AuthBackendConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AuthBackendConfig resource accepts the following input properties:

    Resource string
    The configured URL for the application registered in Azure Active Directory.
    TenantId string
    The tenant id for the Azure Active Directory organization.
    Backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    ClientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    ClientSecret string
    The client secret for credentials to query the Azure APIs.
    Environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    Namespace string
    The namespace to provision the resource in. 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.
    Resource string
    The configured URL for the application registered in Azure Active Directory.
    TenantId string
    The tenant id for the Azure Active Directory organization.
    Backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    ClientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    ClientSecret string
    The client secret for credentials to query the Azure APIs.
    Environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    Namespace string
    The namespace to provision the resource in. 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.
    resource String
    The configured URL for the application registered in Azure Active Directory.
    tenantId String
    The tenant id for the Azure Active Directory organization.
    backend String
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId String
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret String
    The client secret for credentials to query the Azure APIs.
    environment String
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace String
    The namespace to provision the resource in. 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.
    resource string
    The configured URL for the application registered in Azure Active Directory.
    tenantId string
    The tenant id for the Azure Active Directory organization.
    backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret string
    The client secret for credentials to query the Azure APIs.
    environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace string
    The namespace to provision the resource in. 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.
    resource str
    The configured URL for the application registered in Azure Active Directory.
    tenant_id str
    The tenant id for the Azure Active Directory organization.
    backend str
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    client_id str
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    client_secret str
    The client secret for credentials to query the Azure APIs.
    environment str
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace str
    The namespace to provision the resource in. 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.
    resource String
    The configured URL for the application registered in Azure Active Directory.
    tenantId String
    The tenant id for the Azure Active Directory organization.
    backend String
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId String
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret String
    The client secret for credentials to query the Azure APIs.
    environment String
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace String
    The namespace to provision the resource in. 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthBackendConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthBackendConfig Resource

    Get an existing AuthBackendConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthBackendConfigState, opts?: CustomResourceOptions): AuthBackendConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backend: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            environment: Optional[str] = None,
            namespace: Optional[str] = None,
            resource: Optional[str] = None,
            tenant_id: Optional[str] = None) -> AuthBackendConfig
    func GetAuthBackendConfig(ctx *Context, name string, id IDInput, state *AuthBackendConfigState, opts ...ResourceOption) (*AuthBackendConfig, error)
    public static AuthBackendConfig Get(string name, Input<string> id, AuthBackendConfigState? state, CustomResourceOptions? opts = null)
    public static AuthBackendConfig get(String name, Output<String> id, AuthBackendConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    ClientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    ClientSecret string
    The client secret for credentials to query the Azure APIs.
    Environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    Namespace string
    The namespace to provision the resource in. 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.
    Resource string
    The configured URL for the application registered in Azure Active Directory.
    TenantId string
    The tenant id for the Azure Active Directory organization.
    Backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    ClientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    ClientSecret string
    The client secret for credentials to query the Azure APIs.
    Environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    Namespace string
    The namespace to provision the resource in. 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.
    Resource string
    The configured URL for the application registered in Azure Active Directory.
    TenantId string
    The tenant id for the Azure Active Directory organization.
    backend String
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId String
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret String
    The client secret for credentials to query the Azure APIs.
    environment String
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace String
    The namespace to provision the resource in. 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.
    resource String
    The configured URL for the application registered in Azure Active Directory.
    tenantId String
    The tenant id for the Azure Active Directory organization.
    backend string
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId string
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret string
    The client secret for credentials to query the Azure APIs.
    environment string
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace string
    The namespace to provision the resource in. 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.
    resource string
    The configured URL for the application registered in Azure Active Directory.
    tenantId string
    The tenant id for the Azure Active Directory organization.
    backend str
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    client_id str
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    client_secret str
    The client secret for credentials to query the Azure APIs.
    environment str
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace str
    The namespace to provision the resource in. 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.
    resource str
    The configured URL for the application registered in Azure Active Directory.
    tenant_id str
    The tenant id for the Azure Active Directory organization.
    backend String
    The path the Azure auth backend being configured was mounted at. Defaults to azure.
    clientId String
    The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
    clientSecret String
    The client secret for credentials to query the Azure APIs.
    environment String
    The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud. Defaults to AzurePublicCloud.
    namespace String
    The namespace to provision the resource in. 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.
    resource String
    The configured URL for the application registered in Azure Active Directory.
    tenantId String
    The tenant id for the Azure Active Directory organization.

    Import

    Azure auth backends can be imported using auth/, the backend path, and /config e.g.

    $ pulumi import vault:azure/authBackendConfig:AuthBackendConfig example auth/azure/config
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.1.1 published on Wednesday, Jun 5, 2024 by Pulumi