published on Tuesday, Mar 31, 2026 by Pulumi
published on Tuesday, Mar 31, 2026 by Pulumi
Configures the Azure Auth Backend in Vault.
This resource sets the access key and secret key that Vault will use when making API requests on behalf of an Azure Auth Backend. It can also be used to override the URLs Vault uses when making those API requests.
For more information, see the Vault docs.
Important All data provided in the resource configuration will be written in cleartext to state and plan files generated by Terraform, and will appear in the console output when Terraform runs. Protect these artifacts accordingly. See the main provider documentation for more details.
Example Usage
You can setup the Azure auth engine with Workload Identity Federation (WIF) for a secret-less configuration:
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.AuthBackend("example", {
type: "azure",
identityTokenKey: "example-key",
});
const exampleAuthBackendConfig = new vault.azure.AuthBackendConfig("example", {
backend: example.path,
tenantId: "11111111-2222-3333-4444-555555555555",
clientId: "11111111-2222-3333-4444-555555555555",
identityTokenAudience: "<TOKEN_AUDIENCE>",
identityTokenTtl: "<TOKEN_TTL>",
rotationSchedule: "0 * * * SAT",
rotationWindow: 3600,
});
import pulumi
import pulumi_vault as vault
example = vault.AuthBackend("example",
type="azure",
identity_token_key="example-key")
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",
identity_token_audience="<TOKEN_AUDIENCE>",
identity_token_ttl="<TOKEN_TTL>",
rotation_schedule="0 * * * SAT",
rotation_window=3600)
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v7/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"),
IdentityTokenKey: pulumi.String("example-key"),
})
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"),
IdentityTokenAudience: pulumi.String("<TOKEN_AUDIENCE>"),
IdentityTokenTtl: pulumi.Int("<TOKEN_TTL>"),
RotationSchedule: pulumi.String("0 * * * SAT"),
RotationWindow: pulumi.Int(3600),
})
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",
IdentityTokenKey = "example-key",
});
var exampleAuthBackendConfig = new Vault.Azure.AuthBackendConfig("example", new()
{
Backend = example.Path,
TenantId = "11111111-2222-3333-4444-555555555555",
ClientId = "11111111-2222-3333-4444-555555555555",
IdentityTokenAudience = "<TOKEN_AUDIENCE>",
IdentityTokenTtl = "<TOKEN_TTL>",
RotationSchedule = "0 * * * SAT",
RotationWindow = 3600,
});
});
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")
.identityTokenKey("example-key")
.build());
var exampleAuthBackendConfig = new AuthBackendConfig("exampleAuthBackendConfig", AuthBackendConfigArgs.builder()
.backend(example.path())
.tenantId("11111111-2222-3333-4444-555555555555")
.clientId("11111111-2222-3333-4444-555555555555")
.identityTokenAudience("<TOKEN_AUDIENCE>")
.identityTokenTtl("<TOKEN_TTL>")
.rotationSchedule("0 * * * SAT")
.rotationWindow(3600)
.build());
}
}
resources:
example:
type: vault:AuthBackend
properties:
type: azure
identityTokenKey: example-key
exampleAuthBackendConfig:
type: vault:azure:AuthBackendConfig
name: example
properties:
backend: ${example.path}
tenantId: 11111111-2222-3333-4444-555555555555
clientId: 11111111-2222-3333-4444-555555555555
identityTokenAudience: <TOKEN_AUDIENCE>
identityTokenTtl: <TOKEN_TTL>
rotationSchedule: 0 * * * SAT
rotationWindow: 3600
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",
rotationSchedule: "0 * * * SAT",
rotationWindow: 3600,
});
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",
rotation_schedule="0 * * * SAT",
rotation_window=3600)
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v7/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"),
RotationSchedule: pulumi.String("0 * * * SAT"),
RotationWindow: pulumi.Int(3600),
})
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",
RotationSchedule = "0 * * * SAT",
RotationWindow = 3600,
});
});
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")
.rotationSchedule("0 * * * SAT")
.rotationWindow(3600)
.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
rotationSchedule: 0 * * * SAT
rotationWindow: 3600
You can use the write-only fields to prevent the client secret from being stored in Terraform state:
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",
clientSecretWo: azureClientSecret,
clientSecretWoVersion: 1,
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_wo=azure_client_secret,
client_secret_wo_version=1,
resource="https://vault.hashicorp.com")
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v7/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"),
ClientSecretWo: pulumi.Any(azureClientSecret),
ClientSecretWoVersion: pulumi.Int(1),
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",
ClientSecretWo = azureClientSecret,
ClientSecretWoVersion = 1,
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")
.clientSecretWo(azureClientSecret)
.clientSecretWoVersion(1)
.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
clientSecretWo: ${azureClientSecret}
clientSecretWoVersion: 1 # Increment to rotate
resource: https://vault.hashicorp.com
Ephemeral Attributes Reference
The following write-only attributes are supported:
clientSecretWo- (Optional) The client secret for credentials to query the Azure APIs, provided as a write-only field. This value will never be stored in Terraform state. Mutually exclusive withclientSecret. Must be used withclientSecretWoVersion. To rotate the secret, update the value and incrementclientSecretWoVersion.
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,
client_secret_wo_version: Optional[int] = None,
max_retries: Optional[int] = None,
backend: Optional[str] = None,
disable_automated_rotation: Optional[bool] = None,
environment: Optional[str] = None,
identity_token_audience: Optional[str] = None,
identity_token_ttl: Optional[int] = None,
client_secret_wo: Optional[str] = None,
max_retry_delay: Optional[int] = None,
namespace: Optional[str] = None,
client_secret: Optional[str] = None,
retry_delay: Optional[int] = None,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
client_id: 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var authBackendConfigResource = new Vault.Azure.AuthBackendConfig("authBackendConfigResource", new()
{
Resource = "string",
TenantId = "string",
ClientSecretWoVersion = 0,
MaxRetries = 0,
Backend = "string",
DisableAutomatedRotation = false,
Environment = "string",
IdentityTokenAudience = "string",
IdentityTokenTtl = 0,
ClientSecretWo = "string",
MaxRetryDelay = 0,
Namespace = "string",
ClientSecret = "string",
RetryDelay = 0,
RotationPeriod = 0,
RotationSchedule = "string",
RotationWindow = 0,
ClientId = "string",
});
example, err := azure.NewAuthBackendConfig(ctx, "authBackendConfigResource", &azure.AuthBackendConfigArgs{
Resource: pulumi.String("string"),
TenantId: pulumi.String("string"),
ClientSecretWoVersion: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
Backend: pulumi.String("string"),
DisableAutomatedRotation: pulumi.Bool(false),
Environment: pulumi.String("string"),
IdentityTokenAudience: pulumi.String("string"),
IdentityTokenTtl: pulumi.Int(0),
ClientSecretWo: pulumi.String("string"),
MaxRetryDelay: pulumi.Int(0),
Namespace: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RetryDelay: pulumi.Int(0),
RotationPeriod: pulumi.Int(0),
RotationSchedule: pulumi.String("string"),
RotationWindow: pulumi.Int(0),
ClientId: pulumi.String("string"),
})
var authBackendConfigResource = new com.pulumi.vault.azure.AuthBackendConfig("authBackendConfigResource", com.pulumi.vault.azure.AuthBackendConfigArgs.builder()
.resource("string")
.tenantId("string")
.clientSecretWoVersion(0)
.maxRetries(0)
.backend("string")
.disableAutomatedRotation(false)
.environment("string")
.identityTokenAudience("string")
.identityTokenTtl(0)
.clientSecretWo("string")
.maxRetryDelay(0)
.namespace("string")
.clientSecret("string")
.retryDelay(0)
.rotationPeriod(0)
.rotationSchedule("string")
.rotationWindow(0)
.clientId("string")
.build());
auth_backend_config_resource = vault.azure.AuthBackendConfig("authBackendConfigResource",
resource="string",
tenant_id="string",
client_secret_wo_version=0,
max_retries=0,
backend="string",
disable_automated_rotation=False,
environment="string",
identity_token_audience="string",
identity_token_ttl=0,
client_secret_wo="string",
max_retry_delay=0,
namespace="string",
client_secret="string",
retry_delay=0,
rotation_period=0,
rotation_schedule="string",
rotation_window=0,
client_id="string")
const authBackendConfigResource = new vault.azure.AuthBackendConfig("authBackendConfigResource", {
resource: "string",
tenantId: "string",
clientSecretWoVersion: 0,
maxRetries: 0,
backend: "string",
disableAutomatedRotation: false,
environment: "string",
identityTokenAudience: "string",
identityTokenTtl: 0,
clientSecretWo: "string",
maxRetryDelay: 0,
namespace: "string",
clientSecret: "string",
retryDelay: 0,
rotationPeriod: 0,
rotationSchedule: "string",
rotationWindow: 0,
clientId: "string",
});
type: vault:azure:AuthBackendConfig
properties:
backend: string
clientId: string
clientSecret: string
clientSecretWo: string
clientSecretWoVersion: 0
disableAutomatedRotation: false
environment: string
identityTokenAudience: string
identityTokenTtl: 0
maxRetries: 0
maxRetryDelay: 0
namespace: string
resource: string
retryDelay: 0
rotationPeriod: 0
rotationSchedule: string
rotationWindow: 0
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AuthBackendConfig resource accepts the following input properties:
- Resource string
- The configured URL for the application registered in Azure Active Directory.
- Tenant
Id 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. - Client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- Client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - Client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- Client
Secret intWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - Disable
Automated boolRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - Identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- Identity
Token intTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- Max
Retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - Max
Retry intDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - Retry
Delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - Rotation
Period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Resource string
- The configured URL for the application registered in Azure Active Directory.
- Tenant
Id 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. - Client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- Client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - Client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- Client
Secret intWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - Disable
Automated boolRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - Identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- Identity
Token intTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- Max
Retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - Max
Retry intDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - Retry
Delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - Rotation
Period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- resource String
- The configured URL for the application registered in Azure Active Directory.
- tenant
Id 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. - client
Id String - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret String - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret StringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret IntegerWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated BooleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment String
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token StringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token IntegerTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries Integer - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry IntegerDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - retry
Delay Integer - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period Integer - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window Integer - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- resource string
- The configured URL for the application registered in Azure Active Directory.
- tenant
Id 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. - client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret numberWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated booleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token numberTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries number - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry numberDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - retry
Delay number - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period number - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. 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. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client_
secret_ strwo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client_
secret_ intwo_ version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable_
automated_ boolrotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment str
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity_
token_ straudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity_
token_ intttl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max_
retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - max_
retry_ intdelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - retry_
delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation_
period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation_
schedule str - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation_
window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- resource String
- The configured URL for the application registered in Azure Active Directory.
- tenant
Id 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. - client
Id String - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret String - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret StringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret NumberWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated BooleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment String
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token StringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token NumberTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries Number - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry NumberDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise. - retry
Delay Number - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period Number - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window Number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. 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,
client_secret_wo: Optional[str] = None,
client_secret_wo_version: Optional[int] = None,
disable_automated_rotation: Optional[bool] = None,
environment: Optional[str] = None,
identity_token_audience: Optional[str] = None,
identity_token_ttl: Optional[int] = None,
max_retries: Optional[int] = None,
max_retry_delay: Optional[int] = None,
namespace: Optional[str] = None,
resource: Optional[str] = None,
retry_delay: Optional[int] = None,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
tenant_id: Optional[str] = None) -> AuthBackendConfigfunc 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)resources: _: type: vault:azure:AuthBackendConfig get: id: ${id}- 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.
- Backend string
- The path the Azure auth backend being configured was
mounted at. Defaults to
azure. - Client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- Client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - Client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- Client
Secret intWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - Disable
Automated boolRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - Identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- Identity
Token intTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- Max
Retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - Max
Retry intDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- Retry
Delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - Rotation
Period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - Tenant
Id 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. - Client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- Client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - Client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- Client
Secret intWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - Disable
Automated boolRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - Identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- Identity
Token intTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- Max
Retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - Max
Retry intDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- Retry
Delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - Rotation
Period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - Tenant
Id 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. - client
Id String - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret String - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret StringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret IntegerWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated BooleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment String
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token StringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token IntegerTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries Integer - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry IntegerDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- retry
Delay Integer - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period Integer - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window Integer - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - tenant
Id 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. - client
Id string - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret string - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret stringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret numberWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated booleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment string
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token stringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token numberTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries number - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry numberDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- retry
Delay number - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period number - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - tenant
Id 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. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client_
secret_ strwo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client_
secret_ intwo_ version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable_
automated_ boolrotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment str
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity_
token_ straudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity_
token_ intttl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max_
retries int - Maximum number of retries for Azure API requests.
Defaults to
3. - max_
retry_ intdelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- retry_
delay int - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation_
period int - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation_
schedule str - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation_
window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - 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. - client
Id String - The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
- client
Secret String - The client secret for credentials to query the
Azure APIs. Mutually exclusive with
clientSecretWo. Note: This field will be stored in Terraform state. Consider usingclientSecretWoinstead for enhanced security. - client
Secret StringWo - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The client secret for credentials to query the Azure APIs. This field is write-only and will never be stored in state. Mutually exclusive with 'client_secret'. Requires 'client_secret_wo_version' to trigger updates.
- client
Secret NumberWo Version - Version counter for the write-only client secret.
Increment this value to trigger an update of the client secret in Vault.
Required when using
clientSecretWo. - disable
Automated BooleanRotation - Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- environment String
- The Azure cloud environment. Valid values:
AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud,
AzureGermanCloud. Defaults to
AzurePublicCloud. - identity
Token StringAudience - The audience claim value for plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise
- identity
Token NumberTtl - The TTL of generated identity tokens in seconds. Defaults to 1 hour. Uses duration format strings. Requires Vault 1.17+. Available only for Vault Enterprise
- max
Retries Number - Maximum number of retries for Azure API requests.
Defaults to
3. - max
Retry NumberDelay - The maximum delay in seconds between retries for Azure API requests.
Defaults to
60. - namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
namespaceis 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.
- retry
Delay Number - The initial delay in seconds between retries for Azure API requests.
Defaults to
4. - rotation
Period Number - The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise
- rotation
Window Number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise - tenant
Id 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
vaultTerraform Provider.
published on Tuesday, Mar 31, 2026 by Pulumi
