HashiCorp Vault
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 a 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,
environment: 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:
- Subscription
Id string - The subscription id for the Azure Active Directory.
- Tenant
Id string - The tenant id for the Azure Active Directory.
- Client
Id string - The OAuth2 client id to connect to Azure.
- Client
Secret string - The OAuth2 client secret to connect to Azure.
- Description string
Human-friendly description of the mount for the backend.
- Environment string
- The Azure environment.
- Path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- Use
Microsoft boolGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- Subscription
Id string - The subscription id for the Azure Active Directory.
- Tenant
Id string - The tenant id for the Azure Active Directory.
- Client
Id string - The OAuth2 client id to connect to Azure.
- Client
Secret string - The OAuth2 client secret to connect to Azure.
- Description string
Human-friendly description of the mount for the backend.
- Environment string
- The Azure environment.
- Path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- Use
Microsoft boolGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- subscription
Id String - The subscription id for the Azure Active Directory.
- tenant
Id String - The tenant id for the Azure Active Directory.
- client
Id String - The OAuth2 client id to connect to Azure.
- client
Secret String - The OAuth2 client secret to connect to Azure.
- description String
Human-friendly description of the mount for the backend.
- environment String
- The Azure environment.
- path String
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- use
Microsoft BooleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- subscription
Id string - The subscription id for the Azure Active Directory.
- tenant
Id string - The tenant id for the Azure Active Directory.
- client
Id string - The OAuth2 client id to connect to Azure.
- client
Secret string - The OAuth2 client secret to connect to Azure.
- description string
Human-friendly description of the mount for the backend.
- environment string
- The Azure environment.
- path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- use
Microsoft booleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- 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.
- environment str
- The Azure environment.
- path str
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- use_
microsoft_ boolgraph_ api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- subscription
Id String - The subscription id for the Azure Active Directory.
- tenant
Id String - The tenant id for the Azure Active Directory.
- client
Id String - The OAuth2 client id to connect to Azure.
- client
Secret String - The OAuth2 client secret to connect to Azure.
- description String
Human-friendly description of the mount for the backend.
- environment String
- The Azure environment.
- path String
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- use
Microsoft BooleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
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 an 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,
environment: 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.
- Client
Id string - The OAuth2 client id to connect to Azure.
- Client
Secret string - The OAuth2 client secret to connect to Azure.
- Description string
Human-friendly description of the mount for the backend.
- Environment string
- The Azure environment.
- Path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- Subscription
Id string - The subscription id for the Azure Active Directory.
- Tenant
Id string - The tenant id for the Azure Active Directory.
- Use
Microsoft boolGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- Client
Id string - The OAuth2 client id to connect to Azure.
- Client
Secret string - The OAuth2 client secret to connect to Azure.
- Description string
Human-friendly description of the mount for the backend.
- Environment string
- The Azure environment.
- Path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- Subscription
Id string - The subscription id for the Azure Active Directory.
- Tenant
Id string - The tenant id for the Azure Active Directory.
- Use
Microsoft boolGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- client
Id String - The OAuth2 client id to connect to Azure.
- client
Secret String - The OAuth2 client secret to connect to Azure.
- description String
Human-friendly description of the mount for the backend.
- environment String
- The Azure environment.
- path String
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- subscription
Id String - The subscription id for the Azure Active Directory.
- tenant
Id String - The tenant id for the Azure Active Directory.
- use
Microsoft BooleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- client
Id string - The OAuth2 client id to connect to Azure.
- client
Secret string - The OAuth2 client secret to connect to Azure.
- description string
Human-friendly description of the mount for the backend.
- environment string
- The Azure environment.
- path string
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- subscription
Id string - The subscription id for the Azure Active Directory.
- tenant
Id string - The tenant id for the Azure Active Directory.
- use
Microsoft booleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- 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.
- environment str
- The Azure environment.
- path str
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- subscription_
id str - The subscription id for the Azure Active Directory.
- tenant_
id str - The tenant id for the Azure Active Directory.
- use_
microsoft_ boolgraph_ api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
- client
Id String - The OAuth2 client id to connect to Azure.
- client
Secret String - The OAuth2 client secret to connect to Azure.
- description String
Human-friendly description of the mount for the backend.
- environment String
- The Azure environment.
- path String
- The unique path this backend should be mounted at. Defaults to
azure
.
- The unique path this backend should be mounted at. Defaults to
- subscription
Id String - The subscription id for the Azure Active Directory.
- tenant
Id String - The tenant id for the Azure Active Directory.
- use
Microsoft BooleanGraph Api - Use the Microsoft Graph API introduced in
vault-1.9
. Should be set to true forvault-1.10+
- Use the Microsoft Graph API introduced in
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.