1. Pulumi Registry
  2. HashiCorp Vault
  3. API Docs
  4. azure
  5. Backend
vault logo
HashiCorp Vault v5.10.0, Mar 21 23

vault.azure.Backend

Example Usage

Vault-1.9 And Above

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var azure = new Vault.Azure.Backend("azure", new()
    {
        ClientId = "11111111-2222-3333-4444-333333333333",
        ClientSecret = "12345678901234567890",
        Environment = "AzurePublicCloud",
        SubscriptionId = "11111111-2222-3333-4444-111111111111",
        TenantId = "11111111-2222-3333-4444-222222222222",
        UseMicrosoftGraphApi = true,
    });

});

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/azure"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azure.NewBackend(ctx, "azure", &azure.BackendArgs{
			ClientId:             pulumi.String("11111111-2222-3333-4444-333333333333"),
			ClientSecret:         pulumi.String("12345678901234567890"),
			Environment:          pulumi.String("AzurePublicCloud"),
			SubscriptionId:       pulumi.String("11111111-2222-3333-4444-111111111111"),
			TenantId:             pulumi.String("11111111-2222-3333-4444-222222222222"),
			UseMicrosoftGraphApi: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.azure.Backend;
import com.pulumi.vault.azure.BackendArgs;
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 azure = new Backend("azure", BackendArgs.builder()        
            .clientId("11111111-2222-3333-4444-333333333333")
            .clientSecret("12345678901234567890")
            .environment("AzurePublicCloud")
            .subscriptionId("11111111-2222-3333-4444-111111111111")
            .tenantId("11111111-2222-3333-4444-222222222222")
            .useMicrosoftGraphApi(true)
            .build());

    }
}

import pulumi
import pulumi_vault as vault

azure = vault.azure.Backend("azure",
    client_id="11111111-2222-3333-4444-333333333333",
    client_secret="12345678901234567890",
    environment="AzurePublicCloud",
    subscription_id="11111111-2222-3333-4444-111111111111",
    tenant_id="11111111-2222-3333-4444-222222222222",
    use_microsoft_graph_api=True)

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const azure = new vault.azure.Backend("azure", {
    clientId: "11111111-2222-3333-4444-333333333333",
    clientSecret: "12345678901234567890",
    environment: "AzurePublicCloud",
    subscriptionId: "11111111-2222-3333-4444-111111111111",
    tenantId: "11111111-2222-3333-4444-222222222222",
    useMicrosoftGraphApi: true,
});

resources:
  azure:
    type: vault:azure:Backend
    properties:
      clientId: 11111111-2222-3333-4444-333333333333
      clientSecret: 12345678901234567890
      environment: AzurePublicCloud
      subscriptionId: 11111111-2222-3333-4444-111111111111
      tenantId: 11111111-2222-3333-4444-222222222222
      useMicrosoftGraphApi: true

Vault-1.8 And Below

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var azure = new Vault.Azure.Backend("azure", new()
    {
        ClientId = "11111111-2222-3333-4444-333333333333",
        ClientSecret = "12345678901234567890",
        Environment = "AzurePublicCloud",
        SubscriptionId = "11111111-2222-3333-4444-111111111111",
        TenantId = "11111111-2222-3333-4444-222222222222",
        UseMicrosoftGraphApi = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/azure"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azure.NewBackend(ctx, "azure", &azure.BackendArgs{
			ClientId:             pulumi.String("11111111-2222-3333-4444-333333333333"),
			ClientSecret:         pulumi.String("12345678901234567890"),
			Environment:          pulumi.String("AzurePublicCloud"),
			SubscriptionId:       pulumi.String("11111111-2222-3333-4444-111111111111"),
			TenantId:             pulumi.String("11111111-2222-3333-4444-222222222222"),
			UseMicrosoftGraphApi: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.azure.Backend;
import com.pulumi.vault.azure.BackendArgs;
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 azure = new Backend("azure", BackendArgs.builder()        
            .clientId("11111111-2222-3333-4444-333333333333")
            .clientSecret("12345678901234567890")
            .environment("AzurePublicCloud")
            .subscriptionId("11111111-2222-3333-4444-111111111111")
            .tenantId("11111111-2222-3333-4444-222222222222")
            .useMicrosoftGraphApi(false)
            .build());

    }
}

import pulumi
import pulumi_vault as vault

azure = vault.azure.Backend("azure",
    client_id="11111111-2222-3333-4444-333333333333",
    client_secret="12345678901234567890",
    environment="AzurePublicCloud",
    subscription_id="11111111-2222-3333-4444-111111111111",
    tenant_id="11111111-2222-3333-4444-222222222222",
    use_microsoft_graph_api=False)

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const azure = new vault.azure.Backend("azure", {
    clientId: "11111111-2222-3333-4444-333333333333",
    clientSecret: "12345678901234567890",
    environment: "AzurePublicCloud",
    subscriptionId: "11111111-2222-3333-4444-111111111111",
    tenantId: "11111111-2222-3333-4444-222222222222",
    useMicrosoftGraphApi: false,
});

resources:
  azure:
    type: vault:azure:Backend
    properties:
      clientId: 11111111-2222-3333-4444-333333333333
      clientSecret: 12345678901234567890
      environment: AzurePublicCloud
      subscriptionId: 11111111-2222-3333-4444-111111111111
      tenantId: 11111111-2222-3333-4444-222222222222
      useMicrosoftGraphApi: false

Create Backend Resource

new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
@overload
def Backend(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            description: Optional[str] = None,
            disable_remount: Optional[bool] = None,
            environment: Optional[str] = None,
            namespace: Optional[str] = None,
            path: Optional[str] = None,
            subscription_id: Optional[str] = None,
            tenant_id: Optional[str] = None,
            use_microsoft_graph_api: Optional[bool] = None)
@overload
def Backend(resource_name: str,
            args: BackendArgs,
            opts: Optional[ResourceOptions] = None)
func NewBackend(ctx *Context, name string, args BackendArgs, opts ...ResourceOption) (*Backend, error)
public Backend(string name, BackendArgs args, CustomResourceOptions? opts = null)
public Backend(String name, BackendArgs args)
public Backend(String name, BackendArgs args, CustomResourceOptions options)

type: vault:azure:Backend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackendArgs
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 BackendArgs
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 BackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BackendArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Backend 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 Backend resource accepts the following input properties:

SubscriptionId string
  • The subscription id for the Azure Active Directory.
TenantId string
  • The tenant id for the Azure Active Directory.
ClientId string
  • The OAuth2 client id to connect to Azure.
ClientSecret string
  • The OAuth2 client secret to connect to Azure.
Description string

Human-friendly description of the mount for the backend.

DisableRemount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

Environment string
  • The Azure environment.
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.

Path string
  • The unique path this backend should be mounted at. Defaults to azure.
UseMicrosoftGraphApi bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
SubscriptionId string
  • The subscription id for the Azure Active Directory.
TenantId string
  • The tenant id for the Azure Active Directory.
ClientId string
  • The OAuth2 client id to connect to Azure.
ClientSecret string
  • The OAuth2 client secret to connect to Azure.
Description string

Human-friendly description of the mount for the backend.

DisableRemount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

Environment string
  • The Azure environment.
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.

Path string
  • The unique path this backend should be mounted at. Defaults to azure.
UseMicrosoftGraphApi bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
subscriptionId String
  • The subscription id for the Azure Active Directory.
tenantId String
  • The tenant id for the Azure Active Directory.
clientId String
  • The OAuth2 client id to connect to Azure.
clientSecret String
  • The OAuth2 client secret to connect to Azure.
description String

Human-friendly description of the mount for the backend.

disableRemount Boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment String
  • The Azure environment.
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.

path String
  • The unique path this backend should be mounted at. Defaults to azure.
useMicrosoftGraphApi Boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
subscriptionId string
  • The subscription id for the Azure Active Directory.
tenantId string
  • The tenant id for the Azure Active Directory.
clientId string
  • The OAuth2 client id to connect to Azure.
clientSecret string
  • The OAuth2 client secret to connect to Azure.
description string

Human-friendly description of the mount for the backend.

disableRemount boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment string
  • The Azure environment.
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.

path string
  • The unique path this backend should be mounted at. Defaults to azure.
useMicrosoftGraphApi boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
subscription_id str
  • The subscription id for the Azure Active Directory.
tenant_id str
  • The tenant id for the Azure Active Directory.
client_id str
  • The OAuth2 client id to connect to Azure.
client_secret str
  • The OAuth2 client secret to connect to Azure.
description str

Human-friendly description of the mount for the backend.

disable_remount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment str
  • The Azure environment.
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.

path str
  • The unique path this backend should be mounted at. Defaults to azure.
use_microsoft_graph_api bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
subscriptionId String
  • The subscription id for the Azure Active Directory.
tenantId String
  • The tenant id for the Azure Active Directory.
clientId String
  • The OAuth2 client id to connect to Azure.
clientSecret String
  • The OAuth2 client secret to connect to Azure.
description String

Human-friendly description of the mount for the backend.

disableRemount Boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment String
  • The Azure environment.
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.

path String
  • The unique path this backend should be mounted at. Defaults to azure.
useMicrosoftGraphApi Boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs

Outputs

All input properties are implicitly available as output properties. Additionally, the Backend 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 Backend Resource

Get an existing Backend 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?: BackendState, opts?: CustomResourceOptions): Backend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        description: Optional[str] = None,
        disable_remount: Optional[bool] = None,
        environment: Optional[str] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None,
        subscription_id: Optional[str] = None,
        tenant_id: Optional[str] = None,
        use_microsoft_graph_api: Optional[bool] = None) -> Backend
func GetBackend(ctx *Context, name string, id IDInput, state *BackendState, opts ...ResourceOption) (*Backend, error)
public static Backend Get(string name, Input<string> id, BackendState? state, CustomResourceOptions? opts = null)
public static Backend get(String name, Output<String> id, BackendState 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:
ClientId string
  • The OAuth2 client id to connect to Azure.
ClientSecret string
  • The OAuth2 client secret to connect to Azure.
Description string

Human-friendly description of the mount for the backend.

DisableRemount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

Environment string
  • The Azure environment.
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.

Path string
  • The unique path this backend should be mounted at. Defaults to azure.
SubscriptionId string
  • The subscription id for the Azure Active Directory.
TenantId string
  • The tenant id for the Azure Active Directory.
UseMicrosoftGraphApi bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
ClientId string
  • The OAuth2 client id to connect to Azure.
ClientSecret string
  • The OAuth2 client secret to connect to Azure.
Description string

Human-friendly description of the mount for the backend.

DisableRemount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

Environment string
  • The Azure environment.
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.

Path string
  • The unique path this backend should be mounted at. Defaults to azure.
SubscriptionId string
  • The subscription id for the Azure Active Directory.
TenantId string
  • The tenant id for the Azure Active Directory.
UseMicrosoftGraphApi bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
clientId String
  • The OAuth2 client id to connect to Azure.
clientSecret String
  • The OAuth2 client secret to connect to Azure.
description String

Human-friendly description of the mount for the backend.

disableRemount Boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment String
  • The Azure environment.
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.

path String
  • The unique path this backend should be mounted at. Defaults to azure.
subscriptionId String
  • The subscription id for the Azure Active Directory.
tenantId String
  • The tenant id for the Azure Active Directory.
useMicrosoftGraphApi Boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
clientId string
  • The OAuth2 client id to connect to Azure.
clientSecret string
  • The OAuth2 client secret to connect to Azure.
description string

Human-friendly description of the mount for the backend.

disableRemount boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment string
  • The Azure environment.
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.

path string
  • The unique path this backend should be mounted at. Defaults to azure.
subscriptionId string
  • The subscription id for the Azure Active Directory.
tenantId string
  • The tenant id for the Azure Active Directory.
useMicrosoftGraphApi boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
client_id str
  • The OAuth2 client id to connect to Azure.
client_secret str
  • The OAuth2 client secret to connect to Azure.
description str

Human-friendly description of the mount for the backend.

disable_remount bool

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment str
  • The Azure environment.
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.

path str
  • The unique path this backend should be mounted at. Defaults to azure.
subscription_id str
  • The subscription id for the Azure Active Directory.
tenant_id str
  • The tenant id for the Azure Active Directory.
use_microsoft_graph_api bool
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs
clientId String
  • The OAuth2 client id to connect to Azure.
clientSecret String
  • The OAuth2 client secret to connect to Azure.
description String

Human-friendly description of the mount for the backend.

disableRemount Boolean

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

environment String
  • The Azure environment.
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.

path String
  • The unique path this backend should be mounted at. Defaults to azure.
subscriptionId String
  • The subscription id for the Azure Active Directory.
tenantId String
  • The tenant id for the Azure Active Directory.
useMicrosoftGraphApi Boolean
  • Indicates whether the secrets engine should use the Microsoft Graph API. This parameter has been deprecated and will be ignored in vault-1.12+. For more information, please refer to the Vault docs

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes

This Pulumi package is based on the vault Terraform Provider.